summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxCheckListBox.xml
blob: 7615ef38037eec89e868c4af897d4e708c7ab870 (plain)
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
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

  </legalnotice>
  <title>wxCheckListBox</title>
</header>
<module>wxCheckListBox</module>
<modulesummary>Functions for wxCheckListBox class</modulesummary>
<description><p>A <seeerl marker="wxCheckListBox"><c>wxCheckListBox</c></seeerl> is like a <seeerl marker="wxListBox"><c>wxListBox</c></seeerl>, but allows items to be checked or unchecked.
      </p><p>When using this class under Windows wxWidgets must be compiled with wxUSE_OWNER_DRAWN set to 1.
      </p><p>See: <seeerl marker="wxListBox"><c>wxListBox</c></seeerl>, <seeerl marker="wxChoice"><c>wxChoice</c></seeerl>, <seeerl marker="wxComboBox"><c>wxComboBox</c></seeerl>, <seeerl marker="wxListCtrl"><c>wxListCtrl</c></seeerl>, <seeerl marker="wxCommandEvent"><c>wxCommandEvent</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxListBox"><c>wxListBox</c></seeerl> <seeerl marker="wxControlWithItems"><c>wxControlWithItems</c></seeerl> <seeerl marker="wxControl"><c>wxControl</c></seeerl> <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_check_list_box.html">wxCheckListBox</url></p>
  </description><section><title>Events</title><p>Event types emitted from this class: <seeerl marker="wxCommandEvent"><c>command_checklistbox_toggled</c></seeerl></p></section>
<datatypes><datatype><name name="wxCheckListBox"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default constructor. </fsummary>
    <desc><p>Default constructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>new/3</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="3" clause_i="1" since=""/>
    <fsummary>Constructor, creating and showing a list box. </fsummary>
    <desc><p>Constructor, creating and showing a list box. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor, destroying the list box. </fsummary>
    <desc><p>Destructor, destroying the list box. 
      </p></desc>
  </func>
  
  <func>
    <name name="check" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>check/3</c></fsummary>
  </func>
  
  <func>
    <name name="check" arity="3" clause_i="1" since=""/>
    <fsummary>Checks the given item. </fsummary>
    <desc><p>Checks the given item. 
      </p><p>Note that calling this method does not result in a <c>wxEVT_CHECKLISTBOX</c> event being emitted.
      </p></desc>
  </func>
  
  <func>
    <name name="isChecked" arity="2" clause_i="1" since=""/>
    <fsummary>Returns true if the given item is checked, false otherwise. </fsummary>
    <desc><p>Returns true if the given item is checked, false otherwise. 
      </p></desc>
  </func>
  </funcs>
</erlref>