## wxPropertyListValidator

The wxPropertyListValidator abstract class is the base class for deriving validators for property lists.

See also

wxPropertyListValidator overview

Members

wxPropertyListValidator::wxPropertyListValidator
wxPropertyListValidator::~wxPropertyListValidator
wxPropertyListValidator::OnCheckValue
wxPropertyListValidator::OnClearControls
wxPropertyListValidator::OnClearDetailControls
wxPropertyListValidator::OnDisplayValue
wxPropertyListValidator::OnDoubleClick
wxPropertyListValidator::OnEdit
wxPropertyListValidator::OnPrepareControls
wxPropertyListValidator::OnPrepareDetailControls
wxPropertyListValidator::OnRetrieveValue
wxPropertyListValidator::OnSelect
wxPropertyListValidator::OnValueListSelect

### wxPropertyListValidator::wxPropertyListValidator

void wxPropertyListValidator(long flags = wxPROP_ALLOW_TEXT_EDITING)

Constructor.

### wxPropertyListValidator::~wxPropertyListValidator

void ~wxPropertyListValidator()

Destructor.

### wxPropertyListValidator::OnCheckValue

bool OnCheckValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow) Called when the Tick (Confirm) button is pressed or focus is list. Return FALSE if the value was invalid, which is a signal restores the old value. Return TRUE if the value was valid.

### wxPropertyListValidator::OnClearControls

bool OnClearControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow) Allows the clearing (enabling, disabling) of property list controls, when the focus leaves the current property.

### wxPropertyListValidator::OnClearDetailControls

bool OnClearDetailControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow) Called when the focus is lost, if the validator is in detailed editing mode.

### wxPropertyListValidator::OnDisplayValue

bool OnDisplayValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow)

Should display the value in the appropriate controls. The default implementation gets the textual value from the property and inserts it into the text edit control.

### wxPropertyListValidator::OnDoubleClick

bool OnDoubleClick(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow)

Called when the property is double clicked. Extra functionality can be provided, such as cycling through possible values.

### wxPropertyListValidator::OnEdit

bool OnEdit(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow) Called when the Edit (detailed editing) button is pressed. The default implementation calls wxPropertyListView::BeginDetailedEditing; a filename validator (for example) overrides this function to show the file selector.

### wxPropertyListValidator::OnPrepareControls

bool OnPrepareControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow)

Called to allow the validator to setup the display, such enabling or disabling buttons, and setting the values and selection in the standard listbox control (the one optionally used for displaying value options).

### wxPropertyListValidator::OnPrepareDetailControls

bool OnPrepareDetailControls(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow) Called when the property is edited 'in detail', i.e. when the Edit button is pressed.

### wxPropertyListValidator::OnRetrieveValue

bool OnRetrieveValue(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow)

Called when Tick (Confirm) is pressed or focus is lost or view wants to update the property list. Should do the transfer from the property editing area to the property itself

### wxPropertyListValidator::OnSelect

bool OnSelect(bool select, wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow)

Called when the property is selected or deselected: typically displays the value in the edit control (having chosen a suitable control to display: (non)editable text or listbox).

### wxPropertyListValidator::OnValueListSelect

bool OnValueListSelect(wxProperty *property, wxPropertyListView *view, wxWindow *parentWindow)

Called when the value listbox is selected. The default behaviour is to copy string to text control, and retrieve the value into the property.