Persistent Handlers

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.

Classes


Functions

CreateFont

persist_handlers.CreateFont(font)

Returns a tuple of 7 wx.Font attributes from the font input parameter.

Parameter:font – a wx.Font instance.

FindHandler

persist_handlers.FindHandler(pObject)

Finds a suitable handler for the input Persistent Object depending on the widget kind.

Parameter:pObject – an instance of PersistentObject class.

PyDate2wxDate

persist_handlers.PyDate2wxDate(date)

Transforms a datetime.date object into a wx.DateTime one.

Parameter:date – a datetime.date object.

wxDate2PyDate

persist_handlers.wxDate2PyDate(date)

Transforms a wx.DateTime object into a datetime.date one.

Parameter:date – a wx.DateTime object.

Classes

AbstractHandler

class persist_handlers.AbstractHandler(object)

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.

__init__(pObject)

Default class constructor.

Parameter:pObject

a PersistentObject containing information about the persistent widget.

GetKind()

Returns a short and meaningful string description of your widget.

Note

This method must be overridden in derived classes.

Restore()

Restores the widget’s settings by calling PersistentObject.RestoreValue, which in turns calls PersistenceManager.RestoreValue.

Note

This method must be overridden in derived classes.

Save()

Saves the widget’s settings by calling PersistentObject.SaveValue, which in turns calls PersistenceManager.SaveValue.

Note

This method must be overridden in derived classes.

AUIHandler

Inheritance Diagram:

digraph inheritance84a1dd1ffc {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.AUIHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AUIHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.AUIHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.AUIHandler(AbstractHandler)
Supports saving/restoring wx.aui.AuiManager and wx.lib.agw.aui.AuiManager perspectives.

BookHandler

Inheritance Diagram:

digraph inheritancef17574b2c1 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.BookHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.BookHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.BookHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.BookHandler(AbstractHandler)

Supports saving/restoring book control selection.

This class handles the following wxPython widgets:

  • wx.Toolbook;
  • wx.Choicebook;
  • wx.Listbook;
  • wx.Treebook (except for opened tree branches, see TreebookHandler for this);
  • wx.Notebook;
  • wx.aui.AuiNotebook;
  • wx.lib.agw.aui.AuiNotebook;
  • wx.lib.agw.flatnotebook.FlatNotebook;
  • wx.lib.agw.labelbook.LabelBook;
  • wx.lib.agw.labelbook.FlatImageBook.

CalendarCtrlHandler

Inheritance Diagram:

digraph inheritance93952a0060 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.CalendarCtrlHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.CalendarCtrlHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.CalendarCtrlHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.CalendarCtrlHandler(AbstractHandler)

Supports saving/restoring a wx.calendar.CalendarCtrl date.

This class handles the following wxPython widgets:

  • wx.lib.calendar.CalendarCtrl.

CheckBoxHandler

Inheritance Diagram:

digraph inheritance47e29189a2 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.CheckBoxHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.CheckBoxHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.CheckBoxHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.CheckBoxHandler(AbstractHandler)

Supports saving/restoring a wx.CheckBox state.

This class handles the following wxPython widgets:

  • wx.CheckBox.

CheckListBoxHandler

Inheritance Diagram:

digraph inheritanceaeaf4059b8 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.CheckListBoxHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.CheckListBoxHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.ListBoxHandler" -> "persist_handlers.CheckListBoxHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.ListBoxHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.ListBoxHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.ListBoxHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.CheckListBoxHandler(ListBoxHandler)

Supports saving/restoring checked and selected items in wx.CheckListBox.

This class handles the following wxPython widgets:

  • wx.CheckListBox (only for checked items. For selected items see ListBoxHandler).

See also

ListBoxHandler.

ChoiceComboHandler

Inheritance Diagram:

digraph inheritance57c23c8967 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.ChoiceComboHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.ChoiceComboHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.ChoiceComboHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.ChoiceComboHandler(AbstractHandler)

Supports saving/restoring wx.Choice, wx.ComboBox and wx.combo.OwnerDrawnComboBox selection.

This class handles the following wxPython widgets:

  • wx.Choice;
  • wx.ComboBox;
  • wx.combo.OwnerDrawnComboBox.

ChoiceDialogHandler

Inheritance Diagram:

digraph inheritance026406b866 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.ChoiceDialogHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.ChoiceDialogHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.TLWHandler" -> "persist_handlers.ChoiceDialogHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.TLWHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.TLWHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AUIHandler" -> "persist_handlers.TLWHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AUIHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AUIHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.AUIHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
}


