CAddressBook Class Reference

CAddressBook. More...

#include <AddressBook.h>

Inheritance diagram for CAddressBook:

List of all members.

Public Member Functions
	CAddressBook ()
	CAddressBook.
virtual	~CAddressBook (void)
	~CAddressBook
GAMEINFO *	operator[] (int32 index)
	operator[] Used for indexing into the address book
int32	GameListSize ()
	GameListSize Returns the number of entries in the game list.
Protected Member Functions
void	Run ()
	Run The main task loop for the address book.
virtual bool	OnInit ()
	OnInit This handler function is called before the execution of the threads main loop.
virtual bool	OnBackgroundProc ()
	OnBackgroundProc This function is called by the framework when the player's message queue is empty.
void	EnableBackgroundProcessing (bool bProcessing)
	EnableBackgroundProcessing.
Protected Attributes
bool	m_bBkProcessing
	This boolean switch enables or disables background processing That is, when equal to false, the OnBackgroundProc function will never be called.

---

Detailed Description

CAddressBook.

Description:

Limitations:

---

Constructor & Destructor Documentation

CAddressBook::CAddressBook (   )

CAddressBook. Description: This function initalizes the class's internal data members Limitations:

CAddressBook::~CAddressBook (  void   )  [virtual]

~CAddressBook Description: Limitations: None

---

Member Function Documentation

void CAddressBook::EnableBackgroundProcessing (  bool  bProcessing  )  [protected]

EnableBackgroundProcessing. Description: This function sets the background processing mode of the player object. Parameters: bProcessing-  The new processing state. When true, back- ground processing will be performed. When false, the processing will be skipped. Returns: void Limitations: None

int32 CAddressBook::GameListSize (   )

GameListSize Returns the number of entries in the game list. Description: Returns the size of the list Returns: int32: The list size Limitations: None

bool CAddressBook::OnBackgroundProc (   )  [protected, virtual]

OnBackgroundProc This function is called by the framework when the player's message queue is empty. Return true if more processing time is needed.

bool CAddressBook::OnInit (   )  [protected, virtual]

OnInit This handler function is called before the execution of the threads main loop. If the return of this function is false, the main loop will not be executed.

CAddressBook::GAMEINFO * CAddressBook::operator[] (  int32  index  )

operator[] Used for indexing into the address book Description: Returns a pointer to a GAMEINFO struct as indexed by index Parameters: index  is the Index into the address book Returns: A pointer to a GAMEINFO struct or a NULL pointer if the index is not valid Limitations: None

void CAddressBook::Run (  void   )  [protected, virtual]

Run The main task loop for the address book. Description: This function processes the address book's task's loop. Returns: void Limitations: None Implements CGenericTask.

---

The documentation for this class was generated from the following files:

• Client/AddressBook.h
• Client/AddressBook.cpp

---

Copyright (c) 2005 Matt Bruns, Pat Hammond, Kevin Markussen, Travis Service, Brain Shaver