summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxSingleChoiceDialog.xml
blob: 37516a111537492e265ea19eea4b5db64c4b0823 (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
<?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>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxSingleChoiceDialog</title>
</header>
<module>wxSingleChoiceDialog</module>
<modulesummary>Functions for wxSingleChoiceDialog class</modulesummary>
<description><p>This class represents a dialog that shows a list of strings, and allows the user to select one. Double-clicking on a list item is equivalent to single-clicking and then pressing OK.
      </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_singlechoice">Overview cmndlg</url>, <seeerl marker="wxMultiChoiceDialog"><c>wxMultiChoiceDialog</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_single_choice_dialog.html">wxSingleChoiceDialog</url></p>
  </description>
<datatypes><datatype><name name="wxSingleChoiceDialog"/></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 and optional client data. </fsummary>
    <desc><p>Constructor, taking an array of <c>wxString</c> (not implemented in wx) choices and optional client data. 
      </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="getSelection" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the index of selected item. </fsummary>
    <desc><p>Returns the index of selected item. 
      </p></desc>
  </func>
  
  <func>
    <name name="getStringSelection" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the selected string. </fsummary>
    <desc><p>Returns the selected string. 
      </p></desc>
  </func>
  
  <func>
    <name name="setSelection" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the index of the initially selected item. </fsummary>
    <desc><p>Sets the index of the initially selected item. 
      </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>