ControlEntry Class Reference

Contains the information for a particular control. The data members are: MonoOn wxWindow* Window - the handle of the control. OpDescriptor *pOpDesc - pointer to the OpDescriptor associated with this control. WNDPROC WndProc - pointer to the normal WndProc for the subclassed control. MonoOff. More...

#include <ctrlhelp.h>

List of all members.

Public Member Functions

BOOL ControlStatusLineText (String_256 *text)
 return the status-line text for a given ControlEntry object

Public Attributes

wxWindow * Window
wxWindow * Parent
OpDescriptorpOpDesc
UINT32 BubbleID
UINT32 StatusID
UINT32 ModuleID
BOOL AddCommitHandling


Detailed Description

Contains the information for a particular control. The data members are: MonoOn wxWindow* Window - the handle of the control. OpDescriptor *pOpDesc - pointer to the OpDescriptor associated with this control. WNDPROC WndProc - pointer to the normal WndProc for the subclassed control. MonoOff.

Author:
Tim_Browse (Xara Group Ltd) <camelotdev@xara.com>
Date:
26/04/94
See also:
ControlTable; ControlHelper

Definition at line 317 of file ctrlhelp.h.


Member Function Documentation

BOOL ControlEntry::ControlStatusLineText String_256 ptext  ) 
 

return the status-line text for a given ControlEntry object

Author:
Ed_Cornes (Xara Group Ltd) <camelotdev@xara.com>
Date:
20/11/94
Returns:
TRUE if a valid string was written to the text buffer

Definition at line 445 of file ctrlhelp.cpp.

00446 {
00447     // if valid OpDesc, load status-line text from OpDescriptor
00448     if (pOpDesc != NULL)
00449         return pOpDesc->GetText(ptext,OP_DESC_TEXT);
00450 
00451     // If there's no status-line string associated with the control then make the
00452     // string blank.
00453     if (StatusID == 0)
00454     {
00455         TRACEUSER( "JustinF", _T("ControlEntry at 0x%lX has zero status-line string ID\n"),
00456                                 (UINT32) this);
00457         ptext->Empty();
00458         return TRUE;
00459     }
00460 
00461     // else just load using string ID provided directly by caller.
00462     return ptext->Load(StatusID,ModuleID);
00463 }


Member Data Documentation

BOOL ControlEntry::AddCommitHandling
 

Definition at line 334 of file ctrlhelp.h.

UINT32 ControlEntry::BubbleID
 

Definition at line 325 of file ctrlhelp.h.

UINT32 ControlEntry::ModuleID
 

Definition at line 327 of file ctrlhelp.h.

wxWindow* ControlEntry::Parent
 

Definition at line 322 of file ctrlhelp.h.

OpDescriptor* ControlEntry::pOpDesc
 

Definition at line 324 of file ctrlhelp.h.

UINT32 ControlEntry::StatusID
 

Definition at line 326 of file ctrlhelp.h.

wxWindow* ControlEntry::Window
 

Definition at line 320 of file ctrlhelp.h.


The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:53:08 2007 for Camelot by  doxygen 1.4.4