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

Inheritance diagram for class PropertyGridPageState:

Known Subclasses

wx.propgrid.PropertyGridPage

Methods Summary

__init__	Default constructor.
CheckColumnWidths	Makes sure all columns have minimum width.
DoDelete	Override this member function to add custom behaviour on property deletion.
DoInsert	Override this member function to add custom behaviour on property insertion.
DoSetSplitterPosition	This needs to be overridden in grid used the manager so that splitter changes can be propagated to other pages.
EnableCategories
EnsureVirtualHeight	Make sure virtual height is up-to-date.
GetActualVirtualHeight	Returns actual height of contained visible properties.
GetColumnCount
GetColumnFullWidth
GetColumnMinWidth
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
VirtualHeightChanged	Called after virtual height needs to be recalculated.

Properties Summary

ActualVirtualHeight	See GetActualVirtualHeight
ColumnCount	See GetColumnCount
Grid	See GetGrid
LastItem	See GetLastItem
Selection	See GetSelection
VirtualHeight	See GetVirtualHeight
VirtualWidth	See GetVirtualWidth

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.

---

CheckColumnWidths(self, widthChange=0)

Makes sure all columns have minimum width.

Parameters:

widthChange (int) –

---

DoDelete(self, item, doDelete=True)

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

Parameters:

• item (wx.propgrid.PGProperty) –

• doDelete (bool) –

---

DoInsert(self, parent, index, property)

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

Parameters:

• parent (wx.propgrid.PGProperty) –

• index (int) –

• property (wx.propgrid.PGProperty) –

Return type:

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

---

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

---

GetColumnFullWidth(self, p, col)

Parameters:

• p (wx.propgrid.PGProperty) –

• col (int) –

Return type:

int

---

GetColumnMinWidth(self, column)

Parameters:

column (int) –

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

---

VirtualHeightChanged(self)

Called after virtual height needs to be recalculated.

Properties

ActualVirtualHeight

See GetActualVirtualHeight

---

ColumnCount

See GetColumnCount

---

Grid

See GetGrid

---

LastItem

See GetLastItem

---

Selection

See GetSelection

---

VirtualHeight

See GetVirtualHeight

---

VirtualWidth

See GetVirtualWidth