wx.propgrid.PropertyGrid

wx.propgrid.PropertyGrid is a specialized grid for editing properties - in other words name = value pairs.

List of ready-to-use property classes include strings, numbers, flag sets, fonts, colours and many others. It is possible, for example, to categorize properties, set up a complete tree-hierarchy, add more than two columns, and set arbitrary per-property attributes.

Please note that most member functions are inherited and as such not documented on this page. This means you will probably also want to read wx.propgrid.PropertyGridInterface class reference.

See also PropertyGrid Overview.

Window Styles

See PropertyGrid Window Styles.

Event Handling

To process input from a property grid control, use these event handler macros to direct input to member functions that take a wx.propgrid.PropertyGridEvent argument.

Events Emitted by this Class

Handlers bound for the following event types will receive one of the wx.propgrid.PropertyGridEvent parameters.

• EVT_PG_SELECTED : Respond to wxEVT_PG_SELECTED event, generated when a property selection has been changed, either by user action or by indirect program function. For instance, collapsing a parent property programmatically causes any selected child property to become unselected, and may therefore cause this event to be generated.

• EVT_PG_CHANGED: Respond to wxEVT_PG_CHANGED event, generated when property value has been changed by the user.

• EVT_PG_CHANGING: Respond to wxEVT_PG_CHANGING event, generated when property value is about to be changed by user. Use PropertyGridEvent.GetValue() to take a peek at the pending value, and wx.propgrid.PropertyGridEvent.Veto to prevent change from taking place, if necessary.

• EVT_PG_HIGHLIGHTED: Respond to wxEVT_PG_HIGHLIGHTED event, which occurs when mouse moves over a property. Event’s property is None if hovered area does not belong to any property.

• EVT_PG_RIGHT_CLICK: Respond to wxEVT_PG_RIGHT_CLICK event, which occurs when property is clicked on with right mouse button.

• EVT_PG_DOUBLE_CLICK: Respond to wxEVT_PG_DOUBLE_CLICK event, which occurs when property is double-clicked on with left mouse button.

• EVT_PG_ITEM_COLLAPSED: Respond to wxEVT_PG_ITEM_COLLAPSED event, generated when user collapses a property or category.

• EVT_PG_ITEM_EXPANDED: Respond to wxEVT_PG_ITEM_EXPANDED event, generated when user expands a property or category.

• EVT_PG_LABEL_EDIT_BEGIN: Respond to wxEVT_PG_LABEL_EDIT_BEGIN event, generated when user is about to begin editing a property label. You can veto this event to prevent the action.

• EVT_PG_LABEL_EDIT_ENDING: Respond to wxEVT_PG_LABEL_EDIT_ENDING event, generated when user is about to end editing of a property label. You can veto this event to prevent the action.

• EVT_PG_COL_BEGIN_DRAG: Respond to wxEVT_PG_COL_BEGIN_DRAG event, generated when user starts resizing a column - can be vetoed.

• EVT_PG_COL_DRAGGING, : Respond to wxEVT_PG_COL_DRAGGING , event, generated when a column resize by user is in progress. This event is also generated when user double-clicks the splitter in order to recenter it.

• EVT_PG_COL_END_DRAG: Respond to wxEVT_PG_COL_END_DRAG event, generated after column resize by user has finished.

Note

Use Freeze and Thaw respectively to disable and enable drawing. This will also delay sorting etc. miscellaneous calculations to the last possible moment.

Class Hierarchy

Inheritance diagram for class PropertyGrid:

Methods Summary

