ControlList Class Reference

#include <ctrllist.h>

Inheritance diagram for ControlList:

List of all members.

Public Member Functions
	ControlList ()
	Constructor.
virtual	~ControlList ()
	Destructor.
BOOL	NewControl (wxControl *pControl)
	Adds a control to the list managed by us.
BOOL	DeleteControl (wxControl *pControl)
	Removes a control from the list managed by us.
BOOL	AssociateControl (wxControl *pControl, DialogOp *pDialogOp=NULL)
	Associates a control with a dialog and an OpDescriptor (divined automagically).
BOOL	ReflectAllStates (BOOL IgnoreChangedFlag=FALSE)
	Refreshes all controls on the list.
void	Changed ()
void	Invoke (wxControl *pControl, OpParam *pOpParam=NULL, BOOL fWithUndo=TRUE)
	Invokes the Op attached to the OpDescriptor, with the parameters pOpParam & fwithUndo.
OpDescriptor *	Find (wxControl *pControl)
	Searches for the OpDescriptor attached to a control.
BOOL	BuildGadgetList (List *pOutputList, OpDescriptor *pOpDesc)
	Builds a list of GadgetListItems, each item holding a DialogBarOp* and a CGadgetID for a control associated with this OpDescriptor. This allows the caller to manipulate the controls even if there isn't a message from them needing processing. NB. the caller is responsible for allocating and deallocating this list!
BOOL	SendMessageToAllControls (DialogOp *pDialogOp, DialogMsg *DlgMsg, CWindowID pWindow=NULL)
void	RegisterWindowAndChildren (wxWindow *pwxWindow, DialogOp *pDialogOp)
void	RemoveWindowAndChildren (wxWindow *pwxWindow)
Static Public Member Functions
static ControlList *	Get ()
static BOOL	Init ()
	static initalizer
static void	DeInit ()
	static initalizer
static void	Idle ()
Private Member Functions
BOOL	ReflectState (wxControl *pControl, ControlList::ListEntry *pListEntry, BOOL ForceUpdate=FALSE)
	Removes a control from the list managed by us.
Private Attributes
ControlPtrToListEntry *	m_pHash
BOOL	m_ChangedFlag
Static Private Attributes
static ControlList *	m_pControlList = NULL
Classes
class	ListEntry

---

Detailed Description

Definition at line 127 of file ctrllist.h.

---

Constructor & Destructor Documentation

ControlList::ControlList (   )

Constructor. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 130 of file ctrllist.cpp. { m_pHash = new ControlPtrToListEntry; m_ChangedFlag = FALSE; }

ControlList::~ControlList (   )  [virtual]

Destructor. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 151 of file ctrllist.cpp. { if (m_pHash) { delete m_pHash; m_pHash = NULL; } }

---

Member Function Documentation

BOOL ControlList::AssociateControl (  wxControl *  pControl, DialogOp *  pDialogOp = NULL )

