wx.propgrid.PropertyGridManager¶

wx.propgrid.PropertyGridManager is an efficient multi-page version of wx.propgrid.PropertyGrid, which can optionally have toolbar for mode and page selection, a help text box, and a header.

wx.propgrid.PropertyGridManager inherits from wx.propgrid.PropertyGridInterface, and as such it has most property manipulation functions. However, only some of them affect properties on all pages (e.g. GetPropertyByName and ExpandAll while some (e.g. Append only apply to the currently selected page.

To operate explicitly on properties on specific page, use wx.propgrid.PropertyGridManager.GetPage to obtain pointer to page’s wx.propgrid.PropertyGridPage object.

Visual methods, such as SetCellBackgroundColour() are only available in wx.propgrid.PropertyGrid. Use wx.propgrid.PropertyGridManager.GetGrid to obtain pointer to it.

Non-virtual iterators will not work in wx.propgrid.PropertyGridManager. Instead, you must acquire the internal grid ( GetGrid) or wx.propgrid.PropertyGridPage object ( GetPage).

wx.propgrid.PropertyGridManager constructor has exact same format as wx.propgrid.PropertyGrid constructor, and basically accepts same extra window style flags (albeit also has some extra ones).

Here’s some example code for creating and populating a wx.propgrid.PropertyGridManager:

pgMan = wx.propgrid.PropertyGridManager(
    parent,
    PGID,
    # These and other similar styles are automatically
    # passed to the embedded wx.PropertyGrid.
    style = wx.PG_BOLD_MODIFIED|wx.PG_SPLITTER_AUTO_CENTER|
    # Include toolbar.
    wx.PG_TOOLBAR |
    # Include description box.
    wx.PG_DESCRIPTION |
    # Include compactor.
    wx.PG_COMPACTOR |
    # Plus defaults.
    wx.PGMAN_DEFAULT_STYLE
  )

page = pgMan.AddPage("First Page")
page.Append(wx.propgrid.PropertyCategory("Category A1"))
page.Append(wx.propgrid.IntProperty("Number", wx.propgrid.PG_LABEL, 1))
page.Append(wx.propgrid.ColourProperty("Colour",wx.propgrid.PG_LABEL, wx.WHITE))

page = pgMan.AddPage("Second Page")
page.Append("Text", wx.propgrid.PG_LABEL, "(no text)")
page.Append(wx.propgrid.FontProperty("Font",wx.propgrid.PG_LABEL))

# Display a header above the grid
pgMan.ShowHeader()

Window Styles¶

See PropertyGrid Window Styles.

Event Handling¶

See PropertyGrid Event Handling for more information.

Class Hierarchy¶

Inheritance diagram for class PropertyGridManager:

Methods Summary¶

`__init__`	Two step constructor.
`AddPage`	Creates new property page.
`Clear`	Deletes all properties and all pages.
`ClearPage`	Deletes all properties on given page.
`CommitChangesFromEditor`	Forces updating the value of property from the editor control.
`Create`	Two step creation.
`CreatePropertyGrid`	Creates property grid for the manager.
`EnableCategories`	Enables or disables (shows/hides) categories according to parameter enable.
`EnsureVisible`	Selects page, scrolls and/or expands items to ensure that the given item is visible.
`GetClassDefaultAttributes`
`GetColumnCount`	Returns number of columns on given page.
`GetCurrentPage`	Returns currently selected page.
`GetDescBoxHeight`	Returns height of the description text box.
`GetGrid`	Returns pointer to the contained wx.propgrid.PropertyGrid.
`GetPage`	Returns page object for given page index.
`GetPageByName`	Returns index for a page name.
`GetPageByState`	Returns index for a relevant propertygrid state.
`GetPageCount`	Returns number of managed pages.
`GetPageName`	Returns name of given page.
`GetPageRoot`	Returns “root property” of the given page.
`GetSelectedPage`	Returns index to currently selected page.
`GetSelectedProperty`	Alias for `GetSelection` .
`GetSelection`	Shortcut for `GetGrid` . `GetSelection` .
`GetToolBar`	Returns a pointer to the toolbar currently associated with the wx.propgrid.PropertyGridManager (if any).
`GetVIterator`	Similar to `GetIterator` , but instead returns wx.propgrid.PGVIterator instance, which can be useful for forward-iterating through arbitrary property containers.
`InsertPage`	Creates new property page.
`IsAnyModified`	Returns `True` if any property on any page has been modified by the user.
`IsPageModified`	Returns `True` if any property on given page has been modified by the user.
`IsPropertySelected`	Returns `True` if property is selected.
`RemovePage`	Removes a page.
`SelectPage`	Select and displays a given page.
`SelectProperty`	Select a property.
`SetColumnCount`	Sets number of columns on given page (default is current page).
`SetColumnTitle`	Sets a column title.
`SetDescBoxHeight`	Sets y coordinate of the description box splitter.
`SetDescription`	Sets label and text in description box.
`SetPageSplitterLeft`	Moves splitter as left as possible on an individual page, while still allowing all labels to be shown in full.
`SetPageSplitterPosition`	Sets splitter position on individual page.
`SetSplitterLeft`	Moves splitter as left as possible, while still allowing all labels to be shown in full.
`SetSplitterPosition`	Sets splitter position for all pages.
`ShowHeader`	Show or hide the property grid header control.

Properties Summary¶

`ColumnCount`	See `GetColumnCount` and `SetColumnCount`
`CurrentPage`	See `GetCurrentPage`
`DescBoxHeight`	See `GetDescBoxHeight` and `SetDescBoxHeight`
`Grid`	See `GetGrid`
`PageCount`	See `GetPageCount`
`SelectedPage`	See `GetSelectedPage`
`SelectedProperty`	See `GetSelectedProperty`
`Selection`	See `GetSelection`
`ToolBar`	See `GetToolBar`

Class API¶

class wx.propgrid.PropertyGridManager(Panel, PropertyGridInterface)¶

Possible constructors:

PropertyGridManager()

PropertyGridManager(parent, id=ID_ANY, pos=DefaultPosition,
                    size=DefaultSize, style=PGMAN_DEFAULT_STYLE,
                    name=PropertyGridManagerNameStr)

PropertyGridManager is an efficient multi-page version of PropertyGrid, which can optionally have toolbar for mode and page selection, a help text box, and a header.

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.PropertyGridManager.

__init__ (self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=PGMAN_DEFAULT_STYLE, name=PropertyGridManagerNameStr)

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

Properties¶

ColumnCount¶: See GetColumnCount and SetColumnCount

CurrentPage¶: See GetCurrentPage

DescBoxHeight¶: See GetDescBoxHeight and SetDescBoxHeight

Grid¶: See GetGrid

PageCount¶: See GetPageCount

SelectedPage¶: See GetSelectedPage

SelectedProperty¶: See GetSelectedProperty

Selection¶: See GetSelection

ToolBar¶: See GetToolBar

Navigation