__init__	Two step constructor.
AddActionTrigger	Adds given key combination to trigger given action.
AddToSelection	Adds given property into selection.
AutoGetTranslation	This static function enables or disables automatic use of wx.GetTranslation for following strings: wx.propgrid.EnumProperty list labels, wx.propgrid.FlagsProperty child property labels.
BeginLabelEdit	Creates label editor wx.TextCtrl for given column, for property that is currently selected.
CenterSplitter	Centers the splitter.
ChangePropertyValue	Changes value of a property, as if from an editor.
Clear	Deletes all properties.
ClearActionTriggers	Clears action triggers for given action.
CommitChangesFromEditor	Forces updating the value of property from the editor control.
Create	Two step creation.
DedicateKey	Dedicates a specific keycode to wx.propgrid.PropertyGrid.
DoHidePropertyError	Override in derived class to hide an error displayed by DoShowPropertyError .
DoRegisterEditorClass	Registers a new editor class.
DoShowPropertyError	Override in derived class to display error messages in custom manner (these message usually only result from validation failure).
EditorsValueWasModified	Call when editor widget’s contents is modified.
EditorsValueWasNotModified	Reverse of EditorsValueWasModified .
EnableCategories	Enables or disables (shows/hides) categories according to parameter enable.
EndLabelEdit	Destroys label editor wx.TextCtrl, if any.
EnsureVisible	Scrolls and/or expands items to ensure that the given item is visible.
FitColumns	Reduces column sizes to minimum possible, while still retaining fully visible grid contents (labels, images).
GetCaptionBackgroundColour	Returns current category caption background colour.
GetCaptionFont	Returns current category caption font.
GetCaptionForegroundColour	Returns current category caption text colour.
GetCellBackgroundColour	Returns current cell background colour.
GetCellDisabledTextColour	Returns current cell text colour when disabled.
GetCellTextColour	Returns current cell text colour.
GetClassDefaultAttributes
GetColumnCount	Returns number of columns currently on grid.
GetEditorTextCtrl	Returns wx.TextCtrl active in currently selected property, if any.
GetEmptySpaceColour	Returns colour of empty space below properties.
GetFontHeight	Returns height of highest characters of used font.
GetGrid	Returns pointer to itself.
GetImageRect	Returns rectangle of custom paint image.
GetImageSize	Returns size of the custom paint image in front of property.
GetLabelEditor	Returns currently active label editor, None if none.
GetLastItem	Returns last item which could be iterated using given flags.
GetLineColour	Returns colour of lines between cells.
GetMarginColour	Returns background colour of margin.
GetPanel	Returns wx.Window that the properties are painted on, and which should be used as the parent for editor controls.
GetRoot	Returns “root property”.
GetRowHeight	Returns height of a single grid row (in pixels).
GetSelectedProperty	Returns currently selected property.
GetSelection	Returns currently selected property.
GetSelectionBackgroundColour	Returns current selection background colour.
GetSelectionForegroundColour	Returns current selection text colour.
GetSplitterPosition	Returns current splitter x position.
GetStatusBar	Return wx.StatusBar that is used by this wx.propgrid.PropertyGrid.
GetUncommittedPropertyValue	Returns most up-to-date value of selected property.
GetUnspecifiedValueAppearance	Returns current appearance of unspecified value cells.
GetUnspecifiedValueText	Returns (visual) text representation of the unspecified property value.
GetVerticalSpacing	Returns current vertical spacing.
HitTest	Returns information about arbitrary position in the grid.
IsAnyModified	Returns True if any property has been modified by the user.
IsEditorFocused	Returns True if a property editor control has focus.
IsEditorsValueModified	Returns True if editor’s value was marked modified.
IsFrozen	Returns True if updating is frozen (ie.
MakeColumnEditable	Makes given column editable by user.
OnTLPChanging	It is recommended that you call this function any time your code causes wx.propgrid.PropertyGrid’s top-level parent to change.
RefreshEditor	Refreshes any active editor control.
RefreshProperty	Redraws given property.
RegisterEditorClass	Forwards to DoRegisterEditorClass with empty name.
RemoveFromSelection	Removes given property from selection.
ResetColours	Resets all colours to the original system values.
ResetColumnSizes	Resets column sizes and splitter positions, based on proportions.
SelectProperty	Selects a property.
SetCaptionBackgroundColour	Sets category caption background colour.
SetCaptionTextColour	Sets category caption text colour.
SetCellBackgroundColour	Sets default cell background colour - applies to property cells.
SetCellDisabledTextColour	Sets cell text colour for disabled properties.
SetCellTextColour	Sets default cell text colour - applies to property name and value text.
SetColumnCount	Set number of columns (2 or more).
SetCurrentCategory	Sets the ‘current’ category - Append will add non-category properties under it.
SetEmptySpaceColour	Sets colour of empty space below properties.
SetLineColour	Sets colour of lines between cells.
SetMarginColour	Sets background colour of margin.
SetSelection	Set entire new selection from given list of properties.
SetSelectionBackgroundColour	Sets selection background colour - applies to selected property name background.
SetSelectionTextColour	Sets selection foreground colour - applies to selected property name text.
SetSplitterLeft	Moves splitter as left as possible, while still allowing all labels to be shown in full.
SetSplitterPosition	Sets x coordinate of the splitter.
SetUnspecifiedValueAppearance	Sets appearance of value cells representing an unspecified property value.
SetVerticalSpacing	Sets vertical spacing.
ShowPropertyError	Shows an brief error message that is related to a property.
WasValueChangedInEvent	You can use this member function, for instance, to detect in wx.propgrid.PGProperty.OnEvent if wx.propgrid.PGProperty.SetValueInEvent was already called in wx.propgrid.PGEditor.OnEvent .

Properties Summary

CaptionBackgroundColour	See GetCaptionBackgroundColour and SetCaptionBackgroundColour
CaptionFont	See GetCaptionFont
CaptionForegroundColour	See GetCaptionForegroundColour
CellBackgroundColour	See GetCellBackgroundColour and SetCellBackgroundColour
CellDisabledTextColour	See GetCellDisabledTextColour and SetCellDisabledTextColour
CellTextColour	See GetCellTextColour and SetCellTextColour
ColumnCount	See GetColumnCount and SetColumnCount
EditorTextCtrl	See GetEditorTextCtrl
EmptySpaceColour	See GetEmptySpaceColour and SetEmptySpaceColour
FontHeight	See GetFontHeight
Grid	See GetGrid
ImageSize	See GetImageSize
LabelEditor	See GetLabelEditor
LastItem	See GetLastItem
LineColour	See GetLineColour and SetLineColour
MarginColour	See GetMarginColour and SetMarginColour
Panel	See GetPanel
Root	See GetRoot
RowHeight	See GetRowHeight
SelectedProperty	See GetSelectedProperty
Selection	See GetSelection and SetSelection
SelectionBackgroundColour	See GetSelectionBackgroundColour and SetSelectionBackgroundColour
SelectionForegroundColour	See GetSelectionForegroundColour
SplitterPosition	See GetSplitterPosition and SetSplitterPosition
StatusBar	See GetStatusBar
UncommittedPropertyValue	See GetUncommittedPropertyValue
UnspecifiedValueAppearance	See GetUnspecifiedValueAppearance and SetUnspecifiedValueAppearance
UnspecifiedValueText	See GetUnspecifiedValueText
VerticalSpacing	See GetVerticalSpacing and SetVerticalSpacing

Class API

class wx.propgrid.PropertyGrid(Control, PropertyGridInterface)

Possible constructors:

PropertyGrid()

PropertyGrid(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
             style=PG_DEFAULT_STYLE, name=PropertyGridNameStr)

PropertyGrid is a specialized grid for editing properties - in other words name = value pairs.

Methods

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Two step constructor.

Call Create when this constructor is called to build up the wx.propgrid.PropertyGrid

---

__init__ (self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=PG_DEFAULT_STYLE, name=PropertyGridNameStr)

Constructor.

The styles to be used are styles valid for the wx.Window.

Parameters

• parent (wx.Window) –

• id (wx.WindowID) –

• pos (wx.Point) –

• size (wx.Size) –

• style (long) –

• name (string) –

See also

PropertyGrid Window Styles.

---

---

AddActionTrigger(self, action, keycode, modifiers=0)

Adds given key combination to trigger given action.

Here is a sample code to make Enter key press move focus to the next property.

propGrid.AddActionTrigger(wx.propgrid.PG_ACTION_NEXT_PROPERTY,
                          wx.WXK_RETURN)
propGrid.DedicateKey(wx.WXK_RETURN)

Parameters

• action (int) – Which action to trigger. See PropertyGrid Action Identifiers.

• keycode (int) – Which keycode triggers the action.

• modifiers (int) – Which key event modifiers, in addition to keycode, are needed to trigger the action.

---

AddToSelection(self, id)

Adds given property into selection.

If wx.propgrid.PG_EX_MULTIPLE_SELECTION extra style is not used, then this has same effect as calling SelectProperty .

Parameters

id (wx.propgrid.PGPropArgCls) –

Return type

bool

Note

Multiple selection is not supported for categories. This means that if you have properties selected, you cannot add category to selection, and also if you have category selected, you cannot add other properties to selection. This member function will fail silently in these cases, even returning True.

---

static AutoGetTranslation(enable)

This static function enables or disables automatic use of wx.GetTranslation for following strings: wx.propgrid.EnumProperty list labels, wx.propgrid.FlagsProperty child property labels.

Default is False.

Parameters

enable (bool) –

---

BeginLabelEdit(self, colIndex=0)

Creates label editor wx.TextCtrl for given column, for property that is currently selected.

When multiple selection is enabled, this applies to whatever property GetSelection returns.

Parameters

colIndex (int) – Which column’s label to edit. Note that you should not use value 1, which is reserved for property value column.

See also

EndLabelEdit , MakeColumnEditable

---

CenterSplitter(self, enableAutoResizing=False)

Centers the splitter.

Parameters

enableAutoResizing (bool) – If True, automatic column resizing is enabled (only applicapple if window style wx.propgrid.PG_SPLITTER_AUTO_CENTER is used).

---

ChangePropertyValue(self, id, newValue)

Changes value of a property, as if from an editor.

Use this instead of SetPropertyValue if you need the value to run through validation process, and also send the property change event.

Parameters

• id (wx.propgrid.PGPropArgCls) –

• newValue (PGVariant) –

Return type

bool

Returns

Returns True if value was successfully changed.

---

Clear(self)

Deletes all properties.

---

ClearActionTriggers(self, action)

Clears action triggers for given action.

Parameters

action (int) – Which action to trigger. PropertyGrid Action Identifiers.

---

CommitChangesFromEditor(self, flags=0)

Forces updating the value of property from the editor control.

Note that wxEVT_PG_CHANGING and wxEVT_PG_CHANGED are dispatched using ProcessEvent, meaning your event handlers will be called immediately.

Parameters

flags (wx.int) –

Return type

bool

Returns

Returns True if anything was changed.

---

Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=PG_DEFAULT_STYLE, name=PropertyGridNameStr)

