wx.propgrid.PGChoiceEditor

Class Hierarchy

Inheritance diagram for class PGChoiceEditor:

Known Subclasses

wx.propgrid.PGChoiceAndButtonEditor, wx.propgrid.PGComboBoxEditor

Methods Summary

__init__
CanContainCustomImage	Returns True if control itself can contain the custom image.
CreateControls	Instantiates editor controls.
CreateControlsBase
DeleteItem	Deletes item from existing control.
GetName	Returns pointer to the name of the editor.
GetValueFromControl	Returns value from control, via parameter ‘variant’.
InsertItem	Inserts item to existing control.
OnEvent	Handles events.
SetControlIntValue	Sets control’s value specifically from int (applies to choice etc.).
SetControlStringValue	Sets control’s value specifically from string.
SetValueToUnspecified	Sets value in control to unspecified.
UpdateControl	Loads value from property to the control.

Properties Summary

Name	See GetName

Class API

---

class wx.propgrid.PGChoiceEditor(PGEditor)

Possible constructors:

PGChoiceEditor()

Methods

---

__init__(self)

---

CanContainCustomImage(self)

Returns True if control itself can contain the custom image.

Default implementation returns False.

Return type:bool

---

CreateControls(self, propgrid, property, pos, size)

Instantiates editor controls.

Parameters:

• propgrid (wx.propgrid.PropertyGrid) – wx.propgrid.PropertyGrid to which the property belongs (use as parent for control).
• property (wx.propgrid.PGProperty) – Property for which this method is called.
• pos (wx.Point) – Position, inside wx.propgrid.PropertyGrid, to create control(s) to.
• size (wx.Size) – Initial size for control(s).

Return type:

wx.propgrid.PGWindowList

Note

• Primary control shall use id PG_SUBID1, and secondary (button) control shall use PG_SUBID2.
• Unlike in previous version of wx.propgrid.PropertyGrid, it is no longer necessary to call wx.EvtHandler.Connect for interesting editor events. Instead, all events from control are now automatically forwarded to wx.propgrid.PGEditor.OnEvent and wx.propgrid.PGProperty.OnEvent .

---

CreateControlsBase(self, propgrid, property, pos, sz, extraStyle)

Parameters:

• propgrid (wx.propgrid.PropertyGrid) –
• property (wx.propgrid.PGProperty) –
• pos (wx.Point) –
• sz (wx.Size) –
• extraStyle (long) –

Return type:

Window

---

DeleteItem(self, ctrl, index)

Deletes item from existing control.

Default implementation does nothing.

Parameters:

• ctrl (wx.Window) –
• index (int) –

---

GetName(self)

Returns pointer to the name of the editor.

For example, PGEditor_TextCtrl has name “TextCtrl”. If you dont’ need to access your custom editor by string name, then you do not need to implement this function.

Return type:string

---

GetValueFromControl(self, variant, property, ctrl)

Returns value from control, via parameter ‘variant’.

Usually ends up calling property’s StringToValue() or IntToValue(). Returns True if value was different.

Parameters:

• variant (PGVariant) –
• property (wx.propgrid.PGProperty) –
• ctrl (wx.Window) –

Return type:

bool

---

InsertItem(self, ctrl, label, index)

Inserts item to existing control.

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

Parameters:

• ctrl (wx.Window) –
• label (string) –
• index (int) –

Return type:

int

---

OnEvent(self, propgrid, property, wnd_primary, event)

Handles events.

Returns True if value in control was modified (see wx.propgrid.PGProperty.OnEvent for more information).

Parameters:

• propgrid (wx.propgrid.PropertyGrid) –
• property (wx.propgrid.PGProperty) –
• wnd_primary (wx.Window) –
• event (wx.Event) –

Return type:

bool

Note

wx.propgrid.PropertyGrid will automatically unfocus the editor when wxEVT_TEXT_ENTER is received and when it results in property value being modified. This happens regardless of editor type (ie. behaviour is same for any wx.TextCtrl and wx.ComboBox based editor).

---

SetControlIntValue(self, property, ctrl, value)

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

Parameters:

• property (wx.propgrid.PGProperty) –
• ctrl (wx.Window) –
• value (int) –

---

SetControlStringValue(self, property, ctrl, txt)

Sets control’s value specifically from string.

Parameters:

• property (wx.propgrid.PGProperty) –
• ctrl (wx.Window) –
• txt (string) –

---

SetValueToUnspecified(self, property, ctrl)

Sets value in control to unspecified.

Parameters:

• property (wx.propgrid.PGProperty) –
• ctrl (wx.Window) –

---

UpdateControl(self, property, ctrl)

Loads value from property to the control.

Parameters:

• property (wx.propgrid.PGProperty) –
• ctrl (wx.Window) –

Properties

---

Name

See GetName