phoenix_title wx.propgrid.PGCheckBoxEditor


class_hierarchy Class Hierarchy

Inheritance diagram for class PGCheckBoxEditor:

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


property_summary Properties Summary

Name

See GetName


api Class API

class wx.propgrid.PGCheckBoxEditor(PGEditor)

Possible constructors:

PGCheckBoxEditor()

Methods

__init__(self)


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

Instantiates editor controls.

Parameters:
Return type:

wx.propgrid.PGWindowList

Note



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

Draws value for given property.

Parameters:


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



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:
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:
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).



SetControlIntValue(self, property, ctrl, value)

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

Parameters:


SetValueToUnspecified(self, property, ctrl)

Sets value in control to unspecified.

Parameters:


UpdateControl(self, property, ctrl)

Loads value from property to the control.

Parameters:

Properties

Name

See GetName