Two step creation.

Whenever the control is created without any parameters, use Create to actually create it. Don’t access the control’s public methods before this is called

Parameters

• parent (wx.Window) –

• id (wx.WindowID) –

• pos (wx.Point) –

• size (wx.Size) –

• style (long) –

• name (string) –

Return type

bool

See also

PropertyGrid Window Styles.

---

DedicateKey(self, keycode)

Dedicates a specific keycode to wx.propgrid.PropertyGrid.

This means that such key presses will not be redirected to editor controls.

Using this function allows, for example, navigation between properties using arrow keys even when the focus is in the editor control.

Parameters

keycode (int) –

---

DoHidePropertyError(self, property)

Override in derived class to hide an error displayed by DoShowPropertyError .

Parameters

property (wx.propgrid.PGProperty) –

See also

DoShowPropertyError

---

static DoRegisterEditorClass(editor, name, noDefCheck=False)

Registers a new editor class.

Parameters

• editor (wx.propgrid.PGEditor) –

• name (string) –

• noDefCheck (bool) –

Return type

wx.propgrid.PGEditor

Returns

Returns pointer to the editor class instance that should be used.

---

DoShowPropertyError(self, property, msg)

Override in derived class to display error messages in custom manner (these message usually only result from validation failure).

Parameters

• property (wx.propgrid.PGProperty) –

