ObjCryst::WXField Class Referenceabstract
This is the abstract base class for all fields, wether they contain a floating-point parameter, or a string,... More...
Inheritance diagram for ObjCryst::WXField:
Collaboration diagram for ObjCryst::WXField:
Public Member Functions | |
| WXField (wxWindow *parent, const string &label, const int field_id) | |
| Constructor, specifying the label of the field. | |
| void | SetLabel (const string &) |
| Change the field's label. | |
| virtual void | Revert ()=0 |
| After a user entry, this allows to go back to the last value, if for some reason the entry was rejected (because the object is currently busy, ...) | |
| virtual bool | SetForegroundColour (const wxColour &colour) |
| Change the colour of the field's title. More... | |
| virtual void | ValidateUserInput ()=0 |
| This function shall be called when a new value has been entered. | |
| virtual void | SetSize (int width, int height) |
| Change the size of the field (excluding the title) | |
| Public Member Functions inherited from ObjCryst::WXCrystObjBasic | |
| 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. More... | |
| virtual void | UpdateUI (const bool mutexlock=false)=0 |
| Update the User Interface, if necessary. More... | |
| wxDEPRECATED (virtual void BottomLayout(WXCrystObjBasic *pChild)) | |
| Redo the Layout for the object and ask parent to take it into account. More... | |
| 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). More... | |
| void | AddedToList (WXCrystObjBasicList *list) |
| void | RemovedFromList (WXCrystObjBasicList *list) |
| virtual bool | Layout () |
| virtual void | SetToolTip (const wxString &tip) |
| Set tooltip for this window. More... | |
Protected Attributes | |
| wxBoxSizer * | mpSizer |
| The horizontal sizer in which the title, button, fields, are put. | |
| wxStaticText * | mpLabel |
| The label. | |
| const int | mId |
| The Id of this field. | |
| Protected Attributes inherited from ObjCryst::WXCrystObjBasic | |
| 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. More... | |
Detailed Description
This is the abstract base class for all fields, wether they contain a floating-point parameter, or a string,...
All WXField have a title and an entry field.
Note that WXField::CrystUpdate() and WXField::UpdateUI() should be done from the parent object. Notably using WXField::CrystUpdate(updateui=true) will not trigger an update of the UI.
Member Function Documentation
|
virtual |
Change the colour of the field's title.
Can be used (with parcimony) to clarify the interface.
Definition at line 291 of file wxCryst.cpp.
The documentation for this class was generated from the following files:
