]>
Commit | Line | Data |
---|---|---|
1 | \section{\class{wxFileDialog}}\label{wxfiledialog} | |
2 | ||
3 | This 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 | ||
12 | \wxheading{Include files} | |
13 | ||
14 | <wx/filedlg.h> | |
15 | ||
16 | \wxheading{See also} | |
17 | ||
18 | \helpref{wxFileDialog overview}{wxfiledialogoverview}, \helpref{wxFileSelector}{wxfileselector} | |
19 | ||
20 | \wxheading{Remarks} | |
21 | ||
22 | Pops up a file selector box. In Windows, this is the common file selector | |
23 | dialog. In X, this is a file selector box with somewhat less functionality. | |
24 | The path and filename are distinct elements of a full file pathname. | |
25 | If path is ``", the current directory will be used. If filename is ``", | |
26 | no default filename will be supplied. The wildcard determines what files | |
27 | are displayed in the file selector, and file extension supplies a type | |
28 | extension for the required filename. Flags may be a combination of wxOPEN, | |
29 | wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0. | |
30 | ||
31 | Both the X and Windows versions implement a wildcard filter. Typing a | |
32 | filename containing wildcards (*, ?) in the filename text item, and | |
33 | clicking on Ok, will result in only those files matching the pattern being | |
34 | displayed. The wildcard may be a specification for multiple | |
35 | types of file with a description for each, such as: | |
36 | ||
37 | \begin{verbatim} | |
38 | "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif" | |
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 | ||
49 | Constructor. 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 | ||
61 | \docparam{wildcard}{A wildcard, such as ``*.*".} | |
62 | ||
63 | \docparam{style}{A dialog style. A bitlist of: | |
64 | ||
65 | \twocolwidtha{5cm} | |
66 | \begin{twocollist} | |
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.} | |
70 | \twocolitem{{\bf wxOVERWRITE\_PROMPT}}{For save dialog only: prompt for a conformation if a file will be overridden.} | |
71 | \twocolitem{{\bf wxMULTIPLE}}{For open dialog only: allows selecting multiple files.} | |
72 | \twocolitem{{\bf wxCHANGE\_DIR}}{Change the current working directory to the | |
73 | directory where the file(s) chosen by the user are.} | |
74 | \end{twocollist}% | |
75 | } | |
76 | ||
77 | \docparam{pos}{Dialog position. Not implemented.} | |
78 | ||
79 | {\bf NB:} Previous versions of wxWindows used {\tt wxCHANGE\_DIR} by default | |
80 | under MS Windows which allowed the program to simply remember the last | |
81 | directory where user selected the files to open/save. This (desired) | |
82 | functionality must be implemented in the program itself now (manually remember | |
83 | the last path used and pass it to the dialog the next time it is called) or | |
84 | by using this flag. | |
85 | ||
86 | \membersection{wxFileDialog::\destruct{wxFileDialog}} | |
87 | ||
88 | \func{}{\destruct{wxFileDialog}}{\void} | |
89 | ||
90 | Destructor. | |
91 | ||
92 | \membersection{wxFileDialog::GetDirectory}\label{wxfiledialoggetdirectory} | |
93 | ||
94 | \constfunc{wxString}{GetDirectory}{\void} | |
95 | ||
96 | Returns the default directory. | |
97 | ||
98 | \membersection{wxFileDialog::GetFilename}\label{wxfiledialoggetfilename} | |
99 | ||
100 | \constfunc{wxString}{GetFilename}{\void} | |
101 | ||
102 | Returns the default filename. | |
103 | ||
104 | \membersection{wxFileDialog::GetFilenames}\label{wxfiledialoggetfilenames} | |
105 | ||
106 | \constfunc{void}{GetFilenames}{\param{wxArrayString\& }{filenames}} | |
107 | ||
108 | Fills the array {\it filenames} with the names of the files chosen. This | |
109 | function should only be used with the dialogs which have {\tt wxMULTIPLE} style, | |
110 | use \helpref{GetFilename}{wxfiledialoggetfilename} for the others. | |
111 | ||
112 | \membersection{wxFileDialog::GetFilterIndex}\label{wxfiledialoggetfilterindex} | |
113 | ||
114 | \constfunc{int}{GetFilterIndex}{\void} | |
115 | ||
116 | Returns the index into the list of filters supplied, optionally, in the wildcard parameter. | |
117 | Before the dialog is shown, this is the index which will be used when the dialog is first displayed. | |
118 | After 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 | ||
124 | Returns the message that will be displayed on the dialog. | |
125 | ||
126 | \membersection{wxFileDialog::GetPath}\label{wxfiledialoggetpath} | |
127 | ||
128 | \constfunc{wxString}{GetPath}{\void} | |
129 | ||
130 | Returns the full path (directory and filename) of the selected file. | |
131 | ||
132 | \membersection{wxFileDialog::GetPaths}\label{wxfiledialoggetpaths} | |
133 | ||
134 | \constfunc{void}{GetPaths}{\param{wxArrayString\& }{paths}} | |
135 | ||
136 | Fills the array {\it paths} with the full paths of the files chosen. This | |
137 | function should only be used with the dialogs which have {\tt wxMULTIPLE} style, | |
138 | use \helpref{GetPath}{wxfiledialoggetpath} for the others. | |
139 | ||
140 | \membersection{wxFileDialog::GetStyle}\label{wxfiledialoggetstyle} | |
141 | ||
142 | \constfunc{long}{GetStyle}{\void} | |
143 | ||
144 | Returns the dialog style. | |
145 | ||
146 | \membersection{wxFileDialog::GetWildcard}\label{wxfiledialoggetwildcard} | |
147 | ||
148 | \constfunc{wxString}{GetWildcard}{\void} | |
149 | ||
150 | Returns the file dialog wildcard. | |
151 | ||
152 | \membersection{wxFileDialog::SetDirectory}\label{wxfiledialogsetdirectory} | |
153 | ||
154 | \func{void}{SetDirectory}{\param{const wxString\& }{directory}} | |
155 | ||
156 | Sets the default directory. | |
157 | ||
158 | \membersection{wxFileDialog::SetFilename}\label{wxfiledialogsetfilename} | |
159 | ||
160 | \func{void}{SetFilename}{\param{const wxString\& }{setfilename}} | |
161 | ||
162 | Sets the default filename. | |
163 | ||
164 | \membersection{wxFileDialog::SetFilterIndex}\label{wxfiledialogsetfilterindex} | |
165 | ||
166 | \func{void}{SetFilterIndex}{\param{int }{filterIndex}} | |
167 | ||
168 | Sets 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 | ||
174 | Sets 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 | ||
180 | Sets 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 | ||
186 | Sets 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 | ||
192 | Sets the wildcard, which in Windows can contain multiple file types. | |
193 | ||
194 | \membersection{wxFileDialog::ShowModal}\label{wxfiledialogshowmodal} | |
195 | ||
196 | \func{int}{ShowModal}{\void} | |
197 | ||
198 | Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL | |
199 | otherwise. | |
200 | ||
201 |