• msg (string) –

Note

If you implement this, then you also need to implement DoHidePropertyError - possibly to do nothing, if error does not need hiding (e.g. it was logged or shown in a message box).

See also

DoHidePropertyError

---

EditorsValueWasModified(self)

Call when editor widget’s contents is modified.

For example, this is called when changes text in wx.TextCtrl (used in wx.propgrid.StringProperty and wx.propgrid.IntProperty).

Note

This function should only be called by custom properties.

See also

wx.propgrid.PGProperty.OnEvent

---

EditorsValueWasNotModified(self)

Reverse of EditorsValueWasModified .

Note

This function should only be called by custom properties.

---

EnableCategories(self, enable)

Enables or disables (shows/hides) categories according to parameter enable.

Parameters

enable (bool) –

Return type

bool

Note

This functions deselects selected property, if any. Validation failure option wx.propgrid.PG_VFB_STAY_IN_PROPERTY is not respected, ie. selection is cleared even if editor had invalid value.

---

EndLabelEdit(self, commit=True)

Destroys label editor wx.TextCtrl, if any.

Parameters

commit (bool) – Use True (default) to store edited label text in property cell data.

See also

BeginLabelEdit , MakeColumnEditable

---

EnsureVisible(self, id)

Scrolls and/or expands items to ensure that the given item is visible.

