Abstract base class for all objects in wxCryst. More...
Public Member Functions | |
| WXCrystObjBasic (wxWindow *parent) | |
| Constructor. | |
| virtual | ~WXCrystObjBasic () |
| Destructor. | |
| virtual void | CrystUpdate (const bool updateUI=false, const bool mutexlock=false)=0 |
| Get new values to be displayed from the underlying object, and raise flag if an UI update is necessary. | |
| virtual void | UpdateUI (const bool mutexlock=false)=0 |
| Update the User Interface, if necessary. | |
| virtual void | BottomLayout (WXCrystObjBasic *pChild) |
| Ask for a new Layout with recalculated size hints, because a child has been changed or added. | |
| virtual void | AddChild (WXCrystObjBasic *pChild, bool doBottomLayout=true) |
| Notify that a new children has been added, also adding it to the correct sizer (which can be the top sizer or not). | |
| void | AddedToList (WXCrystObjBasicList *list) |
| void | RemovedFromList (WXCrystObjBasicList *list) |
| virtual bool | Layout () |
| virtual void | SetToolTip (const wxString &tip) |
| Set tooltip for this window. | |
Protected Attributes | |
| WXCrystObjBasic * | mWXCrystParent |
| Parent, if a WXCrystObjBasic itself. | |
| bool | mIsShown |
| Is the the window currently shown ? | |
| bool | mNeedUpdateUI |
| Do we need to update the display ? | |
| CrystMutex | mMutex |
| Mutex used to lock data when preparing to update the UI in non-main thread. | |
| std::set< WXCrystObjBasicList * > | mvpList |
| WXCrystObjBasicList which are aware of this object, and which should be told on destruction. | |
Detailed Description
Abstract base class for all objects in wxCryst.
Member Function Documentation
|
virtual |
Notify that a new children has been added, also adding it to the correct sizer (which can be the top sizer or not).
- Parameters:
-
doBottomLayout ask for a new Layout of the window and of its parents.
Reimplemented in ObjCryst::WXCrystObj.
| void ObjCryst::WXCrystObjBasic::AddedToList | ( | WXCrystObjBasicList * | list | ) |
Tell the object it has been added to a list
|
virtual |
Ask for a new Layout with recalculated size hints, because a child has been changed or added.
- Parameters:
-
pChild,: the modified child. If null, this will mean we are asking for a new layout of the window itself (useful when a sub-window is deleted).
Reimplemented in ObjCryst::WXCrystObj.
|
pure virtual |
Get new values to be displayed from the underlying object, and raise flag if an UI update is necessary.
The actual GUI update is not made here. UpdateUI() should be called separately, from the main thread.
- Parameters:
-
updateUI,: if true, this will call UpdateUI, either directly (if in the main thread), or by sending a message. mutexlock,: if true, a Mutex will be used to lock the data shared between main and background thread. The idea is to only use a few Mutexes to lock data from the top objects (wxRefinableObj,...), when calling CrystUpdate() and UpdateUI(). As sub-objects (WXField,...) are only updated from within a top object, the mutex lock in the top object will also lock the data in the sub-objects.
Implemented in ObjCryst::WXCrystMenuBar, ObjCryst::WXFieldChoice, ObjCryst::WXFieldPar< T >, ObjCryst::WXFieldPar< long >, ObjCryst::WXFieldParBase, ObjCryst::WXFieldName, ObjCryst::WXFieldString, ObjCryst::WXCrystObj, ObjCryst::WXTexturePhaseMarchDollase, ObjCryst::WXPowderPatternBackground, ObjCryst::WXMolecule, ObjCryst::WXRefinableObj, ObjCryst::WXFieldOption, ObjCryst::WXMolDihedralAngle, ObjCryst::WXMolBondAngle, ObjCryst::WXCrystal, ObjCryst::WXFieldRefPar, ObjCryst::WXMolBond, ObjCryst::WXMolAtom, ObjCryst::WXOptimizationObj, ObjCryst::WXPowderPattern, ObjCryst::WXDiffractionSingleCrystal, and ObjCryst::WXRadiation.
| void ObjCryst::WXCrystObjBasic::RemovedFromList | ( | WXCrystObjBasicList * | list | ) |
Tell the object it has been removed from a list
|
virtual |
Set tooltip for this window.
The WXCrystObjBasicList::SetToolTip() will just call wxWindow::SetToolTip(), but is virtual and will correctly call specialized derived function. This is needed to avoid settin a tooltip on widgets not receiving motion events (e.g. static text under windows).
Reimplemented in ObjCryst::WXFieldParBase, ObjCryst::WXFieldName, ObjCryst::WXFieldString, ObjCryst::WXFieldOption, and ObjCryst::WXFieldRefPar.
|
pure virtual |
Update the User Interface, if necessary.
- Parameters:
-
mutexlock,: if true, a Mutex will be used to lock the data shared between main and background thread.
The idea is to only use a few Mutexes to lock data from the top objects (wxRefinableObj,...), when calling CrystUpdate() and UpdateUI(). As sub-objects (WXField,...) are only updated from within a top object, the mutex lock in the top object will also lock the data in the sub-objects.
Implemented in ObjCryst::WXCrystMenuBar, ObjCryst::WXFieldChoice, ObjCryst::WXFieldPar< T >, ObjCryst::WXFieldPar< long >, ObjCryst::WXFieldName, ObjCryst::WXFieldString, ObjCryst::WXCrystObj, ObjCryst::WXPowderPatternDiffraction, ObjCryst::WXTexturePhaseMarchDollase, ObjCryst::WXPowderPatternBackground, ObjCryst::WXMolecule, ObjCryst::WXRefinableObj, ObjCryst::WXFieldOption, ObjCryst::WXCrystal, ObjCryst::WXMolDihedralAngle, ObjCryst::WXMolBondAngle, ObjCryst::WXFieldRefPar, ObjCryst::WXMolBond, ObjCryst::WXPowderPattern, ObjCryst::WXOptimizationObj, ObjCryst::WXMolAtom, ObjCryst::WXAtom, ObjCryst::WXDiffractionSingleCrystal, ObjCryst::WXRadiation, ObjCryst::WXScatteringPowerAtom, and ObjCryst::WXScatteringPowerSphere.
Member Data Documentation
|
protected |
WXCrystObjBasicList which are aware of this object, and which should be told on destruction.
The documentation for this class was generated from the following file:
- wxCryst.h
