summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxMultiChoiceDialog.xml
blob: 6a4b133d71d3c2a1ce2afb3bb620830d15ebd0d9 (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
<?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>wxMultiChoiceDialog</title>
</header>
<module>wxMultiChoiceDialog</module>
<modulesummary>Functions for wxMultiChoiceDialog class</modulesummary>
<description><p>This class represents a dialog that shows a list of strings, and allows the user to select one or more.
      </p><p>Styles</p><p>This class supports the following styles:
      </p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_cmndlg.html#overview_cmndlg_multichoice">Overview cmndlg</url>, <seeerl marker="wxSingleChoiceDialog"><c>wxSingleChoiceDialog</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxDialog"><c>wxDialog</c></seeerl> <seeerl marker="wxTopLevelWindow"><c>wxTopLevelWindow</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_multi_choice_dialog.html">wxMultiChoiceDialog</url></p>
  </description>
<datatypes><datatype><name name="wxMultiChoiceDialog"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="4" clause_i="1" since=""/>
    <fsummary>See: <c>new/5</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="5" clause_i="1" since=""/>
    <fsummary>Constructor taking an array of <c>wxString</c> (not implemented in wx) choices. </fsummary>
    <desc><p>Constructor taking an array of <c>wxString</c> (not implemented in wx) choices. 
      </p><p>Remark: Use <seemfa marker="wxDialog#showModal/1"><c>wxDialog:showModal/1</c></seemfa> to show the dialog. 
      </p></desc>
  </func>
  
  <func>
    <name name="getSelections" arity="1" clause_i="1" since=""/>
    <fsummary>Returns array with indexes of selected items. </fsummary>
    <desc><p>Returns array with indexes of selected items. 
      </p></desc>
  </func>
  
  <func>
    <name name="setSelections" arity="2" clause_i="1" since=""/>
    <fsummary>Sets selected items from the array of selected items' indexes. </fsummary>
    <desc><p>Sets selected items from the array of selected items' indexes. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor</fsummary>
    <desc><p>Destroys the object.</p></desc>
  </func>
  </funcs>
</erlref>