Parameters

id (wx.propgrid.PGPropArgCls) –

Return type

bool

Returns

Returns True if something was actually done.

---

FitColumns(self)

Reduces column sizes to minimum possible, while still retaining fully visible grid contents (labels, images).

Return type

Size

Returns

Minimum size for the grid to still display everything.

Note

Does not work well with wx.propgrid.PG_SPLITTER_AUTO_CENTER window style.

---

GetCaptionBackgroundColour(self)

Returns current category caption background colour.

Return type

Colour

---

GetCaptionFont(self)

Returns current category caption font.

Return type

Font

---

GetCaptionForegroundColour(self)

Returns current category caption text colour.

Return type

Colour

---

GetCellBackgroundColour(self)

Returns current cell background colour.

Return type

Colour

---

GetCellDisabledTextColour(self)

Returns current cell text colour when disabled.

Return type

Colour

---

GetCellTextColour(self)

Returns current cell text colour.

Return type

Colour

---

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters

variant (WindowVariant) –

Return type

VisualAttributes

---

GetColumnCount(self)

Returns number of columns currently on grid.

Return type

int

---

GetEditorTextCtrl(self)

Returns wx.TextCtrl active in currently selected property, if any.

Takes wx.adv.OwnerDrawnComboBox into account.

Return type

TextCtrl

---

GetEmptySpaceColour(self)

Returns colour of empty space below properties.

Return type

Colour

---

GetFontHeight(self)

Returns height of highest characters of used font.

Return type

int

---

GetGrid(self)

Returns pointer to itself.

Dummy function that enables same kind of code to use wx.propgrid.PropertyGrid and wx.propgrid.PropertyGridManager.

Return type

wx.propgrid.PropertyGrid

---

GetImageRect(self, property, item)

Returns rectangle of custom paint image.

Parameters

• property (wx.propgrid.PGProperty) – Return image rectangle for this property.

• item (int) – Which choice of property to use (each choice may have different image).

Return type

Rect

---

GetImageSize(self, property=None, item=-1)

Returns size of the custom paint image in front of property.