Class Documentation:

class persist_handlers.ChoiceDialogHandler(TLWHandler)

Supports saving/restoring a wx.MultiChoiceDialog/wx.SingleChoiceDialog choices.

This class handles the following wxPython widgets:

  • wx.SingleChoiceDialog;
  • wx.MultiChoiceDialog.

See also

TLWHandler.

CollapsiblePaneHandler

Inheritance Diagram:

digraph inheritanced57554c469 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.CollapsiblePaneHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.CollapsiblePaneHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.CollapsiblePaneHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.CollapsiblePaneHandler(AbstractHandler)

Supports saving/restoring a wx.CollapsiblePane state.

This class handles the following wxPython widgets:

  • wx.CollapsiblePane.

ColourDialogHandler

Inheritance Diagram:

digraph inheritancef8373edd88 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.ColourDialogHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.ColourDialogHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.TLWHandler" -> "persist_handlers.ColourDialogHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.TLWHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.TLWHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AUIHandler" -> "persist_handlers.TLWHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AUIHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AUIHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.AUIHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
}


Class Documentation:

class persist_handlers.ColourDialogHandler(TLWHandler)

Supports saving/restoring a wx.ColourDialog data (colour, custom colours and full choice in the dialog).

This class handles the following wxPython widgets:

  • wx.ColourDialog;
  • wx.lib.agw.cubecolourdialog.CubeColourDialog.

See also

TLWHandler.

Warning

as of PersistentControls version 0.1, support for saving/restoring colour dialog data is still on the TODO list.

ColourPickerHandler

Inheritance Diagram:

digraph inheritanceeda7a1c1e7 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.ColourPickerHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.ColourPickerHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.ColourPickerHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.ColourPickerHandler(AbstractHandler)

Supports saving/restoring a wx.ColourPickerCtrl/wx.lib.colourselect.ColourSelect colour.

This class handles the following wxPython widgets:

  • wx.ColourPickerCtrl;
  • wx.lib.colourselect.ColourSelect.

DatePickerHandler

Inheritance Diagram:

digraph inheritanced07c5c1692 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.DatePickerHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.DatePickerHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.DatePickerHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.DatePickerHandler(AbstractHandler)

Supports saving/restoring a wx.DatePickerCtrl/wx.GenericDatePickerCtrl date.

This class handles the following wxPython widgets:

  • wx.DatePickerCtrl;
  • wx.GenericDatePickerCtrl.

FileDirDialogHandler

Inheritance Diagram:

digraph inheritancea078de339e {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.AUIHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AUIHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.AUIHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.TLWHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.TLWHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AUIHandler" -> "persist_handlers.TLWHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.FileDirDialogHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.FileDirDialogHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.TLWHandler" -> "persist_handlers.FileDirDialogHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.FileDirPickerHandler" -> "persist_handlers.FileDirDialogHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.FileDirPickerHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.FileDirPickerHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.FileDirPickerHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
}


Class Documentation:

class persist_handlers.FileDirDialogHandler(TLWHandler, FileDirPickerHandler)

Supports saving/restoring a wx.DirDialog/wx.FileDialog path.

This class handles the following wxPython widgets:

  • wx.DirDialog;
  • wx.FileDialog.

FileDirPickerHandler

Inheritance Diagram:

