wx.propgrid.PropertyGridPage¶Holder of property grid page information.
You can subclass this and give instance in wx.propgrid.PropertyGridManager.AddPage . It inherits from wx.EvtHandler and can be used to process events specific to this page (id of events will still be same as manager’s). If you don’t want to use it to process all events of the page, you need to return False in the derived wx.propgrid.PropertyGridPage.IsHandlingAllEvents .
Please note that wx.propgrid.PropertyGridPage lacks many non-const property manipulation functions found in wx.propgrid.PropertyGridManager. Please use parent manager (m_manager member variable) when needed.
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.
Event Handling¶ wx.propgrid.PropertyGridPage receives events emitted by its wx.propgrid.PropertyGridManager, but only those events that are specific to that page. If wx.propgrid.PropertyGridPage:: IsHandlingAllEvents returns False, then unhandled events are sent to the manager’s parent, as usual. See PropertyGrid Event Handling for more information.
Class Hierarchy¶
Inheritance diagram for class PropertyGridPage:
Methods Summary¶Deletes all properties on page. |
|
Reduces column sizes to minimum possible that contents are still visibly (naturally some margin space will be applied as well). |
|
Returns page index in manager;. |
|
Returns “root property”. |
|
Returns x-coordinate position of splitter on a page. |
|
Returns pointer to contained property grid state. |
|
Returns id of the tool bar item that represents this page on wx.propgrid.PropertyGridManager’s wx.ToolBar. |
|
Do any member initialization in this method. |
|
Return |
|
Called every time page is about to be shown. |
|
Refreshes given property on page. |
|
Sets splitter position on page. |
Properties Summary¶See |
|
See |
|
See |
|
See |
Class API¶
wx.propgrid.PropertyGridPage(EvtHandler, PropertyGridInterface, PropertyGridPageState)¶Possible constructors:
PropertyGridPage()
Holder of property grid page information.
__init__(self)¶Clear(self)¶Deletes all properties on page.
FitColumns(self)¶Reduces column sizes to minimum possible that contents are still visibly (naturally some margin space will be applied as well).
Note that you can also get calculated column widths by calling GetColumnWidth immediately after this function returns.
Size
Returns minimum size for the page to still display everything.
Note
This function only works properly if size of containing grid was already fairly large.
GetIndex(self)¶Returns page index in manager;.
int
GetRoot(self)¶Returns “root property”.
It does not have name, etc. and it is not visible. It is only useful for accessing its children.
GetSplitterPosition(self, col=0)¶Returns x-coordinate position of splitter on a page.
col (int) –
int
GetStatePtr(self)¶Returns pointer to contained property grid state.
GetToolId(self)¶Returns id of the tool bar item that represents this page on wx.propgrid.PropertyGridManager’s wx.ToolBar.
int
Init(self)¶Do any member initialization in this method.
Note
Called every time the page is added into a manager.
You can add properties to the page here.
IsHandlingAllEvents(self)¶Return False here to indicate unhandled events should be propagated to manager’s parent, as normal.
bool
OnShow(self)¶Called every time page is about to be shown.
Useful, for instance, creating properties just-in-time.
RefreshProperty(self, p)¶Refreshes given property on page.
p (wx.propgrid.PGProperty) –
SetSplitterPosition(self, splitterPos, col=0)¶Sets splitter position on page.
splitterPos (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.
SplitterPosition¶StatePtr¶See GetStatePtr