projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 200fed6c VS |
1 | \section{\class{wxPropertyListValidator}}\label{wxpropertylistvalidator} |
| 2 | ||
| 3 | \overview{wxPropertyListValidator overview}{wxpropertylistvalidatoroverview} | |
| 4 | ||
| 5 | The {\bf wxPropertyListValidator} abstract class is the base class for | |
| 6 | deriving validators for property lists. | |
| 7 | ||
| 8 | \membersection{wxPropertyListValidator::wxPropertyListValidator} | |
| 9 | ||
| 10 | \func{void}{wxPropertyListValidator}{\param{long}{ flags = wxPROP\_ALLOW\_TEXT\_EDITING}} | |
| 11 | ||
| 12 | Constructor. | |
| 13 | ||
| 14 | \membersection{wxPropertyListValidator::\destruct{wxPropertyListValidator}} | |
| 15 | ||
| 16 | \func{void}{\destruct{wxPropertyListValidator}}{\void} | |
| 17 | ||
| 18 | Destructor. | |
| 19 | ||
| 20 | \membersection{wxPropertyListValidator::OnCheckValue} | |
| 21 | ||
| 22 | \func{Bool}{OnCheckValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, | |
| 23 | \param{wxWindow *}{parentWindow}} | |
| 24 | ||
| 25 | Called when the Tick (Confirm) button is pressed or focus is list. Return FALSE if the value | |
| 26 | was invalid, which is a signal restores the old value. Return TRUE if the value was valid. | |
| 27 | ||
| 28 | \membersection{wxPropertyListValidator::OnClearControls} | |
| 29 | ||
| 30 | \func{Bool}{OnClearControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, | |
| 31 | \param{wxWindow *}{parentWindow}} | |
| 32 | ||
| 33 | Allows the clearing (enabling, disabling) of property list controls, when the focus leaves the current property. | |
| 34 | ||
| 35 | \membersection{wxPropertyListValidator::OnClearDetailControls} | |
| 36 | ||
| 37 | \func{Bool}{OnClearDetailControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, | |
| 38 | \param{wxWindow *}{parentWindow}} | |
| 39 | ||
| 40 | Called when the focus is lost, if the validator is in detailed editing mode. | |
| 41 | ||
| 42 | \membersection{wxPropertyListValidator::OnDisplayValue} | |
| 43 | ||
| 44 | \func{Bool}{OnDisplayValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, | |
| 45 | \param{wxWindow *}{parentWindow}} | |
| 46 | ||
| 47 | Should display the value in the appropriate controls. The default implementation gets the | |
| 48 | textual value from the property and inserts it into the text edit control. | |
| 49 | ||
| 50 | \membersection{wxPropertyListValidator::OnDoubleClick} | |
| 51 | ||
| 52 | \func{Bool}{OnDoubleClick}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, | |
| 53 | \param{wxWindow *}{parentWindow}} | |
| 54 | ||
| 55 | Called when the property is double clicked. Extra functionality can be provided, | |
| 56 | such as cycling through possible values. | |
| 57 | ||
| 58 | \membersection{wxPropertyListValidator::OnEdit} | |
| 59 | ||
| 60 | \func{Bool}{OnEdit}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, | |
| 61 | \param{wxWindow *}{parentWindow}} | |
| 62 | ||
| 63 | Called when the Edit (detailed editing) button is pressed. The default implementation | |
| 64 | calls wxPropertyListView::BeginDetailedEditing; a filename validator (for example) overrides | |
| 65 | this function to show the file selector. | |
| 66 | ||
| 67 | \membersection{wxPropertyListValidator::OnPrepareControls} | |
| 68 | ||
| 69 | \func{Bool}{OnPrepareControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, | |
| 70 | \param{wxWindow *}{parentWindow}} | |
| 71 | ||
| 72 | Called to allow the validator to setup the display, such enabling or disabling buttons, and | |
| 73 | setting the values and selection in the standard listbox control (the one optionally used for displaying | |
| 74 | value options). | |
| 75 | ||
| 76 | \membersection{wxPropertyListValidator::OnPrepareDetailControls} | |
| 77 | ||
| 78 | \func{Bool}{OnPrepareDetailControls}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, | |
| 79 | \param{wxWindow *}{parentWindow}} | |
| 80 | ||
| 81 | Called when the property is edited `in detail', i.e. when the Edit button is pressed. | |
| 82 | ||
| 83 | \membersection{wxPropertyListValidator::OnRetrieveValue} | |
| 84 | ||
| 85 | \func{Bool}{OnRetrieveValue}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, | |
| 86 | \param{wxWindow *}{parentWindow}} | |
| 87 | ||
| 88 | Called when Tick (Confirm) is pressed or focus is lost or view wants to update | |
| 89 | the property list. Should do the transfer from the property editing area to the property itself | |
| 90 | ||
| 91 | \membersection{wxPropertyListValidator::OnSelect} | |
| 92 | ||
| 93 | \func{Bool}{OnSelect}{\param{Bool}{ select}, \param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, | |
| 94 | \param{wxWindow *}{parentWindow}} | |
| 95 | ||
| 96 | Called when the property is selected or deselected: typically displays the value | |
| 97 | in the edit control (having chosen a suitable control to display: (non)editable text or listbox). | |
| 98 | ||
| 99 | \membersection{wxPropertyListValidator::OnValueListSelect} | |
| 100 | ||
| 101 | \func{Bool}{OnValueListSelect}{\param{wxProperty *}{property}, \param{wxPropertyListView *}{view}, | |
| 102 | \param{wxWindow *}{parentWindow}} | |
| 103 | ||
| 104 | Called when the value listbox is selected. The default behaviour is to copy | |
| 105 | string to text control, and retrieve the value into the property. | |
| 106 | ||
| 107 | ||
| 108 |