wxPropertyGrid
Public Member Functions
wxPGChoiceEditor Class Reference
Inheritance diagram for wxPGChoiceEditor:
wxPGEditor wxPGChoiceAndButtonEditor wxPGComboBoxEditor

List of all members.

Public Member Functions

virtual bool CanContainCustomImage () const
 Returns true if control itself can contain the custom image.
virtual wxPGWindowList CreateControls (wxPropertyGrid *propgrid, wxPGProperty *property, const wxPoint &pos, const wxSize &sz) const
 Instantiates editor controls.
wxWindow * CreateControlsBase (wxPropertyGrid *propgrid, wxPGProperty *property, const wxPoint &pos, const wxSize &sz, long extraStyle) const
virtual void DeleteItem (wxWindow *ctrl, int index) const
 Deletes item from existing control.
virtual bool GetValueFromControl (wxVariant &variant, wxPGProperty *property, wxWindow *ctrl) const
 Returns value from control, via parameter 'variant'.
virtual int InsertItem (wxWindow *ctrl, const wxString &label, int index) const
 Inserts item to existing control.
virtual bool OnEvent (wxPropertyGrid *propgrid, wxPGProperty *property, wxWindow *primary, wxEvent &event) const
 Handles events.
virtual void SetControlIntValue (wxPGProperty *property, wxWindow *ctrl, int value) const
 Sets control's value specifically from int (applies to choice etc.).
virtual void SetControlStringValue (wxPGProperty *property, wxWindow *ctrl, const wxString &txt) const
 Sets control's value specifically from string.
virtual void SetValueToUnspecified (wxPGProperty *property, wxWindow *ctrl) const
 Sets value in control to unspecified.
virtual void UpdateControl (wxPGProperty *property, wxWindow *ctrl) const
 Loads value from property to the control.

Member Function Documentation

virtual bool wxPGChoiceEditor::CanContainCustomImage ( ) const [virtual]

Returns true if control itself can contain the custom image.

Default is to return false.

Reimplemented from wxPGEditor.

virtual wxPGWindowList wxPGChoiceEditor::CreateControls ( wxPropertyGrid propgrid,
wxPGProperty property,
const wxPoint &  pos,
const wxSize &  size 
) const [virtual]

Instantiates editor controls.

Remarks:
  • Primary control shall use id wxPG_SUBID1, and secondary (button) control shall use wxPG_SUBID2.
Parameters:
propgridwxPropertyGrid to which the property belongs (use as parent for control).
propertyProperty for which this method is called.
posPosition, inside wxPropertyGrid, to create control(s) to.
sizeInitial size for control(s).

Implements wxPGEditor.

Reimplemented in wxPGComboBoxEditor, and wxPGChoiceAndButtonEditor.

virtual void wxPGChoiceEditor::DeleteItem ( wxWindow *  ctrl,
int  index 
) const [virtual]

Deletes item from existing control.

Default implementation does nothing.

Reimplemented from wxPGEditor.

virtual bool wxPGChoiceEditor::GetValueFromControl ( wxVariant &  variant,
wxPGProperty property,
wxWindow *  ctrl 
) const [virtual]

Returns value from control, via parameter 'variant'.

Usually ends up calling property's StringToValue or IntToValue. Returns true if value was different.

Reimplemented from wxPGEditor.

Reimplemented in wxPGComboBoxEditor.

virtual int wxPGChoiceEditor::InsertItem ( wxWindow *  ctrl,
const wxString &  label,
int  index 
) const [virtual]

Inserts item to existing control.

Index -1 means appending. Default implementation does nothing. Returns index of item added.

Reimplemented from wxPGEditor.

virtual bool wxPGChoiceEditor::OnEvent ( wxPropertyGrid propgrid,
wxPGProperty property,
wxWindow *  wnd_primary,
wxEvent &  event 
) const [virtual]

Handles events.

Returns true if value in control was modified (see wxPGProperty::OnEvent for more information).

Implements wxPGEditor.

Reimplemented in wxPGComboBoxEditor.

virtual void wxPGChoiceEditor::SetControlIntValue ( wxPGProperty property,
wxWindow *  ctrl,
int  value 
) const [virtual]

Sets control's value specifically from int (applies to choice etc.).

Reimplemented from wxPGEditor.

virtual void wxPGChoiceEditor::SetControlStringValue ( wxPGProperty property,
wxWindow *  ctrl,
const wxString &  txt 
) const [virtual]

Sets control's value specifically from string.

Reimplemented from wxPGEditor.

virtual void wxPGChoiceEditor::SetValueToUnspecified ( wxPGProperty property,
wxWindow *  ctrl 
) const [virtual]

Sets value in control to unspecified.

Implements wxPGEditor.

virtual void wxPGChoiceEditor::UpdateControl ( wxPGProperty property,
wxWindow *  ctrl 
) const [virtual]

Loads value from property to the control.

Implements wxPGEditor.

Reimplemented in wxPGComboBoxEditor.


The documentation for this class was generated from the following file:
 All Classes Functions Variables Enumerations Enumerator