Parameters

• property (wx.propgrid.PGProperty) – Return image rectangle for this property. If this argument is None, then preferred size is returned.

• item (int) – Which choice of property to use (each choice may have different image).

Return type

Size

---

GetLabelEditor(self)

Returns currently active label editor, None if none.

Return type

TextCtrl

---

GetLastItem(self, flags=PG_ITERATE_DEFAULT)

Returns last item which could be iterated using given flags.

Parameters

flags (int) – See PropertyGridIterator Flags.

Return type

wx.propgrid.PGProperty

---

GetLineColour(self)

Returns colour of lines between cells.

Return type

Colour

---

GetMarginColour(self)

Returns background colour of margin.

Return type

Colour

---

GetPanel(self)

Returns wx.Window that the properties are painted on, and which should be used as the parent for editor controls.

Return type

Window

---

GetRoot(self)

Returns “root property”.

It does not have name, etc. and it is not visible. It is only useful for accessing its children.

Return type

wx.propgrid.PGProperty

---

GetRowHeight(self)

Returns height of a single grid row (in pixels).

Return type

int

---

GetSelectedProperty(self)

Returns currently selected property.

Return type

wx.propgrid.PGProperty

---

GetSelection(self)

Returns currently selected property.

Return type

wx.propgrid.PGProperty

---

GetSelectionBackgroundColour(self)

Returns current selection background colour.

Return type

Colour

---

GetSelectionForegroundColour(self)

Returns current selection text colour.

Return type

Colour

---

GetSplitterPosition(self, splitterIndex=0)

Returns current splitter x position.

Parameters

splitterIndex (int) –

Return type

int

---

GetStatusBar(self)

Return wx.StatusBar that is used by this wx.propgrid.PropertyGrid.

You can reimplement this member function in derived class to override the default behaviour of using the top-level wx.Frame’s status bar, if any.

Return type

StatusBar

---

GetUncommittedPropertyValue(self)

Returns most up-to-date value of selected property.

This will return value different from GetSelectedProperty .GetValue() only when text editor is activate and string edited by user represents valid, uncommitted property value.

Return type

PGVariant

---

GetUnspecifiedValueAppearance(self)

Returns current appearance of unspecified value cells.

Return type

wx.propgrid.PGCell

See also

SetUnspecifiedValueAppearance

---

GetUnspecifiedValueText(self, argFlags=0)

Returns (visual) text representation of the unspecified property value.

Parameters

argFlags (int) – For internal use only.

Return type

string

---

GetVerticalSpacing(self)

Returns current vertical spacing.

Return type

int

---

HitTest(self, pt)

Returns information about arbitrary position in the grid.

Parameters

pt (wx.Point) – Coordinates in the virtual grid space. You may need to use wx.Scrolled.CalcScrolledPosition for translating wx.propgrid.PropertyGrid client coordinates into something this member function can use.

Return type

wx.propgrid.PropertyGridHitTestResult

---

IsAnyModified(self)

Returns True if any property has been modified by the user.

Return type

bool

---

IsEditorFocused(self)

Returns True if a property editor control has focus.

Return type

bool

---

IsEditorsValueModified(self)

Returns True if editor’s value was marked modified.

Return type

bool

---

IsFrozen(self)

Returns True if updating is frozen (ie.

Freeze called but not yet Thaw ).

Return type

bool

---

MakeColumnEditable(self, column, editable=True)

Makes given column editable by user.

Parameters

• column (int) – The index of the column to make editable.

• editable (bool) – Using False here will disable column from being editable.

column must not be equal to 1, as the second column is always editable and can be made read-only only on cell-by-cell basis using:

property.ChangeFlag(wx.propgrid.PG_PROP_READONLY, True)

See also

BeginLabelEdit , EndLabelEdit

---

OnTLPChanging(self, newTLP)

It is recommended that you call this function any time your code causes wx.propgrid.PropertyGrid’s top-level parent to change.

