1wxCheckListBox(3)          Erlang Module Definition          wxCheckListBox(3)
2
3
4

NAME

6       wxCheckListBox - Functions for wxCheckListBox class
7

DESCRIPTION

9       A wxCheckListBox is like a wxListBox, but allows items to be checked or
10       unchecked.
11
12       When using this class under Windows wxWidgets  must  be  compiled  with
13       wxUSE_OWNER_DRAWN set to 1.
14
15       See: wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
16
17       This  class  is  derived (and can use functions) from: wxListBox wxCon‐
18       trolWithItems wxControl wxWindow wxEvtHandler
19
20       wxWidgets docs: wxCheckListBox
21

EVENTS

23       Event types emitted from this class: command_checklistbox_toggled
24

DATA TYPES

26       wxCheckListBox() = wx:wx_object()
27

EXPORTS

29       new() -> wxCheckListBox()
30
31              Default constructor.
32
33       new(Parent, Id) -> wxCheckListBox()
34
35              Types:
36
37                 Parent = wxWindow:wxWindow()
38                 Id = integer()
39
40       new(Parent, Id, Options :: [Option]) -> wxCheckListBox()
41
42              Types:
43
44                 Parent = wxWindow:wxWindow()
45                 Id = integer()
46                 Option =
47                     {pos, {X :: integer(), Y :: integer()}} |
48                     {size, {W :: integer(), H :: integer()}} |
49                     {choices, [unicode:chardata()]} |
50                     {style, integer()} |
51                     {validator, wx:wx_object()}
52
53              Constructor, creating and showing a list box.
54
55       destroy(This :: wxCheckListBox()) -> ok
56
57              Destructor, destroying the list box.
58
59       check(This, Item) -> ok
60
61              Types:
62
63                 This = wxCheckListBox()
64                 Item = integer()
65
66       check(This, Item, Options :: [Option]) -> ok
67
68              Types:
69
70                 This = wxCheckListBox()
71                 Item = integer()
72                 Option = {check, boolean()}
73
74              Checks the given item.
75
76              Note that calling this method does not result in a  wxEVT_CHECK‐
77              LISTBOX event being emitted.
78
79       isChecked(This, Item) -> boolean()
80
81              Types:
82
83                 This = wxCheckListBox()
84                 Item = integer()
85
86              Returns true if the given item is checked, false otherwise.
87
88
89
90wxWidgets team.                     wx 2.1                   wxCheckListBox(3)