wx.propgrid.PGTextCtrlEditor

Class Hierarchy

Inheritance diagram for class PGTextCtrlEditor:

Known Subclasses

wx.propgrid.PGSpinCtrlEditor, wx.propgrid.PGTextCtrlAndButtonEditor

Methods Summary

__init__
CreateControls	Instantiates editor controls.
GetName	Returns pointer to the name of the editor.
GetTextCtrlValueFromControl
GetValueFromControl	Returns value from control, via parameter variant.
OnEvent	Handles events.
OnFocus	Extra processing when control gains focus.
OnTextCtrlEvent
SetControlStringValue	Sets control’s value specifically from string.
UpdateControl	Loads value from property to the control.

Properties Summary

Name	See GetName

Class API

class wx.propgrid.PGTextCtrlEditor(PGEditor)

Possible constructors:

PGTextCtrlEditor()

Methods

__init__(self)

---

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

• It is not necessary to call wx.EvtHandler.Bind for interesting editor events. All events from controls are automatically forwarded to wx.propgrid.PGEditor.OnEvent and wx.propgrid.PGProperty.OnEvent .

---

GetName(self)

Returns pointer to the name of the editor.

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

Return type

string

---

static GetTextCtrlValueFromControl(variant, property, ctrl)

Parameters

• variant (PGVariant) –

• property (wx.propgrid.PGProperty) –

• ctrl (wx.Window) –

Return type

bool

---

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

---

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 (i.e. behaviour is same for any wx.TextCtrl and wx.ComboBox based editor).

---

OnFocus(self, property, wnd)

Extra processing when control gains focus.

For example, wx.TextCtrl based controls should select all text.

Parameters

• property (wx.propgrid.PGProperty) –

• wnd (wx.Window) –

---

static OnTextCtrlEvent(propgrid, property, ctrl, event)

Parameters

• propgrid (wx.propgrid.PropertyGrid) –

• property (wx.propgrid.PGProperty) –

• ctrl (wx.Window) –

• event (wx.Event) –

Return type

bool

---

SetControlStringValue(self, property, ctrl, txt)

Sets control’s value specifically from string.

Parameters

• property (wx.propgrid.PGProperty) –

• ctrl (wx.Window) –

• txt (string) –

---

UpdateControl(self, property, ctrl)

Loads value from property to the control.

Parameters

• property (wx.propgrid.PGProperty) –

• ctrl (wx.Window) –

Properties

Name

See GetName