summaryrefslogtreecommitdiff
path: root/lib/wx/doc/src/wxDirDialog.xml
blob: d0cb38c906891ce3c624e0974ad220b2539f4a9c (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
89
90
91
92
93
<?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>wxDirDialog</title>
</header>
<module>wxDirDialog</module>
<modulesummary>Functions for wxDirDialog class</modulesummary>
<description><p>This class represents the directory chooser dialog.
      </p><p>Styles</p><p>This class supports the following styles:
      </p><p>Note: This flag cannot be used with the <c>wxDD_MULTIPLE</c> style. 
      </p><p>Remark:  MacOS 10.11+ does not display a title bar on the dialog. Use <seemfa marker="#setMessage/2"><c>setMessage/2</c></seemfa> to change the string displayed to the user at the top of the dialog after creation. The <seemfa marker="wxTopLevelWindow#setTitle/2"><c>wxTopLevelWindow:setTitle/2</c></seemfa> method is provided for compatibility with pre-10.11 MacOS versions that do still support displaying the title bar.
      </p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_cmndlg.html#overview_cmndlg_dir">Overview cmndlg</url>, <seeerl marker="wxFileDialog"><c>wxFileDialog</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_dir_dialog.html">wxDirDialog</url></p>
  </description>
<datatypes><datatype><name name="wxDirDialog"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>new/2</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>Constructor. </fsummary>
    <desc><p>Constructor. 
      </p><p>Use <seemfa marker="wxDialog#showModal/1"><c>wxDialog:showModal/1</c></seemfa> to show the dialog.
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor. </fsummary>
    <desc><p>Destructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPath" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the default or user-selected path. </fsummary>
    <desc><p>Returns the default or user-selected path. 
      </p><p>Note: This function can't be used with dialogs which have the <c>wxDD_MULTIPLE</c> style, use <c>GetPaths()</c> (not implemented in wx) instead. 
      </p></desc>
  </func>
  
  <func>
    <name name="getMessage" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the message that will be displayed on the dialog. </fsummary>
    <desc><p>Returns the message that will be displayed on the dialog. 
      </p></desc>
  </func>
  
  <func>
    <name name="setMessage" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the message that will be displayed on the dialog. </fsummary>
    <desc><p>Sets the message that will be displayed on the dialog. 
      </p></desc>
  </func>
  
  <func>
    <name name="setPath" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the default path. </fsummary>
    <desc><p>Sets the default path. 
      </p></desc>
  </func>
  </funcs>
</erlref>