fixed wxDirDialog ctor docs
[wxWidgets.git] / docs / latex / wx / dirdlg.tex
1 \section{\class{wxDirDialog}}\label{wxdirdialog}
2
3 This class represents the directory chooser dialog.
4
5 \wxheading{Derived from}
6
7 \helpref{wxDialog}{wxdialog}\\
8 \helpref{wxWindow}{wxwindow}\\
9 \helpref{wxEvtHandler}{wxevthandler}\\
10 \helpref{wxObject}{wxobject}
11
12 \wxheading{Include files}
13
14 <wx/dirdlg.h>
15 <wx/generic/dirdlgg.h>
16
17 \wxheading{Window styles}
18
19 \twocolwidtha{5cm}
20 \begin{twocollist}
21 \twocolitem{\indexit{wxDD\_NEW\_DIR\_BUTTON}}{Add "Create new directory" button and allow
22 directory names to be editable. Available only on platforms that use the generic
23 dialog chooser: GTK+, Motif, X11, MGL. For other platforms, use the wxGenericDirDialog
24 implementation explicitly if you wish to use this style.}
25 \end{twocollist}
26
27 See also \helpref{Generic window styles}{windowstyles}.
28
29 \wxheading{See also}
30
31 \helpref{wxDirDialog overview}{wxdirdialogoverview}, \helpref{wxFileDialog}{wxfiledialog}
32
33 \latexignore{\rtfignore{\wxheading{Members}}}
34
35 \membersection{wxDirDialog::wxDirDialog}\label{wxdirdialogconstr}
36
37 \func{}{wxDirDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message = "Choose a directory"},\rtfsp
38 \param{const wxString\& }{defaultPath = ""}, \param{long }{style = 0},\rtfsp
39 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
40 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
41 \param{const wxString\& }{name = "wxDirCtrl"}}
42
43 Constructor. Use \helpref{wxDirDialog::ShowModal}{wxdirdialogshowmodal} to show
44 the dialog.
45
46 \wxheading{Parameters}
47
48 \docparam{parent}{Parent window.}
49
50 \docparam{message}{Message to show on the dialog.}
51
52 \docparam{defaultPath}{The default path, or the empty string.}
53
54 \docparam{style}{A dialog style, currently unused.}
55
56 \docparam{pos}{Dialog position. Ignored under Windows.}
57
58 \docparam{size}{Dialog size. Ignored under Windows.}
59
60 \docparam{name}{The dialog name, not used.}
61
62 \membersection{wxDirDialog::\destruct{wxDirDialog}}
63
64 \func{}{\destruct{wxDirDialog}}{\void}
65
66 Destructor.
67
68 \membersection{wxDirDialog::GetPath}\label{wxdirdialoggetpath}
69
70 \constfunc{wxString}{GetPath}{\void}
71
72 Returns the default or user-selected path.
73
74 \membersection{wxDirDialog::GetMessage}\label{wxdirdialoggetmessage}
75
76 \constfunc{wxString}{GetMessage}{\void}
77
78 Returns the message that will be displayed on the dialog.
79
80 \membersection{wxDirDialog::GetStyle}\label{wxdirdialoggetstyle}
81
82 \constfunc{long}{GetStyle}{\void}
83
84 Returns the dialog style.
85
86 \membersection{wxDirDialog::SetMessage}\label{wxdirdialogsetmessage}
87
88 \func{void}{SetMessage}{\param{const wxString\& }{message}}
89
90 Sets the message that will be displayed on the dialog.
91
92 \membersection{wxDirDialog::SetPath}\label{wxdirdialogsetpath}
93
94 \func{void}{SetPath}{\param{const wxString\& }{path}}
95
96 Sets the default path.
97
98 \membersection{wxDirDialog::SetStyle}\label{wxdirdialogsetstyle}
99
100 \func{void}{SetStyle}{\param{long }{style}}
101
102 Sets the dialog style. This is currently unused.
103
104 \membersection{wxDirDialog::ShowModal}\label{wxdirdialogshowmodal}
105
106 \func{int}{ShowModal}{\void}
107
108 Shows the dialog, returning wxID\_OK if the user pressed OK, and wxOK\_CANCEL
109 otherwise.
110
111