wx.propgrid.PropertyGrid’s OnIdle() handler should be able to detect most changes, but it is not perfect.

Parameters

newTLP (wx.Window) – New top-level parent that is about to be set. Old top-level parent window should still exist as the current one.

Note

This function is automatically called from wx.propgrid.PropertyGrid:: Reparent and wx.propgrid.PropertyGridManager.Reparent . You only need to use it if you reparent wx.propgrid.PropertyGrid indirectly.

---

RefreshEditor(self)

Refreshes any active editor control.

---

RefreshProperty(self, p)

Redraws given property.

Parameters

p (wx.propgrid.PGProperty) –

---

static RegisterEditorClass(editor, noDefCheck=False)

Forwards to DoRegisterEditorClass with empty name.

Parameters

• editor (wx.propgrid.PGEditor) –

• noDefCheck (bool) –

Return type

wx.propgrid.PGEditor

---

RemoveFromSelection(self, id)

Removes given property from selection.

If property is not selected, an assertion failure will occur.

Parameters

id (wx.propgrid.PGPropArgCls) –

Return type

bool

---

ResetColours(self)

Resets all colours to the original system values.

---

ResetColumnSizes(self, enableAutoResizing=False)

Resets column sizes and splitter positions, based on proportions.

Parameters

enableAutoResizing (bool) – If True, automatic column resizing is enabled (only applicapple if window style wx.propgrid.PG_SPLITTER_AUTO_CENTER is used).

See also

wx.propgrid.PropertyGridInterface.SetColumnProportion

---

SelectProperty(self, id, focus=False)

Selects a property.

Editor widget is automatically created, but not focused unless focus is True.

Parameters

• id (wx.propgrid.PGPropArgCls) – Property to select (name or pointer).

• focus (bool) – If True, move keyboard focus to the created editor right away.

Return type

bool

Returns

returns True if selection finished successfully. Usually only fails if current value in editor is not valid.

Note

In wx.propgrid.PropertyGrid 1.4, this member function used to generate wxEVT_PG_SELECTED . In wxWidgets 2.9 and later, it no longer does that.

Note

This clears any previous selection.

See also

wx.propgrid.PropertyGridInterface.ClearSelection

---

SetCaptionBackgroundColour(self, col)

Sets category caption background colour.

Parameters

col (wx.Colour) –

---

SetCaptionTextColour(self, col)

Sets category caption text colour.

Parameters

col (wx.Colour) –

---

SetCellBackgroundColour(self, col)

Sets default cell background colour - applies to property cells.

Note that appearance of editor widgets may not be affected.

Parameters

col (wx.Colour) –

---

SetCellDisabledTextColour(self, col)

Sets cell text colour for disabled properties.

Parameters

col (wx.Colour) –

---

SetCellTextColour(self, col)

Sets default cell text colour - applies to property name and value text.

Note that appearance of editor widgets may not be affected.

Parameters

col (wx.Colour) –

---

SetColumnCount(self, colCount)

Set number of columns (2 or more).

Parameters

colCount (int) –

---

SetCurrentCategory(self, id)

Sets the ‘current’ category - Append will add non-category properties under it.

Parameters

id (wx.propgrid.PGPropArgCls) –

---

SetEmptySpaceColour(self, col)

Sets colour of empty space below properties.

Parameters

col (wx.Colour) –

---

SetLineColour(self, col)

Sets colour of lines between cells.

Parameters

col (wx.Colour) –

---

SetMarginColour(self, col)

Sets background colour of margin.

Parameters

col (wx.Colour) –

---

SetSelection(self, newSelection)

Set entire new selection from given list of properties.

Parameters

newSelection (ArrayPGProperty) –

---

SetSelectionBackgroundColour(self, col)

Sets selection background colour - applies to selected property name background.

Parameters

col (wx.Colour) –

---

SetSelectionTextColour(self, col)

Sets selection foreground colour - applies to selected property name text.