Associates a control with a dialog and an OpDescriptor (divined automagically). Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: pControl  - pointer to the control to associate [INPUTS] pDialogOp - pointer to the DialogOp to associate it with -  [OUTPUTS] Returns: TRUE on success Errors: - See also: - Definition at line 281 of file ctrllist.cpp. { ERROR2IF(!pControl, FALSE, "Null control pointer"); ERROR2IF(!m_pHash, FALSE, "No hash table"); ControlPtrToListEntry::iterator i=m_pHash->find(pControl); ERROR2IF((i==m_pHash->end()), FALSE, "Control not present in hash table"); OpDescriptor * pOpDesc = NULL; wxString opDesc; BOOL SpecifiedOpDesc = FALSE; // wxCamArtControl class can have its OpDescriptor specified in the resources. If it's // there, use that if (pControl->IsKindOf(CLASSINFO(wxCamArtControl))) { opDesc = ((wxCamArtControl *)(pControl))->GetOpDesc(); } if (!(opDesc.IsEmpty())) { pOpDesc = OpDescriptor::FindOpDescriptor((TCHAR *)(opDesc.c_str())); SpecifiedOpDesc = TRUE; #if _DEBUG if (!pOpDesc) { // ERROR3_PF(("Cannot find OpDescriptor for %s",opDesc.c_str())); // this goes off too often right now TRACE(_T("ControlList::AssociateControl - Cannot find OpDescriptor for %s"),opDesc.c_str()); } #endif } else { pOpDesc = OpDescriptor::FindOpDescriptor((ResourceID)(pControl->GetId())); } (i->second).m_pOpDesc=pOpDesc; (i->second).m_SpecifiedOpDesc = SpecifiedOpDesc; (i->second).m_pDialogOp = pDialogOp; if (pOpDesc) { // Set the tooltip if any ResourceID ToolTip=pOpDesc->GetBubbleId(); if (ToolTip) pControl->SetToolTip(wxString(CamResource::GetText(ToolTip))); ResourceID Help=pOpDesc->GetHelpId(); if (Help) pControl->SetHelpText(wxString(CamResource::GetText(Help))); } m_ChangedFlag = TRUE; ReflectState(i->first, &i->second, TRUE); return TRUE; }

BOOL ControlList::BuildGadgetList (  List *  pOutputList, OpDescriptor *  pOpDesc )

Builds a list of GadgetListItems, each item holding a DialogBarOp* and a CGadgetID for a control associated with this OpDescriptor. This allows the caller to manipulate the controls even if there isn't a message from them needing processing. NB. the caller is responsible for allocating and deallocating this list! Author: Alex Bligh <alex@alex.org.uk> Date: 5 Mar 2005 Parameters: A  pointer to a list which will hold the gadgets. [INPUTS] A  list of gadgets. [OUTPUTS] Returns: TRUE if there are some gadgets associated with this OpDescriptor, FALSE if there aren't any. Errors: - See also: class GadgetListItem Definition at line 529 of file ctrllist.cpp. { if (Camelot.CamelotIsDying()) return FALSE; ERROR2IF(!pOutputList, FALSE, "Null output list in OpDescriptor::BuildGadgetList"); // Iterate through all controls ERROR2IF(!m_pHash, FALSE, "No hash table"); ControlPtrToListEntry::iterator i; for( i = m_pHash->begin(); i != m_pHash->end(); ++i ) { if (i->second.m_pOpDesc == pOpDesc) { DialogOp * pDialogOp = i->second.m_pDialogOp; if (pDialogOp) { // The control shares our OpDescriptor, and has a dialog so put it on the list GadgetListItem* pgListItem = new GadgetListItem(pDialogOp, i->first->GetId()); if (pgListItem == NULL) { pOutputList->DeleteAll(); return FALSE; } pOutputList->AddHead(pgListItem); } } } // Return TRUE/FALSE depending on if there are any entries on the list. return !pOutputList->IsEmpty(); }

void ControlList::Changed (   )  [inline]

Definition at line 155 of file ctrllist.h. {m_ChangedFlag = TRUE;}

void ControlList::DeInit (  void   )  [static]

static initalizer Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE on success Errors: - See also: - Definition at line 201 of file ctrllist.cpp. { ERROR3IF(!m_pControlList, "ControlList not initialized before DeInit()"); if (m_pControlList) { delete m_pControlList; m_pControlList = NULL; } return; }

BOOL ControlList::DeleteControl (  wxControl *  pControl  )

Removes a control from the list managed by us. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: pControl  - pointer to the control to delete [INPUTS] -  [OUTPUTS] Returns: TRUE on success Errors: - See also: - Definition at line 254 of file ctrllist.cpp. { ERROR2IF(!pControl, FALSE, "Null control pointer"); ERROR2IF(!m_pHash, FALSE, "No hash table"); ControlPtrToListEntry::iterator i=m_pHash->find(pControl); ERROR2IF((i==m_pHash->end()), FALSE, "Control not present in hash table"); m_pHash->erase(i); m_ChangedFlag = TRUE; return TRUE; }

OpDescriptor * ControlList::Find (  wxControl *  pControl  )

Searches for the OpDescriptor attached to a control. Author: Alex_Bligh <alex@alex.org.uk> Date: 04/03/2006 Parameters: pControl  - pointer to the control to look for [INPUTS] -  [OUTPUTS] Returns: NULL if not found, else pointer to the OpDescriptor Errors: - See also: - Definition at line 498 of file ctrllist.cpp. { if (Camelot.CamelotIsDying()) return NULL; ERROR2IF(!m_pHash, NULL, "No hash table"); ControlPtrToListEntry::iterator i=m_pHash->find(pControl); if (i==m_pHash->end()) return NULL; return i->second.m_pOpDesc; }

static ControlList* ControlList::Get (   )  [inline, static]

Definition at line 145 of file ctrllist.h. {return m_pControlList;}

static void ControlList::Idle (   )  [inline, static]

Definition at line 161 of file ctrllist.h. {if (m_pControlList) m_pControlList->ReflectAllStates();}

BOOL ControlList::Init (  void   )  [static]

static initalizer Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE on success Errors: - See also: - Reimplemented from SimpleCCObject. Definition at line 175 of file ctrllist.cpp. { ERROR2IF(m_pControlList, FALSE, "Double init of ControlList"); m_pControlList = new ControlList; ERROR2IF(!m_pControlList, FALSE, "Cannot get a new ControlList"); wxToolTip::SetDelay(750); return TRUE; }

void ControlList::Invoke (  wxControl *  pControl, OpParam *  pOpParam = NULL, BOOL  fWithUndo = TRUE )

Invokes the Op attached to the OpDescriptor, with the parameters pOpParam & fwithUndo. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: pControl  - pointer the control [INPUTS] pOpParam - parameters fwithUndo - invoke with undo -  [OUTPUTS] Returns: - Errors: - See also: - Definition at line 466 of file ctrllist.cpp. { if (Camelot.CamelotIsDying()) return; ERROR2IF(!m_pHash, (void)0, "No hash table"); ControlPtrToListEntry::iterator i=m_pHash->find(pControl); ERROR2IF((i==m_pHash->end()), (void)0, "Control not present in hash table"); ReflectState(i->first, &i->second); OpDescriptor * pOpDesc = i->second.m_pOpDesc; if (pOpDesc && !i->second.m_OpState.Greyed) { pOpDesc->Invoke(pOpParam, fWithUndo); } }

BOOL ControlList::NewControl (  wxControl *  pControl  )

Adds a control to the list managed by us. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: pControl  - pointer to the control to add [INPUTS] -  [OUTPUTS] Returns: TRUE on success Errors: - See also: - Definition at line 227 of file ctrllist.cpp. { ERROR2IF(!pControl, FALSE, "Null control pointer"); ERROR2IF(!m_pHash, FALSE, "No hash table"); ControlPtrToListEntry::iterator i=m_pHash->find(pControl); ERROR2IF((i!=m_pHash->end()), FALSE, "Control already present in hash table"); ControlList::ListEntry l; (*m_pHash)[pControl]=l; m_ChangedFlag = TRUE; return TRUE; }

BOOL ControlList::ReflectAllStates (  BOOL  IgnoreChangedFlag = FALSE  )

Refreshes all controls on the list. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE on success Errors: - See also: - Definition at line 430 of file ctrllist.cpp. { if (Camelot.CamelotIsDying()) return FALSE; if (!m_ChangedFlag && !IgnoreChangedFlag) return TRUE; m_ChangedFlag = FALSE; ERROR2IF(!m_pHash, FALSE, "No hash table"); ControlPtrToListEntry::iterator i; for( i = m_pHash->begin(); i != m_pHash->end(); ++i ) { ReflectState(i->first, &i->second); } return TRUE; }

BOOL ControlList::ReflectState (  wxControl *  pControl, ControlList::ListEntry *  pListEntry, BOOL  ForceUpdate = FALSE )  [private]

Removes a control from the list managed by us. Author: Alex_Bligh <alex@alex.org.uk> Date: 02/12/2005 Parameters: pControl  - pointer to the control to reflect state to [INPUTS] pListEntry - pointer to list entry with data in ForceUpdate - TRUE to force an update even if old state supposedly the same (e.g. on creation) -  [OUTPUTS] Returns: TRUE on success Errors: - See also: - Definition at line 356 of file ctrllist.cpp. { if (Camelot.CamelotIsDying()) return FALSE; if (pListEntry->m_pOpDesc) { String_256 Dummy; OpState NewState = pListEntry->m_pOpDesc->GetOpsState(&Dummy); if (ForceUpdate || (pListEntry->m_OpState.Greyed != NewState.Greyed) || (pListEntry->m_OpState.Ticked != NewState.Ticked)) { pListEntry->m_OpState = NewState; wxWindow* pFocusWnd = wxWindow::FindFocus(); pControl->Enable(!(pListEntry->m_OpState.Greyed)); // The disabled control had focus, so we must find a sibling control to // take the focus or face losing keypresses. if( pListEntry->m_OpState.Greyed && pFocusWnd == pControl ) { wxWindowList& lstChildren = pControl->GetParent()->GetChildren(); size_t cChild = lstChildren.GetCount(); bool fFound = false; for( size_t ord = 0; ord < cChild; ++ord ) { wxWindow* pSibling = lstChildren.Item( ord )->GetData(); if( pSibling->IsEnabled() ) { pSibling->SetFocus(); fFound = true; break; } } // No enabled siblings, fall-back to selecting the panel if( !fFound ) pControl->GetParent()->SetFocus(); } // Send this to DialogManager so we have a generic implementation DialogManager::SetBoolGadgetSelected(pControl->GetParent(), pControl->GetId(), pListEntry->m_OpState.Ticked); } } else { // Hack to grey only the tool buttons when they have no OpDescriptor attached // if (pControl->GetStyle() & wxCACS_TOOLBACKGROUND) // If there was an OpDescriptor specified in the resource file, but we couldn't find it, we grey // the control. If no OpDescriptor was specified, we don't grey the control because it might be // simply that there is not meant to be one (e.g. infobar controls) if (pListEntry->m_SpecifiedOpDesc) pControl->Enable(FALSE); } return TRUE; }

void ControlList::RegisterWindowAndChildren (  wxWindow *  pwxWindow, DialogOp *  pDialogOp )

Definition at line 632 of file ctrllist.cpp. { ERROR2IF(!m_pHash, (void)0, "No hash table"); if (pWindow) { if (pWindow->IsKindOf(CLASSINFO(wxControl))) { wxControl * pControl = (wxControl *)pWindow; // Remove this one ControlPtrToListEntry::iterator i=m_pHash->find(pControl); if (i==m_pHash->end()) { if (NewControl(pControl)) AssociateControl(pControl, pDialogOp); } } // Iterate through all children wxWindowList::Node * pNode = pWindow->GetChildren().GetFirst(); while (pNode) { RegisterWindowAndChildren(pNode->GetData(), pDialogOp); pNode = pNode->GetNext(); } } return; }

void ControlList::RemoveWindowAndChildren (  wxWindow *  pwxWindow  )

Definition at line 673 of file ctrllist.cpp. { ERROR2IF(!m_pHash, (void)0, "No hash table"); if (pWindow) { if (pWindow->IsKindOf(CLASSINFO(wxControl))) { wxControl * pControl = (wxControl *)pWindow; // Remove this one ControlPtrToListEntry::iterator i=m_pHash->find(pControl); if (i!=m_pHash->end()) DeleteControl(pControl); } // Iterate through all children wxWindowList::Node * pNode = pWindow->GetChildren().GetFirst(); while (pNode) { RemoveWindowAndChildren(pNode->GetData()); pNode = pNode->GetNext(); } } return; }

BOOL ControlList::SendMessageToAllControls (  DialogOp *  pDialogOp, DialogMsg *  DlgMsg, CWindowID  pWindow = NULL )

Definition at line 581 of file ctrllist.cpp. { BOOL Destroy = FALSE; // If at the top of the recursion, look at the appropriate wxWindow if (!pWindow) { pWindow = pDialogOp->GetReadWriteWindowID(); } // Handle this window OpDescriptor * pOpDesc = OpDescriptor::FindOpDescriptor((ResourceID)(pWindow->GetId())); if (pOpDesc) { const BarControlInfo * pBarControlInfo = pOpDesc->GetBarControlInfo(); if (pBarControlInfo) { BarControlInfo bci = *pBarControlInfo; bci.ControlID = pWindow->GetId(); bci.ResourceID = pWindow->GetId(); pOpDesc->SetBarControlInfo(bci); // Pass a flag saying whether we think this has been internally processed Destroy |= pDialogOp->SendMessageToControl(pOpDesc, DlgMsg, pWindow->IsKindOf(CLASSINFO(wxCamArtControl))); } } // Now handle all children wxWindowList::Node * pNode = pWindow->GetChildren().GetFirst(); while (pNode) { Destroy |= SendMessageToAllControls(pDialogOp, DlgMsg, pNode->GetData()); pNode = pNode->GetNext(); } return Destroy; }

---

Member Data Documentation

BOOL ControlList::m_ChangedFlag [private]

Definition at line 172 of file ctrllist.h.

ControlList * ControlList::m_pControlList = NULL [static, private]

Definition at line 169 of file ctrllist.h.

ControlPtrToListEntry* ControlList::m_pHash [private]

Definition at line 171 of file ctrllist.h.

---

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

• wxOil/ctrllist.h (r1785/r1282)
• wxOil/ctrllist.cpp (r1785/r1464)

---