]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/filedlg.tex
Added missing \ before _
[wxWidgets.git] / docs / latex / wx / filedlg.tex
CommitLineData
a660d684
KB
1\section{\class{wxFileDialog}}\label{wxfiledialog}
2
3This class represents the file 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
954b8ae6
JS
12\wxheading{Include files}
13
14<wx/filedlg.h>
15
a660d684
KB
16\wxheading{See also}
17
18\helpref{wxFileDialog overview}{wxfiledialogoverview}, \helpref{wxFileSelector}{wxfileselector}
a660d684
KB
19
20\wxheading{Remarks}
21
22Pops up a file selector box. In Windows, this is the common file selector
23dialog. In X, this is a file selector box with somewhat less functionality.
24The path and filename are distinct elements of a full file pathname.
25If path is ``", the current directory will be used. If filename is ``",
26no default filename will be supplied. The wildcard determines what files
27are displayed in the file selector, and file extension supplies a type
28extension for the required filename. Flags may be a combination of wxOPEN,
f59d80ca 29wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0.
a660d684
KB
30
31Both the X and Windows versions implement a wildcard filter. Typing a
32filename containing wildcards (*, ?) in the filename text item, and
33clicking on Ok, will result in only those files matching the pattern being
330d6fd0 34displayed. The wildcard may be a specification for multiple
a660d684
KB
35types of file with a description for each, such as:
36
37\begin{verbatim}
58abfef6 38 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
a660d684
KB
39\end{verbatim}
40
41\latexignore{\rtfignore{\wxheading{Members}}}
42
43\membersection{wxFileDialog::wxFileDialog}\label{wxfiledialogconstr}
44
45\func{}{wxFileDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message = "Choose a file"},\rtfsp
46\param{const wxString\& }{defaultDir = ""}, \param{const wxString\& }{defaultFile = ``"},\rtfsp
47\param{const wxString\& }{wildcard = ``*.*"}, \param{long }{style = 0}, \param{const wxPoint\& }{pos = wxDefaultPosition}}
48
49Constructor. Use \helpref{wxFileDialog::ShowModal}{wxfiledialogshowmodal} to show the dialog.
50
51\wxheading{Parameters}
52
53\docparam{parent}{Parent window.}
54
55\docparam{message}{Message to show on the dialog.}
56
57\docparam{defaultDir}{The default directory, or the empty string.}
58
59\docparam{defaultFile}{The default filename, or the empty string.}
60
6a611b39 61\docparam{wildcard}{A wildcard, such as ``*.*" or ``BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif".}
a660d684
KB
62
63\docparam{style}{A dialog style. A bitlist of:
64
65\twocolwidtha{5cm}
66\begin{twocollist}
330d6fd0
RR
67\twocolitem{{\bf wxOPEN}}{This is an open dialog.}
68\twocolitem{{\bf wxSAVE}}{This is a save dialog.}
69\twocolitem{{\bf wxHIDE\_READONLY}}{Hide read-only files.}
302a1eca 70\twocolitem{{\bf wxOVERWRITE\_PROMPT}}{For save dialog only: prompt for a confirmation if a file will be overwritten.}
3f6638b8
VZ
71\twocolitem{{\bf wxMULTIPLE}}{For open dialog only: allows selecting multiple files.}
72\twocolitem{{\bf wxCHANGE\_DIR}}{Change the current working directory to the
73directory where the file(s) chosen by the user are.}
a660d684
KB
74\end{twocollist}%
75}
76
77\docparam{pos}{Dialog position. Not implemented.}
78
3f6638b8
VZ
79{\bf NB:} Previous versions of wxWindows used {\tt wxCHANGE\_DIR} by default
80under MS Windows which allowed the program to simply remember the last
81directory where user selected the files to open/save. This (desired)
82functionality must be implemented in the program itself now (manually remember
83the last path used and pass it to the dialog the next time it is called) or
84by using this flag.
85
a660d684
KB
86\membersection{wxFileDialog::\destruct{wxFileDialog}}
87
88\func{}{\destruct{wxFileDialog}}{\void}
89
90Destructor.
91
92\membersection{wxFileDialog::GetDirectory}\label{wxfiledialoggetdirectory}
93
94\constfunc{wxString}{GetDirectory}{\void}
95
96Returns the default directory.
97
98\membersection{wxFileDialog::GetFilename}\label{wxfiledialoggetfilename}
99
100\constfunc{wxString}{GetFilename}{\void}
101
102Returns the default filename.
103
c61f4f6d
VZ
104\membersection{wxFileDialog::GetFilenames}\label{wxfiledialoggetfilenames}
105
106\constfunc{void}{GetFilenames}{\param{wxArrayString\& }{filenames}}
107
108Fills the array {\it filenames} with the names of the files chosen. This
109function should only be used with the dialogs which have {\tt wxMULTIPLE} style,
110use \helpref{GetFilename}{wxfiledialoggetfilename} for the others.
111
a660d684
KB
112\membersection{wxFileDialog::GetFilterIndex}\label{wxfiledialoggetfilterindex}
113
114\constfunc{int}{GetFilterIndex}{\void}
115
116Returns the index into the list of filters supplied, optionally, in the wildcard parameter.
117Before the dialog is shown, this is the index which will be used when the dialog is first displayed.
118After the dialog is shown, this is the index selected by the user.
119
120\membersection{wxFileDialog::GetMessage}\label{wxfiledialoggetmessage}
121
122\constfunc{wxString}{GetMessage}{\void}
123
124Returns the message that will be displayed on the dialog.
125
126\membersection{wxFileDialog::GetPath}\label{wxfiledialoggetpath}
127
128\constfunc{wxString}{GetPath}{\void}
129
130Returns the full path (directory and filename) of the selected file.
131
c61f4f6d
VZ
132\membersection{wxFileDialog::GetPaths}\label{wxfiledialoggetpaths}
133
134\constfunc{void}{GetPaths}{\param{wxArrayString\& }{paths}}
135
136Fills the array {\it paths} with the full paths of the files chosen. This
137function should only be used with the dialogs which have {\tt wxMULTIPLE} style,
138use \helpref{GetPath}{wxfiledialoggetpath} for the others.
139
a660d684
KB
140\membersection{wxFileDialog::GetStyle}\label{wxfiledialoggetstyle}
141
142\constfunc{long}{GetStyle}{\void}
143
144Returns the dialog style.
145
146\membersection{wxFileDialog::GetWildcard}\label{wxfiledialoggetwildcard}
147
148\constfunc{wxString}{GetWildcard}{\void}
149
150Returns the file dialog wildcard.
151
152\membersection{wxFileDialog::SetDirectory}\label{wxfiledialogsetdirectory}
153
154\func{void}{SetDirectory}{\param{const wxString\& }{directory}}
155
156Sets the default directory.
157
158\membersection{wxFileDialog::SetFilename}\label{wxfiledialogsetfilename}
159
160\func{void}{SetFilename}{\param{const wxString\& }{setfilename}}
161
162Sets the default filename.
163
164\membersection{wxFileDialog::SetFilterIndex}\label{wxfiledialogsetfilterindex}
165
166\func{void}{SetFilterIndex}{\param{int }{filterIndex}}
167
168Sets the default filter index, starting from zero. Windows only.
169
170\membersection{wxFileDialog::SetMessage}\label{wxfiledialogsetmessage}
171
172\func{void}{SetMessage}{\param{const wxString\& }{message}}
173
174Sets the message that will be displayed on the dialog.
175
176\membersection{wxFileDialog::SetPath}\label{wxfiledialogsetpath}
177
178\func{void}{SetPath}{\param{const wxString\& }{path}}
179
180Sets the path (the combined directory and filename that will be returned when the dialog is dismissed).
181
182\membersection{wxFileDialog::SetStyle}\label{wxfiledialogsetstyle}
183
184\func{void}{SetStyle}{\param{long }{style}}
185
186Sets the dialog style. See \helpref{wxFileDialog::wxFileDialog}{wxfiledialogconstr} for details.
187
188\membersection{wxFileDialog::SetWildcard}\label{wxfiledialogsetwildcard}
189
190\func{void}{SetWildcard}{\param{const wxString\& }{wildCard}}
191
6a611b39
JS
192Sets the wildcard, which can contain multiple file types, for example:
193
194``BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
a660d684
KB
195
196\membersection{wxFileDialog::ShowModal}\label{wxfiledialogshowmodal}
197
198\func{int}{ShowModal}{\void}
199
f6bcfd97 200Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
a660d684
KB
201otherwise.
202
203