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