digraph inheritance6a5f2c31ea {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.FileDirPickerHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.FileDirPickerHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.FileDirPickerHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.FileDirPickerHandler(AbstractHandler)

Supports saving/restoring a wx.FilePickerCtrl/wx.DirPickerCtrl path.

This class handles the following wxPython widgets:

  • wx.FilePickerCtrl;
  • wx.DirPickerCtrl.

FileHistoryHandler

Inheritance Diagram:

digraph inheritancec8e0d948b3 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.FileHistoryHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.FileHistoryHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.FileHistoryHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.FileHistoryHandler(AbstractHandler)

Supports saving/restoring a wx.FileHistory list of file names.

This class handles the following wxPython widgets:

  • wx.FileHistory.

FindReplaceHandler

Inheritance Diagram:

digraph inheritance5a02b60473 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.FindReplaceHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.FindReplaceHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.TLWHandler" -> "persist_handlers.FindReplaceHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.TLWHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.TLWHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AUIHandler" -> "persist_handlers.TLWHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AUIHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AUIHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.AUIHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
}


Class Documentation:

class persist_handlers.FindReplaceHandler(TLWHandler)

Supports saving/restoring a wx.FindReplaceDialog data (search string, replace string and flags).

This class handles the following wxPython widgets:

  • wx.FindReplaceDialog.

See also

TLWHandler.

Warning

as of PersistentControls version 0.1, support for saving/restoring find and replace dialog data is still on the TODO list.

FontDialogHandler

Inheritance Diagram:

digraph inheritanceb01aca4952 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.FontDialogHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.FontDialogHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.TLWHandler" -> "persist_handlers.FontDialogHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.TLWHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.TLWHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AUIHandler" -> "persist_handlers.TLWHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AUIHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AUIHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.AUIHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
}


Class Documentation:

class persist_handlers.FontDialogHandler(TLWHandler)

Supports saving/restoring a wx.FontDialog data (effects, symbols, colour, font, help).

This class handles the following wxPython widgets:

  • wx.FontDialog.

See also

TLWHandler.

Warning

as of PersistentControls version 0.1, support for saving/restoring font dialog data is still on the TODO list.

FontPickerHandler

Inheritance Diagram:

digraph inheritance5904203628 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.FontPickerHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.FontPickerHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.FontPickerHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.FontPickerHandler(AbstractHandler)

Supports saving/restoring a wx.FontPicker font.

This class handles the following wxPython widgets:

  • wx.FontPickerCtrl.

ListBoxHandler

Inheritance Diagram:

digraph inheritance8230ed4e94 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.ListBoxHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.ListBoxHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.ListBoxHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.ListBoxHandler(AbstractHandler)

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:

  • wx.ListBox;
  • wx.ListCtrl (only for selected items. For column sizes see ListCtrlHandler);
  • wx.ListView (only for selected items. For column sizes see ListCtrlHandler);
  • wx.VListBox;
  • wx.HtmlListBox;
  • wx.SimpleHtmlListBox;
  • wx.gizmos.EditableListBox.
GetSelections(listBox)

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.

ListCtrlHandler

Inheritance Diagram:

