Phoenix Logo

phoenix_title wx.CheckListBox

A wx.CheckListBox is like a wx.ListBox, but allows items to be checked or unchecked.

When using this class under Windows wxWidgets must be compiled with USE_OWNER_DRAWN set to 1.

events Events Emitted by this Class

Handlers bound for the following event types will receive a wx.CommandEvent parameter.


class_hierarchy Class Hierarchy

Inheritance diagram for class CheckListBox:


appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


sub_classes Known Subclasses

wx.RearrangeList


method_summary Methods Summary

__init__ Constructor, creating and showing a list box.
Check Checks the given item.
Create  
GetCheckedItems GetCheckedItems()
GetCheckedStrings GetCheckedStrings()
IsChecked Returns True if the given item is checked, False otherwise.
SetCheckedItems SetCheckedItems(indexes)
SetCheckedStrings SetCheckedStrings(strings)

property_summary Properties Summary

Checked See GetChecked and SetChecked
CheckedItems See GetCheckedItems and SetCheckedItems
CheckedStrings See GetCheckedStrings and SetCheckedStrings

api Class API



class wx.CheckListBox(ListBox)

Possible constructors:

CheckListBox(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
             choices=[], style=0, validator=DefaultValidator, name="listBox")

CheckListBox()

A CheckListBox is like a ListBox, but allows items to be checked or unchecked.


Methods



__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=”listBox”)

Constructor, creating and showing a list box.

Parameters:
  • parent (wx.Window) – Parent window. Must not be None.
  • id (wx.WindowID) – Window identifier. The value wx.ID_ANY indicates a default value.
  • pos (wx.Point) – Window position.
  • size (wx.Size) – Window size. If DefaultSize is specified then the window is sized appropriately.
  • choices (list of strings) – An array of strings with which to initialise the control.
  • style (long) – Window style. See wx.CheckListBox.
  • validator (wx.Validator) – Window validator.
  • name (string) – Window name.



__init__ (self)

Default constructor.





Check(self, item, check=True)

Checks the given item.

Note that calling this method does not result in a wxEVT_CHECKLISTBOX event being emitted.

Parameters:
  • item (int) – Index of item to check.
  • check (bool) – True if the item is to be checked, False otherwise.


Create(self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, choices=[], style=0, validator=DefaultValidator, name=ListBoxNameStr)
Parameters:
Return type:

bool



GetCheckedItems(self)

GetCheckedItems()

Return a sequence of integers corresponding to the checked items in the control, based on IsChecked.



GetCheckedStrings(self)

GetCheckedStrings()

Return a tuple of strings corresponding to the checked items of the control, based on GetChecked.



IsChecked(self, item)

Returns True if the given item is checked, False otherwise.

Parameters:item (int) – Index of item whose check status is to be returned.
Return type:bool


SetCheckedItems(self, indexes)

SetCheckedItems(indexes)

Sets the checked state of items if the index of the item is found in the indexes sequence.



SetCheckedStrings(self, strings)

SetCheckedStrings(strings)

Sets the checked state of items if the item’s string is found in the strings sequence.


Properties



Checked

See GetChecked and SetChecked



CheckedItems

See GetCheckedItems and SetCheckedItems



CheckedStrings

See GetCheckedStrings and SetCheckedStrings