ControlTable Class Reference

Stores/manipulates an array of ControlEntry objects, in order to keep track of all the controls we have currently subclassed. More...

#include <ctrlhelp.h>

Inheritance diagram for ControlTable:

List of all members.

Public Member Functions
	ControlTable ()
	Construct the control table object.
	~ControlTable ()
	Destroy a ControlTable object - frees up all memory used by the table data.
BOOL	Init ()
	Allocate and initialise the table of control entries.
ControlEntry *	FindControl (wxWindow *Window)
	Given a control's window handle, return the information currently registered for that control. Do not free the data pointed to by the return value.
BOOL	ChangeControl (wxWindow *, ControlHelpInfo *)
Private Types
enum	{ NotFound = -1, EmptySlot = 0, Granularity = 30, InitialSize = 100 }
Private Member Functions
INT32	FindControlIndex (wxWindow *Window, BOOL IgnoreChildren=TRUE)
	Given the window handle of a control, return the offset into the table array of its record, or optionally of the control's child windows.
Private Attributes
ControlEntry *	Table
INT32	TableSize
wxWindow *	LastWindow
INT32	LastIndex

---

Detailed Description

Stores/manipulates an array of ControlEntry objects, in order to keep track of all the controls we have currently subclassed.

Author:

Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>

Date:

26/04/94

See also:

ControlEntry; ControlHelper

Definition at line 354 of file ctrlhelp.h.

---

Member Enumeration Documentation

anonymous enum [private]

Enumerator: NotFound  EmptySlot  Granularity  InitialSize  Definition at line 372 of file ctrlhelp.h. { NotFound = -1, EmptySlot = 0, Granularity = 30, InitialSize = 100 };

---

Constructor & Destructor Documentation

ControlTable::ControlTable (   )

Construct the control table object. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 26/04/94 See also: ControlTable::Init Definition at line 477 of file ctrlhelp.cpp. { // No table data yet. Table = NULL; TableSize = 0; // Initial state LastWindow = NULL; LastIndex = 0; }

ControlTable::~ControlTable (   )

Destroy a ControlTable object - frees up all memory used by the table data. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 26/04/94 See also: ControlTable::Init Definition at line 499 of file ctrlhelp.cpp. { // Free up the table data. CCFree(Table); }

---

Member Function Documentation

BOOL ControlTable::ChangeControl (  wxWindow *  , ControlHelpInfo *  )

Definition at line 673 of file ctrlhelp.cpp. { INT32 i = FindControlIndex(Window); if (i == ControlTable::NotFound) return FALSE; Table[i].BubbleID = pInfo->BubbleID; Table[i].StatusID = pInfo->StatusID; Table[i].ModuleID = pInfo->ModuleID; // Everything worked return TRUE; }

ControlEntry * ControlTable::FindControl (  wxWindow *  Window  )

Given a control's window handle, return the information currently registered for that control. Do not free the data pointed to by the return value. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 26/04/94 Parameters: Window  - the handle of the control to look for. [INPUTS] Returns: Pointer to the data currently registered for the control in question, or NULL if the control could not be found. See also: ControlEntry Definition at line 703 of file ctrlhelp.cpp. { INT32 i=FindControlIndex(Window); if (i==ControlTable::NotFound) return NULL; return Table + i; }

INT32 ControlTable::FindControlIndex (  wxWindow *  Window, BOOL  IgnoreChildren = TRUE )  [private]

Given the window handle of a control, return the offset into the table array of its record, or optionally of the control's child windows. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 26/04/94 Parameters: Window  - the handle of the control to search for. [INPUTS] IgnoreChildren - if TRUE, then only return the entry for the control itself; if FALSE then return entries for the control or any children of it. Returns: The index into the Table array of the control's record, or ControlTable::NotFound if the control is not registered in the table. Errors: Not found. See also: ControlTable::FindControl; ControlTable::DeleteControl Definition at line 733 of file ctrlhelp.cpp. { // Scan the table for this entry... INT32 i; // Is this the same as the last window handle we looked for? // If so, start from the last slot we looked at. if (LastWindow == Window) i = LastIndex; else i = 0; while ((i < TableSize) && (Table[i].Window != Window) && (IgnoreChildren || (Table[i].Parent != Window))) i++; // Did we find it? if (i >= TableSize) // No - inform caller of failure. return ControlTable::NotFound; // Yes, success LastIndex = i; LastWindow = Window; return i; }

BOOL ControlTable::Init (  void   )

Allocate and initialise the table of control entries. Author: Tim_Browse (Xara Group Ltd) <camelotdev@xara.com> Date: 26/04/94 Returns: TRUE if successful; FALSE if not. Errors: Out of memory. See also: ControlTable Reimplemented from SimpleCCObject. Definition at line 519 of file ctrlhelp.cpp. { // Try to get some space for our table. Table = (ControlEntry *) CCMalloc(ControlTable::InitialSize * sizeof(ControlEntry)); if (Table == NULL) return FALSE; // Initialise the table for (INT32 i = 0; i < ControlTable::InitialSize; i++) { // No control registered in this entry yet Table[i].Window = EMPTY_SLOT; } // Update the table size TableSize = ControlTable::InitialSize; // Success! return TRUE; }

---

Member Data Documentation

INT32 ControlTable::LastIndex [private]

Definition at line 385 of file ctrlhelp.h.

wxWindow* ControlTable::LastWindow [private]

Definition at line 384 of file ctrlhelp.h.

ControlEntry* ControlTable::Table [private]

Definition at line 380 of file ctrlhelp.h.

INT32 ControlTable::TableSize [private]

Definition at line 381 of file ctrlhelp.h.

---

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

• wxOil/ctrlhelp.h (r1785/r1282)
• wxOil/ctrlhelp.cpp (r1785/r1282)

---