.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 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

Inheritance diagram for class
ItemsPicker:
|
|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