digraph inheritance44a9b54e3f {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.ListCtrlHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.ListCtrlHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.ListBoxHandler" -> "persist_handlers.ListCtrlHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.ListBoxHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.ListBoxHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.ListBoxHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.ListCtrlHandler(ListBoxHandler)

Supports saving/restoring selected items and column sizes in wx.ListCtrl.

This class handles the following wxPython widgets:

  • wx.ListCtrl (only for column sizes. For selected items see ListBoxHandler);
  • wx.ListView (only for column sizes. For selected items see ListBoxHandler).

See also

ListBoxHandler.

MediaCtrlHandler

Inheritance Diagram:

digraph inheritance1cc6cd9cc9 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.MediaCtrlHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.MediaCtrlHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.MediaCtrlHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.MediaCtrlHandler(AbstractHandler)

Supports saving/restoring a wx.media.MediaCtrl movie position, volume and playback rate.

This class handles the following wxPython widgets:

  • wx.media.MediaCtrl.

MenuBarHandler

Inheritance Diagram:

digraph inheritance471657faed {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.MenuBarHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.MenuBarHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.MenuBarHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.MenuBarHandler(AbstractHandler)

Supports saving/restoring the wx.MenuBar/wx.lib.agw.flatmenu.FlatMenuBar items state.

This class handles the following wxPython widgets:

  • wx.MenuBar;
  • wx.lib.agw.flatmenu.FlatMenuBar.

Warning

using this handler for wx.lib.agw.flatmenu.FlatMenuBar requires SVN version 62646 of FlatMenu.

RadioBoxHandler

Inheritance Diagram:

digraph inheritancedc9f092762 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.RadioBoxHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.RadioBoxHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.RadioBoxHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.RadioBoxHandler(AbstractHandler)

Supports saving/restoring a wx.RadioBox state.

This class handles the following wxPython widgets:

  • wx.RadioBox.

RadioButtonHandler

Inheritance Diagram:

digraph inheritance8e1b71f322 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.RadioButtonHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.RadioButtonHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.RadioButtonHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.RadioButtonHandler(AbstractHandler)

Supports saving/restoring a wx.RadioButton state.

This class handles the following wxPython widgets:

  • wx.RadioButton.

ScrolledWindowHandler

Inheritance Diagram:

digraph inheritancef7f1ff1a09 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.ScrolledWindowHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.ScrolledWindowHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.ScrolledWindowHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.ScrolledWindowHandler(AbstractHandler)

Supports saving/restoring a wx.ScrolledWindow/wx.lib.scrolledpanel.ScrolledPanel scroll position.

This class handles the following wxPython widgets:

  • wx.ScrolledWindow;
  • wx.lib.scrolledpanel.ScrolledPanel.

SliderHandler

Inheritance Diagram:

digraph inheritance86f7ebfaea {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.SliderHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.SliderHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.SliderHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.SliderHandler(AbstractHandler)

Supports saving/restoring a wx.Slider/wx.lib.agw.KnobCtrl thumb position.

This class handles the following wxPython widgets:

  • wx.Slider;
  • wx.lib.agw.KnobCtrl.

SpinHandler

Inheritance Diagram:

digraph inheritance84c8be3e3a {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.SpinHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.SpinHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.SpinHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.SpinHandler(AbstractHandler)

Supports saving/restoring a wx.SpinButton/wx.SpinCtrl value.

This class handles the following wxPython widgets:

  • wx.SpinCtrl;
  • wx.SpinButton.

SplitterHandler

Inheritance Diagram:

digraph inheritance59b354b738 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.SplitterHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.SplitterHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.SplitterHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.SplitterHandler(AbstractHandler)

Supports saving/restoring a wx.SplitterWindow splitter position.

This class handles the following wxPython widgets:

  • wx.SplitterWindow.

TLWHandler

Inheritance Diagram:

digraph inheritance5fbfc26224 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.TLWHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.TLWHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AUIHandler" -> "persist_handlers.TLWHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AUIHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AUIHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.AUIHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.TLWHandler(AUIHandler)

Supports saving/restoring window position and size as well as maximized/iconized/restore state for toplevel windows.

This class handles the following wxPython widgets:

  • All wx.Frame derived classes;
  • All wx.Dialog derived classes.

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

AUIHandler.

TextCtrlHandler

Inheritance Diagram:

digraph inheritance0f966583ca {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.TextCtrlHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.TextCtrlHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.TextCtrlHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.TextCtrlHandler(AbstractHandler)

Supports saving/restoring a wx.TextCtrl entered string.

This class handles the following wxPython widgets:

  • wx.TextCtrl;
  • wx.SearchCtrl;
  • wx.lib.expando.ExpandoTextCtrl;
  • wx.lib.masked.TextCtrl;
  • wx.lib.masked.ComboBox;
  • wx.lib.masked.IpAddrCtrl;
  • wx.lib.masked.TimeCtrl;
  • wx.lib.masked.NumCtrl;

TextEntryHandler

Inheritance Diagram:

digraph inheritance1eda0a9501 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.AUIHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AUIHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.AUIHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.TextEntryHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.TextEntryHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.TLWHandler" -> "persist_handlers.TextEntryHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.TextCtrlHandler" -> "persist_handlers.TextEntryHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.TextCtrlHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.TextCtrlHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.TextCtrlHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.TLWHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.TLWHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AUIHandler" -> "persist_handlers.TLWHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
}


Class Documentation:

class persist_handlers.TextEntryHandler(TLWHandler, TextCtrlHandler)

Supports saving/restoring a wx.TextEntryDialog string.

This class handles the following wxPython widgets:

  • wx.TextEntryDialog;
  • wx.PasswordEntryDialog.

ToggleButtonHandler

Inheritance Diagram:

digraph inheritance0d7acbaa7a {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.ToggleButtonHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.ToggleButtonHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.ToggleButtonHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.ToggleButtonHandler(AbstractHandler)

Supports saving/restoring a wx.ToggleButton and friends state.

This class handles the following wxPython widgets:

  • wx.ToggleButton;
  • wx.lib.buttons.GenToggleButton;
  • wx.lib.buttons.GenBitmapToggleButton;
  • wx.lib.buttons.GenBitmapTextToggleButton;
  • wx.lib.agw.shapedbutton.SToggleButton;
  • wx.lib.agw.shapedbutton.SBitmapToggleButton;
  • wx.lib.agw.shapedbutton.SBitmapTextToggleButton.

ToolBarHandler

Inheritance Diagram:

digraph inheritance18db61b1d7 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.ToolBarHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.ToolBarHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.ToolBarHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.ToolBarHandler(AbstractHandler)

Supports saving/restoring the wx.lib.agw.aui.AuiToolBar items state.

This class handles the following wxPython widgets:

  • wx.lib.agw.aui.AuiToolBar.

TreeCtrlHandler

Inheritance Diagram:

digraph inheritance1e0e6ea6f2 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.TreeCtrlHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.TreeCtrlHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.TreeCtrlHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.TreeCtrlHandler(AbstractHandler)

Supports saving/restoring a wx.TreeCtrl expansion state, selections and checked items state (meaningful only for CustomTreeCtrl).

This class handles the following wxPython widgets:

  • wx.TreeCtrl;
  • wx.GenericDirCtrl;
  • wx.lib.agw.customtreectrl.CustomTreeCtrl.
GetCheckedState()

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.

GetCheckedStateOfChildren(item)

Returns the checked/unchecked state of the children of a tree item.

Parameter:item – a wx.lib.agw.customtreectrl.CustomTreeCtrl item.
GetCheckedStateOfItem(item)

Returns the checked/unchecked state of a tree item.

Parameter:item – a wx.lib.agw.customtreectrl.CustomTreeCtrl item.
GetExpansionState()
Returns list of expanded items. Expanded items are coded as determined by the result of GetItemIdentity(item).
GetExpansionStateOfChildren(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.
GetExpansionStateOfItem(item)

Returns the expansion state of a tree item.

Parameter:item – a wx.TreeCtrl item or a wx.lib.agw.customtreectrl.CustomTreeCtrl item.
GetIndexOfItem(item)

Return the index of item.

Parameter:item – a wx.TreeCtrl item or a wx.lib.agw.customtreectrl.CustomTreeCtrl item;
GetItemChildren(item=None, recursively=False)

Return the children of item as a list.

Parameters:
  • item – a wx.TreeCtrl item or a wx.lib.agw.customtreectrl.CustomTreeCtrl item;
  • recursively – whether to recurse into the item hierarchy or not.
GetItemIdentity(item)

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;
GetSelectionState()
Returns a list of selected items. Selected items are coded as determined by the result of GetItemIdentity(item).
GetSelectionStateOfChildren(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.
GetSelectionStateOfItem(item)

Returns the selection state of a tree item.

Parameter:item – a wx.TreeCtrl item or a wx.lib.agw.customtreectrl.CustomTreeCtrl item.
SetCheckedState(listOfCheckedItems)

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.

SetCheckedStateOfChildren(listOfCheckedItems, item)

Sets the checked/unchecked state of the children of a tree item.

Parameters:
  • listOfCheckedItems – a list of checked wx.lib.agw.customtreectrl.CustomTreeCtrl items;
  • item – a wx.lib.agw.customtreectrl.CustomTreeCtrl item.
SetCheckedStateOfItem(listOfCheckedItems, item)

Sets the checked/unchecked state of a tree item.

Parameters:
  • listOfCheckedItems – a list of checked wx.lib.agw.customtreectrl.CustomTreeCtrl items;
  • item – a wx.lib.agw.customtreectrl.CustomTreeCtrl item.
SetExpansionState(listOfExpandedItems)

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.
SetExpansionStateOfChildren(listOfExpandedItems, item)

Sets the expansion state of the children of a tree item (expanded or collapsed).

Parameters:
  • listOfExpandedItems – a list of expanded wx.TreeCtrl or wx.lib.agw.customtreectrl.CustomTreeCtrl items;
  • item – a wx.TreeCtrl item or a wx.lib.agw.customtreectrl.CustomTreeCtrl item.
SetExpansionStateOfItem(listOfExpandedItems, item)

Sets the expansion state of a tree item (expanded or collapsed).

Parameters:
  • listOfExpandedItems – a list of expanded wx.TreeCtrl or wx.lib.agw.customtreectrl.CustomTreeCtrl items;
  • item – a wx.TreeCtrl item or a wx.lib.agw.customtreectrl.CustomTreeCtrl item.
SetSelectedStateOfChildren(listOfSelectedItems, item)

Sets the selection state of the children of a tree item.

Parameters:
  • listOfSelectedItems – a list of selected wx.TreeCtrl or wx.lib.agw.customtreectrl.CustomTreeCtrl items;
  • item – a wx.TreeCtrl item or a wx.lib.agw.customtreectrl.CustomTreeCtrl item.
SetSelectedStateOfItem(listOfSelectedItems, item)

Sets the selection state of a tree item.

Parameters:
  • listOfSelectedItems – a list of selected wx.TreeCtrl or wx.lib.agw.customtreectrl.CustomTreeCtrl items;
  • item – a wx.TreeCtrl item or a wx.lib.agw.customtreectrl.CustomTreeCtrl item.
SetSelectionState(listOfSelectedItems)

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.

TreeListCtrlHandler

Inheritance Diagram:

digraph inheritance0643ac048d {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.TreeListCtrlHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.TreeListCtrlHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.TreeCtrlHandler" -> "persist_handlers.TreeListCtrlHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.TreeCtrlHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.TreeCtrlHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.TreeCtrlHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.TreeListCtrlHandler(TreeCtrlHandler)

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:

  • wx.gizmos.TreeListCtrl;
  • wx.lib.agw.hypertreelist.HyperTreeList.

See also

TreeCtrlHandler.

TreebookHandler

Inheritance Diagram:

digraph inheritance3b5a34a6b8 {
rankdir=LR;
fontsize=14;
ratio=compress;
size="8.0, 12.0";
  "persist_handlers.TreebookHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.TreebookHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.BookHandler" -> "persist_handlers.TreebookHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.BookHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.BookHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "persist_handlers.AbstractHandler" -> "persist_handlers.BookHandler" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "persist_handlers.AbstractHandler" [style="setlinewidth(0.5)",URL="#persist_handlers.AbstractHandler",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
}


Class Documentation:

class persist_handlers.TreebookHandler(BookHandler)

Supports saving/restoring open tree branches.

This class handles the following wxPython widgets:

  • wx.Treebook (except for page selection, see BookHandler for this).

See also

BookHandler.