1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.agw.persist.persist_handlers
.. highlight:: python
.. _wx.lib.agw.persist.persist_handlers.ListBoxHandler:
==========================================================================================================================================
|phoenix_title| **wx.lib.agw.persist.persist_handlers.ListBoxHandler**
==========================================================================================================================================
Supports saving/restoring selected items in :class:`ListBox`, :class:`ListCtrl`, :class:`ListView`,
:class:`VListBox`, :class:`html.HtmlListBox`, :class:`html.SimpleHtmlListBox`, :class:`adv.EditableListBox`.
This class handles the following wxPython widgets:
- :class:`ListBox`;
- :class:`ListCtrl` (only for selected items. For column sizes see :class:`ListCtrlHandler`);
- :class:`ListView` (only for selected items. For column sizes see :class:`ListCtrlHandler`);
- :class:`VListBox`;
- :class:`html.HtmlListBox`;
- :class:`html.SimpleHtmlListBox`;
- :class:`adv.EditableListBox`.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>ListBoxHandler</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.agw.persist.persist_handlers.ListBoxHandler_inheritance.png" alt="Inheritance diagram of ListBoxHandler" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.agw.persist.persist_handlers.AbstractHandler.html" title="wx.lib.agw.persist.persist_handlers.AbstractHandler" alt="" coords="5,5,352,35"/> <area shape="rect" id="node2" href="wx.lib.agw.persist.persist_handlers.ListBoxHandler.html" title="wx.lib.agw.persist.persist_handlers.ListBoxHandler" alt="" coords="9,83,348,112"/> </map>
</p>
|
|sub_classes| Known Subclasses
==============================
:class:`wx.lib.agw.persist.persist_handlers.CheckListBoxHandler`, :class:`wx.lib.agw.persist.persist_handlers.ListCtrlHandler`
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.agw.persist.persist_handlers.AbstractHandler`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.agw.persist.persist_handlers.ListBoxHandler.__init__`
:meth:`~wx.lib.agw.persist.persist_handlers.ListBoxHandler.GetKind`
:meth:`~wx.lib.agw.persist.persist_handlers.ListBoxHandler.GetSelections` Returns a list of selected items for :class:`ListBox`, :class:`ListCtrl`, :class:`ListView`,
:meth:`~wx.lib.agw.persist.persist_handlers.ListBoxHandler.Restore`
:meth:`~wx.lib.agw.persist.persist_handlers.ListBoxHandler.Save`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: ListBoxHandler(AbstractHandler)
Supports saving/restoring selected items in :class:`ListBox`, :class:`ListCtrl`, :class:`ListView`,
:class:`VListBox`, :class:`html.HtmlListBox`, :class:`html.SimpleHtmlListBox`, :class:`adv.EditableListBox`.
This class handles the following wxPython widgets:
- :class:`ListBox`;
- :class:`ListCtrl` (only for selected items. For column sizes see :class:`ListCtrlHandler`);
- :class:`ListView` (only for selected items. For column sizes see :class:`ListCtrlHandler`);
- :class:`VListBox`;
- :class:`html.HtmlListBox`;
- :class:`html.SimpleHtmlListBox`;
- :class:`adv.EditableListBox`.
.. method:: __init__(self, pObject)
.. method:: GetKind(self)
.. method:: GetSelections(self, listBox)
Returns a list of selected items for :class:`ListBox`, :class:`ListCtrl`, :class:`ListView`,
:class:`VListBox`, :class:`html.HtmlListBox`, :class:`html.SimpleHtmlListBox`, :class:`adv.EditableListBox`.
:param `listBox`: an instance of :class:`ListBox`, :class:`ListCtrl`, :class:`ListView`,
:class:`VListBox`, :class:`html.HtmlListBox`, :class:`html.SimpleHtmlListBox`, :class:`adv.EditableListBox`..
.. method:: Restore(self)
.. method:: Save(self)
|