wxPropertyGrid
Public Member Functions | List of all members
wxPGChoiceEditor Class Reference
Inheritance diagram for wxPGChoiceEditor:
wxPGEditor wxPGChoiceAndButtonEditor wxPGComboBoxEditor

Public Member Functions

virtual bool CanContainCustomImage () const
 Returns true if control itself can contain the custom image. More...
 
virtual wxPGWindowList CreateControls (wxPropertyGrid *propgrid, wxPGProperty *property, const wxPoint &pos, const wxSize &sz) const
 Instantiates editor controls. More...
 
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. More...
 
virtual bool GetValueFromControl (wxVariant &variant, wxPGProperty *property, wxWindow *ctrl) const
 Returns value from control, via parameter 'variant'. More...
 
virtual int InsertItem (wxWindow *ctrl, const wxString &label, int index) const
 Inserts item to existing control. More...
 
virtual bool OnEvent (wxPropertyGrid *propgrid, wxPGProperty *property, wxWindow *primary, wxEvent &event) const
 Handles events. More...
 
virtual void SetControlIntValue (wxPGProperty *property, wxWindow *ctrl, int value) const
 Sets control's value specifically from int (applies to choice etc.). More...
 
virtual void SetControlStringValue (wxPGProperty *property, wxWindow *ctrl, const wxString &txt) const
 Sets control's value specifically from string. More...
 
virtual void SetValueToUnspecified (wxPGProperty *property, wxWindow *ctrl) const
 Sets value in control to unspecified. More...
 
virtual void UpdateControl (wxPGProperty *property, wxWindow *ctrl) const
 Loads value from property to the control. More...
 
- Public Member Functions inherited from wxPGEditor
bool ActualGetValueFromControl (wxVariant &variant, wxPGProperty *property, wxWindow *ctrl) const
 
virtual void DrawValue (wxDC &dc, const wxRect &rect, wxPGProperty *property, const wxString &text) const
 Used to get the renderer to draw the value with when the control is hidden. More...
 
virtual wxPG_CONST_WXCHAR_PTR GetName () const =0
 Returns pointer to the name of the editor. More...
 
virtual void OnFocus (wxPGProperty *property, wxWindow *wnd) const
 Extra processing when control gains focus. More...
 
 wxPGEditor ()
 Constructor. More...
 
virtual ~wxPGEditor ()
 Destructor. More...
 

Member Function Documentation

◆ CanContainCustomImage()

virtual bool wxPGChoiceEditor::CanContainCustomImage ( ) const
virtual

Returns true if control itself can contain the custom image.

Default is to return false.

Reimplemented from wxPGEditor.

◆ CreateControls()

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 wxPGChoiceAndButtonEditor, and wxPGComboBoxEditor.

◆ DeleteItem()

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

Deletes item from existing control.

Default implementation does nothing.

Reimplemented from wxPGEditor.

◆ GetValueFromControl()

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.

◆ InsertItem()

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.

◆ OnEvent()

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.

◆ SetControlIntValue()

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.

◆ SetControlStringValue()

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

Sets control's value specifically from string.

Reimplemented from wxPGEditor.

◆ SetValueToUnspecified()

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

Sets value in control to unspecified.

Implements wxPGEditor.

◆ UpdateControl()

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: