phoenix_title wx.propgrid.PropertyGridPageState

Contains low-level property page information (properties, column widths, etc.) of a single wx.propgrid.PropertyGrid or single wx.propgrid.PropertyGridPage.

Generally you should not use this class directly, but instead member functions in wx.propgrid.PropertyGridInterface, wx.propgrid.PropertyGrid, wx.propgrid.PropertyGridPage, and wx.propgrid.PropertyGridManager.

Note

Currently this class is not implemented in wxPython.


class_hierarchy Class Hierarchy

Inheritance diagram for class PropertyGridPageState:

method_summary Methods Summary

__init__

Default constructor.

BaseGetPropertyByName

Returns property by its name.

CalculateFontAndBitmapStuff

CheckColumnWidths

Makes sure all columns have minimum width.

DoAppend

Base append.

DoClear

Called in, for example, wx.propgrid.PropertyGrid.Clear .

DoClearSelection

DoCollapse

DoDelete

Override this member function to add custom behaviour on property deletion.

DoExpand

DoFitColumns

DoGetColumnProportion

DoGetItemAtY

DoGetPropertyValues

DoGetRoot

DoHideProperty

DoInsert

Override this member function to add custom behaviour on property insertion.

DoIsPropertySelected

DoLimitPropertyEditing

DoRemoveFromSelection

DoSelectProperty

DoSetColumnProportion

DoSetPropertyName

DoSetPropertyValue

DoSetPropertyValueString

DoSetPropertyValueWxObjectPtr

DoSetPropertyValues

DoSetSelection

DoSetSplitterPosition

This needs to be overridden in grid used the manager so that splitter changes can be propagated to other pages.

DoSort

DoSortChildren

EnableCategories

EnsureVirtualHeight

Make sure virtual height is up-to-date.

GetActualVirtualHeight

Returns actual height of contained visible properties.

GetColumnCount

GetColumnFitWidth

Returns minimal width for given column so that all images and texts will fit entirely.

GetColumnFullWidth

GetColumnWidth

GetGrid

GetLastItem

Returns last item which could be iterated using given flags.

GetPropertyCategory

GetSelection

Returns currently selected property.

GetVirtualHeight

Returns (precalculated) height of contained visible properties.

GetVirtualWidth

Returns combined width of margin and all the columns.

HitTest

Returns information about arbitrary position in the grid.

IsDisplayed

Returns True if page is visibly displayed.

IsInNonCatMode

OnClientWidthChange

widthChange is non-client.

PrepareAfterItemsAdded

PropagateColSizeDec

RecalculateVirtualHeight

Recalculates m_virtualHeight.

ResetColumnSizes

SetColumnCount

SetSplitterLeft

SetVirtualWidth

Set virtual width for this particular page.

VirtualHeightChanged

Called after virtual height needs to be recalculated.


api Class API

class wx.propgrid.PropertyGridPageState(object)

Possible constructors:

PropertyGridPageState()

Contains low-level property page information (properties, column widths, etc.) of a single PropertyGrid or single PropertyGridPage.


Methods

__init__(self)

Default constructor.



BaseGetPropertyByName(self, name)

Returns property by its name.

Parameters

name (string) –

Return type

wx.propgrid.PGProperty



CalculateFontAndBitmapStuff(self, vspacing)
Parameters

vspacing (int) –



CheckColumnWidths(self, widthChange=0)

Makes sure all columns have minimum width.

Parameters

widthChange (int) –



DoAppend(self, property)

Base append.

Parameters

property (wx.propgrid.PGProperty) –

Return type

wx.propgrid.PGProperty



DoClear(self)

Called in, for example, wx.propgrid.PropertyGrid.Clear .



DoClearSelection(self)
Return type

bool



DoCollapse(self, p)
Parameters

p (wx.propgrid.PGProperty) –

Return type

bool



DoDelete(self, item, doDelete=True)

Override this member function to add custom behaviour on property deletion.

Parameters


DoExpand(self, p)
Parameters

p (wx.propgrid.PGProperty) –

Return type

bool



DoFitColumns(self, allowGridResize=False)
Parameters

allowGridResize (bool) –

Return type

Size



DoGetColumnProportion(self, column)
Parameters

column (int) –

Return type

int



DoGetItemAtY(self, y)
Parameters

y (int) –

Return type

wx.propgrid.PGProperty



DoGetPropertyValues(self, listname, baseparent, flags)
Parameters
Return type

PGVariant



DoGetRoot(self)
Return type

wx.propgrid.PGProperty



DoHideProperty(self, p, hide, flags=PG_RECURSE)
Parameters
Return type

bool



DoInsert(self, parent, index, property)

Override this member function to add custom behaviour on property insertion.

Parameters
Return type

wx.propgrid.PGProperty



DoIsPropertySelected(self, prop)
Parameters

prop (wx.propgrid.PGProperty) –

Return type

bool



DoLimitPropertyEditing(self, p, limit=True)
Parameters


DoRemoveFromSelection(self, prop)
Parameters

prop (wx.propgrid.PGProperty) –



DoSelectProperty(self, p, flags=0)
Parameters
Return type

bool



DoSetColumnProportion(self, column, proportion)
Parameters
  • column (int) –

  • proportion (int) –



DoSetPropertyName(self, p, newName)
Parameters


DoSetPropertyValue(self, p, value)
Parameters
Return type

bool



DoSetPropertyValueString(self, p, value)
Parameters
Return type

bool



DoSetPropertyValueWxObjectPtr(self, p, value)
Parameters
Return type

bool



DoSetPropertyValues(self, list, default_category)
Parameters


DoSetSelection(self, prop)
Parameters

prop (wx.propgrid.PGProperty) –



DoSetSplitterPosition(self, pos, splitterColumn=0, flags=0)

This needs to be overridden in grid used the manager so that splitter changes can be propagated to other pages.

Parameters
  • pos (int) –

  • splitterColumn (int) –

  • flags (int) –



DoSort(self, flags=0)
Parameters

flags (int) –



DoSortChildren(self, p, flags=0)
Parameters


EnableCategories(self, enable)
Parameters

enable (bool) –

Return type

bool



EnsureVirtualHeight(self)

Make sure virtual height is up-to-date.



GetActualVirtualHeight(self)

Returns actual height of contained visible properties.

Return type

int

Note

Mostly used for internal diagnostic purposes.



GetColumnCount(self)
Return type

int



GetColumnFitWidth(self, dc, pwc, col, subProps)

Returns minimal width for given column so that all images and texts will fit entirely.

Used by SetSplitterLeft and DoFitColumns .

Parameters
Return type

int



GetColumnFullWidth(self, dc, p, col)
Parameters
Return type

int



GetColumnWidth(self, column)
Parameters

column (int) –

Return type

int



GetGrid(self)
Return type

wx.propgrid.PropertyGrid



GetLastItem(self, flags=PG_ITERATE_DEFAULT)

Returns last item which could be iterated using given flags.

Parameters

flags (int) – PropertyGridIterator Flags

Return type

wx.propgrid.PGProperty



GetPropertyCategory(self, p)
Parameters

p (wx.propgrid.PGProperty) –

Return type

wx.propgrid.PropertyCategory



GetSelection(self)

Returns currently selected property.

Return type

wx.propgrid.PGProperty



GetVirtualHeight(self)

Returns (precalculated) height of contained visible properties.

Return type

int



GetVirtualWidth(self)

Returns combined width of margin and all the columns.

Return type

int



HitTest(self, pt)

Returns information about arbitrary position in the grid.

Parameters

pt (wx.Point) – Logical coordinates in the virtual grid space. Use wx.Scrolled.CalcUnscrolledPosition if you need to translate a scrolled position into a logical one.

Return type

wx.propgrid.PropertyGridHitTestResult



IsDisplayed(self)

Returns True if page is visibly displayed.

Return type

bool



IsInNonCatMode(self)
Return type

bool



OnClientWidthChange(self, newWidth, widthChange, fromOnResize=False)

widthChange is non-client.

Parameters
  • newWidth (int) –

  • widthChange (int) –

  • fromOnResize (bool) –



PrepareAfterItemsAdded(self)
Return type

bool



PropagateColSizeDec(self, column, decrease, dir)
Parameters
  • column (int) –

  • decrease (int) –

  • dir (int) –



RecalculateVirtualHeight(self)

Recalculates m_virtualHeight.



ResetColumnSizes(self, setSplitterFlags)
Parameters

setSplitterFlags (int) –



SetColumnCount(self, colCount)
Parameters

colCount (int) –



SetSplitterLeft(self, subProps=False)
Parameters

subProps (bool) –



SetVirtualWidth(self, width)

Set virtual width for this particular page.

Parameters

width (int) –



VirtualHeightChanged(self)

Called after virtual height needs to be recalculated.


Properties

ActualVirtualHeight

See GetActualVirtualHeight



ColumnCount

See GetColumnCount and SetColumnCount



Grid

See GetGrid



LastItem

See GetLastItem



Selection

See GetSelection



VirtualHeight

See GetVirtualHeight



VirtualWidth

See GetVirtualWidth and SetVirtualWidth