Parameters

col (wx.Colour) –

---

SetSplitterLeft(self, privateChildrenToo=False)

Moves splitter as left as possible, while still allowing all labels to be shown in full.

Parameters

privateChildrenToo (bool) – If False, will still allow private children to be cropped.

---

SetSplitterPosition(self, newxpos, col=0)

Sets x coordinate of the splitter.

Parameters

• newxpos (int) –

• col (int) –

Note

Splitter position cannot exceed grid size, and therefore setting it during form creation may fail as initial grid size is often smaller than desired splitter position, especially when sizers are being used.

---

SetUnspecifiedValueAppearance(self, cell)

Sets appearance of value cells representing an unspecified property value.

Default appearance is blank.

Parameters

cell (wx.propgrid.PGCell) –

Note

If you set the unspecified value to have any textual representation, then that will override “InlineHelp” attribute.

See also

wx.propgrid.PGProperty.SetValueToUnspecified , wx.propgrid.PGProperty.IsValueUnspecified

---

SetVerticalSpacing(self, vspacing)

Sets vertical spacing.

Can be 1, 2, or 3 - a value relative to font height. Value of 2 should be default on most platforms.

Parameters

vspacing (int) –

---

ShowPropertyError(self, id, msg)

Shows an brief error message that is related to a property.

Parameters

• id (wx.propgrid.PGPropArgCls) –

• msg (string) –

---

WasValueChangedInEvent(self)

You can use this member function, for instance, to detect in wx.propgrid.PGProperty.OnEvent if wx.propgrid.PGProperty.SetValueInEvent was already called in wx.propgrid.PGEditor.OnEvent .

It really only detects if was value was changed using wx.propgrid.PGProperty.SetValueInEvent , which is usually used when a ‘picker’ dialog is displayed. If value was written by “normal means” in wx.propgrid.PGProperty.StringToValue or IntToValue(), then this function will return False (on the other hand, wx.propgrid.PGProperty.OnEvent is not even called in those cases).

Return type

bool

Properties

CaptionBackgroundColour

See GetCaptionBackgroundColour and SetCaptionBackgroundColour

---

CaptionFont

See GetCaptionFont

---

CaptionForegroundColour

See GetCaptionForegroundColour

---

CellBackgroundColour

See GetCellBackgroundColour and SetCellBackgroundColour

---

CellDisabledTextColour

See GetCellDisabledTextColour and SetCellDisabledTextColour

---

CellTextColour

See GetCellTextColour and SetCellTextColour

---

ColumnCount

See GetColumnCount and SetColumnCount

---

EditorTextCtrl

See GetEditorTextCtrl

---

EmptySpaceColour

See GetEmptySpaceColour and SetEmptySpaceColour

---

FontHeight

See GetFontHeight

---

Grid

See GetGrid

---

ImageSize

See GetImageSize

---

LabelEditor

See GetLabelEditor

---

LastItem

See GetLastItem

---

LineColour

See GetLineColour and SetLineColour

---

MarginColour

See GetMarginColour and SetMarginColour

---

Panel

See GetPanel

---

Root

See GetRoot

---

RowHeight

See GetRowHeight

---

SelectedProperty

See GetSelectedProperty

---

Selection

See GetSelection and SetSelection

---

SelectionBackgroundColour

See GetSelectionBackgroundColour and SetSelectionBackgroundColour

---

SelectionForegroundColour

See GetSelectionForegroundColour

---

SplitterPosition

See GetSplitterPosition and SetSplitterPosition

---

StatusBar

See GetStatusBar

---

UncommittedPropertyValue

See GetUncommittedPropertyValue

---

UnspecifiedValueAppearance

See GetUnspecifiedValueAppearance and SetUnspecifiedValueAppearance

---

UnspecifiedValueText

See GetUnspecifiedValueText

---

VerticalSpacing

See GetVerticalSpacing and SetVerticalSpacing