wx.propgrid.PGCheckBoxEditor

Class Hierarchy

Inheritance diagram for class PGCheckBoxEditor:

Methods Summary

__init__
CreateControls	Instantiates editor controls.
DrawValue	Draws value for given property.
GetName	Returns pointer to the name of the editor.
GetValueFromControl	Returns value from control, via parameter ‘variant’.
OnEvent	Handles events.
SetControlIntValue	Sets control’s value specifically from int (applies to choice etc.).
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.PGCheckBoxEditor(PGEditor)

Possible constructors:

PGCheckBoxEditor()

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

• 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 .

---

DrawValue(self, dc, rect, property, text)

Draws value for given property.

Parameters:

• dc (wx.DC) –
• rect (wx.Rect) –
• property (wx.propgrid.PGProperty) –
• text (string) –

---

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

---

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) –

---

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