File: wx.lib.itemspicker.ItemsPicker.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (137 lines) | stat: -rw-r--r-- 5,382 bytes parent folder | download
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
132
133
134
135
136
137
.. 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.itemspicker

.. highlight:: python



.. _wx.lib.itemspicker.ItemsPicker:

==========================================================================================================================================
|phoenix_title|  **wx.lib.itemspicker.ItemsPicker**
==========================================================================================================================================

ItemsPicker is a widget that allows the user to form a set of picked
items out of a given list



|

|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>ItemsPicker</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.itemspicker.ItemsPicker_inheritance.png" alt="Inheritance diagram of ItemsPicker" 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.Panel.html" title="wx.Panel" alt="" coords="75,315,151,344"/> <area shape="rect" id="node7" href="wx.lib.itemspicker.ItemsPicker.html" title="wx.lib.itemspicker.ItemsPicker" alt="" coords="8,392,217,421"/> <area shape="rect" id="node2" href="wx.Window.html" title="wx.Window" alt="" coords="69,237,157,267"/> <area shape="rect" id="node3" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="5,5,107,35"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="57,83,168,112"/> <area shape="rect" id="node6" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="53,160,173,189"/> <area shape="rect" id="node5" href="wx.Object.html" title="wx.Object" alt="" coords="131,5,212,35"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`wx.Panel`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.itemspicker.ItemsPicker.__init__`                                 ItemsPicker(parent, choices = [], label = '', selectedLabel = '',
:meth:`~wx.lib.itemspicker.ItemsPicker.GetItems`                                 GetItems(self)=> items
:meth:`~wx.lib.itemspicker.ItemsPicker.GetSelections`                            GetSelections(self)=>items
:meth:`~wx.lib.itemspicker.ItemsPicker.SetItems`                                 SetItems(self, items)=> None
:meth:`~wx.lib.itemspicker.ItemsPicker.SetSelections`                            SetSelections(self, items)=>None
================================================================================ ================================================================================


|


|property_summary| Properties Summary
=====================================

================================================================================ ================================================================================
:attr:`~wx.lib.itemspicker.ItemsPicker.add_button_label`                         
:attr:`~wx.lib.itemspicker.ItemsPicker.Items`                                    See GetItems/SetItems
:attr:`~wx.lib.itemspicker.ItemsPicker.remove_button_label`                      
:attr:`~wx.lib.itemspicker.ItemsPicker.Selections`                               See GetSelections/SetSelections
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: ItemsPicker(wx.Panel)

   ItemsPicker is a widget that allows the user to form a set of picked
   items out of a given list

   .. method:: __init__(self, parent, id=wx.ID_ANY, choices = [], label = '', selectedLabel = '', ipStyle = IP_DEFAULT_STYLE, \*args, \*\*kw)

      ItemsPicker(parent, choices = [], label = '', selectedLabel = '',
                  ipStyle = IP_DEFAULT_STYLE)


   .. method:: GetItems(self)

      GetItems(self)=> items
      returns list of strings that the user can pick from


   .. method:: GetSelections(self)

      GetSelections(self)=>items
      returns list of strings that were selected


   .. method:: SetItems(self, items)

      SetItems(self, items)=> None
      items - Sequence of strings that the user can pick from


   .. method:: SetSelections(self, items)

      SetSelections(self, items)=>None
      items - Sequence of strings to be selected
      The items are displayed in the selection part of the widget


   .. attribute:: Items

      See GetItems/SetItems


   .. attribute:: Selections

      See GetSelections/SetSelections