This page contains the reference documentation for all the Persistent handlers
This module contains different classes which handle different kind of saving/restoring actions depending on the widget kind.
Returns a tuple of 7 wx.Font attributes from the font input parameter.
Parameter: | font – a wx.Font instance. |
---|
Finds a suitable handler for the input Persistent Object depending on the widget kind.
Parameter: | pObject – an instance of PersistentObject class. |
---|
Base class for persistent windows, uses the window name as persistent name by default.
Note
This is an abstract class. If you wish to add another (custom) handler for your widgets, you should derive from AbstractHandler and override the Save, Restore and GetKind methods.
Default class constructor.
Parameter: | pObject – a PersistentObject containing information about the persistent widget. |
---|
Returns a short and meaningful string description of your widget.
Note
This method must be overridden in derived classes.
Restores the widget’s settings by calling PersistentObject.RestoreValue, which in turns calls PersistenceManager.RestoreValue.
Note
This method must be overridden in derived classes.
Saves the widget’s settings by calling PersistentObject.SaveValue, which in turns calls PersistenceManager.SaveValue.
Note
This method must be overridden in derived classes.
Inheritance Diagram:
Class Documentation:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring book control selection.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.calendar.CalendarCtrl date.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.CheckBox state.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring checked and selected items in wx.CheckListBox.
This class handles the following wxPython widgets:
See also
Inheritance Diagram:
Class Documentation:
Supports saving/restoring wx.Choice, wx.ComboBox and wx.combo.OwnerDrawnComboBox selection.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.MultiChoiceDialog/wx.SingleChoiceDialog choices.
This class handles the following wxPython widgets:
See also
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.CollapsiblePane state.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.ColourDialog data (colour, custom colours and full choice in the dialog).
This class handles the following wxPython widgets:
See also
Warning
as of PersistentControls version 0.1, support for saving/restoring colour dialog data is still on the TODO list.
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.ColourPickerCtrl/wx.lib.colourselect.ColourSelect colour.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.DatePickerCtrl/wx.GenericDatePickerCtrl date.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.DirDialog/wx.FileDialog path.
This class handles the following wxPython widgets:
See also
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.FilePickerCtrl/wx.DirPickerCtrl path.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.FileHistory list of file names.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.FindReplaceDialog data (search string, replace string and flags).
This class handles the following wxPython widgets:
See also
Warning
as of PersistentControls version 0.1, support for saving/restoring find and replace dialog data is still on the TODO list.
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.FontDialog data (effects, symbols, colour, font, help).
This class handles the following wxPython widgets:
See also
Warning
as of PersistentControls version 0.1, support for saving/restoring font dialog data is still on the TODO list.
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.FontPicker font.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring selected items in wx.ListBox, wx.ListCtrl, wx.ListView, wx.VListBox, wx.HtmlListBox, wx.SimpleHtmlListBox, wx.gizmos.EditableListBox.
This class handles the following wxPython widgets:
Returns a list of selected items for wx.ListCtrl, wx.ListView, wx.VListBox, wx.HtmlListBox, wx.SimpleHtmlListBox, wx.gizmos.EditableListBox.
Parameter: | listBox – an instance of wx.ListCtrl, wx.ListView, wx.VListBox, wx.HtmlListBox, wx.SimpleHtmlListBox, wx.gizmos.EditableListBox. |
---|
Inheritance Diagram:
Class Documentation:
Supports saving/restoring selected items and column sizes in wx.ListCtrl.
This class handles the following wxPython widgets:
See also
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.media.MediaCtrl movie position, volume and playback rate.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring the wx.MenuBar/wx.lib.agw.flatmenu.FlatMenuBar items state.
This class handles the following wxPython widgets:
Warning
using this handler for wx.lib.agw.flatmenu.FlatMenuBar requires SVN version 62646 of FlatMenu.
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.RadioBox state.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.RadioButton state.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.ScrolledWindow/wx.lib.scrolledpanel.ScrolledPanel scroll position.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.Slider/wx.lib.agw.KnobCtrl thumb position.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.SpinButton/wx.SpinCtrl value.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.SplitterWindow splitter position.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring window position and size as well as maximized/iconized/restore state for toplevel windows.
This class handles the following wxPython widgets:
In addition, if the toplevel window has an associated AuiManager (whether it is wx.aui.AuiManager or wx.lib.agw.aui.AuiManager and PersistenceManager has the PM_SAVE_RESTORE_AUI_PERSPECTIVES style set (the default), this class will also save and restore AUI perspectives using the underlying AUIHandler class.
See also
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.TextCtrl entered string.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.TextEntryDialog string.
This class handles the following wxPython widgets:
See also
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.ToggleButton and friends state.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring the wx.lib.agw.aui.AuiToolBar items state.
This class handles the following wxPython widgets:
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.TreeCtrl expansion state, selections and checked items state (meaningful only for CustomTreeCtrl).
This class handles the following wxPython widgets:
Returns a list of checked items. Checked items are coded as determined by the result of GetItemIdentity(item).
Note
This is meaningful only for wx.lib.agw.customtreectrl.CustomTreeCtrl and wx.lib.agw.hypertreelist.HyperTreeList.
Returns the checked/unchecked state of the children of a tree item.
Parameter: | item – a wx.lib.agw.customtreectrl.CustomTreeCtrl item. |
---|
Returns the checked/unchecked state of a tree item.
Parameter: | item – a wx.lib.agw.customtreectrl.CustomTreeCtrl item. |
---|
Returns the expansion state of the children of a tree item.
Parameter: | item – a wx.TreeCtrl item or a wx.lib.agw.customtreectrl.CustomTreeCtrl item. |
---|
Returns the expansion state of a tree item.
Parameter: | item – a wx.TreeCtrl item or a wx.lib.agw.customtreectrl.CustomTreeCtrl item. |
---|
Return the index of item.
Parameter: | item – a wx.TreeCtrl item or a wx.lib.agw.customtreectrl.CustomTreeCtrl item; |
---|
Return the children of item as a list.
Parameters: |
|
---|
Return a hashable object that represents the identity of the item. By default this returns the position of the item in the tree. You may want to override this to return the item label (if you know that labels are unique and don’t change), or return something that represents the underlying domain object, e.g. a database key.
Parameter: | item – a wx.TreeCtrl item or a wx.lib.agw.customtreectrl.CustomTreeCtrl item; |
---|
Returns the selection state of the children of a tree item.
Parameter: | item – a wx.TreeCtrl item or a wx.lib.agw.customtreectrl.CustomTreeCtrl item. |
---|
Returns the selection state of a tree item.
Parameter: | item – a wx.TreeCtrl item or a wx.lib.agw.customtreectrl.CustomTreeCtrl item. |
---|
Checks all tree items whose identity, as determined by GetItemIdentity(item), is present in the list and unchecks all other tree items.
Parameter: | listOfCheckedItems – a list of checked wx.lib.agw.customtreectrl.CustomTreeCtrl items. |
---|
Note
This is meaningful only for wx.lib.agw.customtreectrl.CustomTreeCtrl and wx.lib.agw.hypertreelist.HyperTreeList.
Sets the checked/unchecked state of the children of a tree item.
Parameters: |
|
---|
Sets the checked/unchecked state of a tree item.
Parameters: |
|
---|
Expands all tree items whose identity, as determined by GetItemIdentity(item), is present in the list and collapses all other tree items.
Parameter: | listOfExpandedItems – a list of expanded wx.TreeCtrl or wx.lib.agw.customtreectrl.CustomTreeCtrl items. |
---|
Sets the expansion state of the children of a tree item (expanded or collapsed).
Parameters: |
|
---|
Sets the expansion state of a tree item (expanded or collapsed).
Parameters: |
|
---|
Sets the selection state of the children of a tree item.
Parameters: |
|
---|
Sets the selection state of a tree item.
Parameters: |
|
---|
Selects all tree items whose identity, as determined by GetItemIdentity(item), is present in the list and unselects all other tree items.
Parameter: | listOfSelectedItems – a list of selected wx.TreeCtrl or wx.lib.agw.customtreectrl.CustomTreeCtrl items. |
---|
Inheritance Diagram:
Class Documentation:
Supports saving/restoring a wx.gizmos.TreeListCtrl/wx.lib.agw.hypertreelist expansion state, selections, column widths and checked items state (meaningful only for HyperTreeList).
This class handles the following wxPython widgets:
See also
Inheritance Diagram:
Class Documentation:
Supports saving/restoring open tree branches.
This class handles the following wxPython widgets:
See also