phoenix_title wx.lib.agw.persist.persist_handlers.ListBoxHandler

Supports saving/restoring selected items in ListBox, ListCtrl, ListView, VListBox, html.HtmlListBox, html.SimpleHtmlListBox, adv.EditableListBox.

This class handles the following wxPython widgets:

  • ListBox;

  • ListCtrl (only for selected items. For column sizes see ListCtrlHandler);

  • ListView (only for selected items. For column sizes see ListCtrlHandler);

  • VListBox;

  • html.HtmlListBox;

  • html.SimpleHtmlListBox;

  • adv.EditableListBox.


class_hierarchy Class Hierarchy

Inheritance diagram for class ListBoxHandler:

sub_classes Known Subclasses

wx.lib.agw.persist.persist_handlers.CheckListBoxHandler, wx.lib.agw.persist.persist_handlers.ListCtrlHandler


super_classes Known Superclasses

wx.lib.agw.persist.persist_handlers.AbstractHandler


method_summary Methods Summary

__init__

Default class constructor.

GetKind

Returns a short and meaningful string description of your widget.

GetSelections

Returns a list of selected items for ListBox, ListCtrl, ListView,

Restore

Restores the widget’s settings by calling PersistentObject.RestoreValue(), which in

Save

Saves the widget’s settings by calling PersistentObject.SaveValue(), which in


api Class API

class ListBoxHandler(AbstractHandler)

Supports saving/restoring selected items in ListBox, ListCtrl, ListView, VListBox, html.HtmlListBox, html.SimpleHtmlListBox, adv.EditableListBox.

This class handles the following wxPython widgets:

  • ListBox;

  • ListCtrl (only for selected items. For column sizes see ListCtrlHandler);

  • ListView (only for selected items. For column sizes see ListCtrlHandler);

  • VListBox;

  • html.HtmlListBox;

  • html.SimpleHtmlListBox;

  • adv.EditableListBox.


Methods

__init__(self, pObject)

Default class constructor.

Parameters:

pObject – a PersistentObject containing information about the persistent widget.



GetKind(self)

Returns a short and meaningful string description of your widget.

Note

This method must be overridden in derived classes.



GetSelections(self, listBox)

Returns a list of selected items for ListBox, ListCtrl, ListView, VListBox, html.HtmlListBox, html.SimpleHtmlListBox, adv.EditableListBox.

Parameters:

listBox – an instance of ListBox, ListCtrl, ListView, VListBox, html.HtmlListBox, html.SimpleHtmlListBox, adv.EditableListBox..



Restore(self)

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(self)

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

Note

This method must be overridden in derived classes.