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¶
Known Subclasses¶
Methods Summary¶
Default constructor. |
|
Makes sure all columns have minimum width. |
|
Override this member function to add custom behaviour on property deletion. |
|
Override this member function to add custom behaviour on property insertion. |
|
This needs to be overridden in grid used the manager so that splitter changes can be propagated to other pages. |
|
Make sure virtual height is up-to-date. |
|
Returns actual height of contained visible properties. |
|
Returns last item which could be iterated using given flags. |
|
Returns currently selected property. |
|
Returns (precalculated) height of contained visible properties. |
|
Returns combined width of margin and all the columns. |
|
Returns information about arbitrary position in the grid. |
|
Returns |
|
Called after virtual height needs to be recalculated. |
Properties Summary¶
See |
|
See |
|
See |
|
See |
|
See |
|
See |
Class API¶
- class wx.propgrid.PropertyGridPageState(object)¶
Possible constructors:
PropertyGridPageState() -> None
Contains low-level property page information (properties, column widths, etc.) of a single PropertyGrid or single PropertyGridPage.
Methods¶
- __init__(self)¶
Default constructor.
- Return type:
None
- CheckColumnWidths(self, widthChange=0)¶
Makes sure all columns have minimum width.
- Parameters:
widthChange (int)
- Return type:
None
- DoDelete(self, item, doDelete=True)¶
Override this member function to add custom behaviour on property deletion.
- Parameters:
item (wx.propgrid.PGProperty)
doDelete (bool)
- Return type:
None
- 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:
- 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)
- Return type:
None
- EnableCategories(self, enable)¶
- Parameters:
enable (bool)
- Return type:
bool
- EnsureVirtualHeight(self)¶
Make sure virtual height is up-to-date.
- Return type:
None
- 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:
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:
- GetLastItem(self, flags=PG_ITERATE_DEFAULT)¶
Returns last item which could be iterated using given flags.
- Parameters:
flags (int) – PropertyGridIterator Flags
- Return type:
- GetPropertyCategory(self, p)¶
- Parameters:
- Return type:
- GetSelection(self)¶
Returns currently selected property.
- Return type:
- 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:
- 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.
- Return type:
None
Properties¶
- ActualVirtualHeight¶
- ColumnCount¶
See
GetColumnCount
- LastItem¶
See
GetLastItem
- Selection¶
See
GetSelection
- VirtualHeight¶
See
GetVirtualHeight
- VirtualWidth¶
See
GetVirtualWidth