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

NAME

6       wxDirDialog - Functions for wxDirDialog class
7

DESCRIPTION

9       This class represents the directory chooser dialog.
10
11       Styles
12
13       This class supports the following styles:
14
15       Note: This flag cannot be used with the wxDD_MULTIPLE style.
16
17       Remark:  MacOS  10.11+  does not display a title bar on the dialog. Use
18       setMessage/2 to change the string displayed to the user at the  top  of
19       the  dialog  after  creation. The wxTopLevelWindow:setTitle/2 method is
20       provided for compatibility with pre-10.11 MacOS versions that do  still
21       support displaying the title bar.
22
23       See: Overview cmndlg, wxFileDialog
24
25       This  class  is  derived  (and  can use functions) from: wxDialog wxTo‐
26       pLevelWindow wxWindow wxEvtHandler
27
28       wxWidgets docs: wxDirDialog
29

DATA TYPES

31       wxDirDialog() = wx:wx_object()
32

EXPORTS

34       new(Parent) -> wxDirDialog()
35
36              Types:
37
38                 Parent = wxWindow:wxWindow()
39
40       new(Parent, Options :: [Option]) -> wxDirDialog()
41
42              Types:
43
44                 Parent = wxWindow:wxWindow()
45                 Option =
46                     {title, unicode:chardata()} |
47                     {defaultPath, unicode:chardata()} |
48                     {style, integer()} |
49                     {pos, {X :: integer(), Y :: integer()}} |
50                     {sz, {W :: integer(), H :: integer()}}
51
52              Constructor.
53
54              Use wxDialog:showModal/1 to show the dialog.
55
56       destroy(This :: wxDirDialog()) -> ok
57
58              Destructor.
59
60       getPath(This) -> unicode:charlist()
61
62              Types:
63
64                 This = wxDirDialog()
65
66              Returns the default or user-selected path.
67
68              Note: This function can't be used with dialogs  which  have  the
69              wxDD_MULTIPLE  style, use GetPaths() (not implemented in wx) in‐
70              stead.
71
72       getMessage(This) -> unicode:charlist()
73
74              Types:
75
76                 This = wxDirDialog()
77
78              Returns the message that will be displayed on the dialog.
79
80       setMessage(This, Message) -> ok
81
82              Types:
83
84                 This = wxDirDialog()
85                 Message = unicode:chardata()
86
87              Sets the message that will be displayed on the dialog.
88
89       setPath(This, Path) -> ok
90
91              Types:
92
93                 This = wxDirDialog()
94                 Path = unicode:chardata()
95
96              Sets the default path.
97
98
99
100wxWidgets team.                    wx 2.1.4                     wxDirDialog(3)