]>
Commit | Line | Data |
---|---|---|
a660d684 KB |
1 | \chapter{Functions}\label{functions} |
2 | \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% | |
3 | \setfooter{\thepage}{}{}{}{}{\thepage} | |
4 | ||
5 | The functions defined in wxWindows are described here. | |
6 | ||
7 | \section{File functions}\label{filefunctions} | |
8 | ||
954b8ae6 JS |
9 | \wxheading{Include files} |
10 | ||
11 | <wx/utils.h> | |
12 | ||
13 | \wxheading{See also} | |
14 | ||
15 | \helpref{wxPathList}{wxpathlist} | |
a660d684 KB |
16 | |
17 | \membersection{::wxDirExists} | |
18 | ||
19 | \func{bool}{wxDirExists}{\param{const wxString\& }{dirname}} | |
20 | ||
21 | Returns TRUE if the directory exists. | |
22 | ||
23 | \membersection{::wxDos2UnixFilename} | |
24 | ||
25 | \func{void}{Dos2UnixFilename}{\param{const wxString\& }{s}} | |
26 | ||
e2a6f233 | 27 | Converts a DOS to a Unix filename by replacing backslashes with forward |
a660d684 KB |
28 | slashes. |
29 | ||
30 | \membersection{::wxFileExists} | |
31 | ||
32 | \func{bool}{wxFileExists}{\param{const wxString\& }{filename}} | |
33 | ||
34 | Returns TRUE if the file exists. | |
35 | ||
36 | \membersection{::wxFileNameFromPath} | |
37 | ||
38 | \func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}} | |
39 | ||
532372a3 JS |
40 | \func{char*}{wxFileNameFromPath}{\param{char* }{path}} |
41 | ||
42 | Returns the filename for a full path. The second form returns a pointer to | |
43 | temporary storage that should not be deallocated. | |
a660d684 KB |
44 | |
45 | \membersection{::wxFindFirstFile}\label{wxfindfirstfile} | |
46 | ||
532372a3 | 47 | \func{wxString}{wxFindFirstFile}{\param{const char*}{spec}, \param{int}{ flags = 0}} |
a660d684 KB |
48 | |
49 | This function does directory searching; returns the first file | |
532372a3 | 50 | that matches the path {\it spec}, or the empty string. Use \helpref{wxFindNextFile}{wxfindnextfile} to |
a660d684 KB |
51 | get the next matching file. |
52 | ||
53 | {\it spec} may contain wildcards. | |
54 | ||
55 | {\it flags} is reserved for future use. | |
56 | ||
a660d684 KB |
57 | For example: |
58 | ||
59 | \begin{verbatim} | |
60 | wxString f = wxFindFirstFile("/home/project/*.*"); | |
58503787 | 61 | while ( !f.IsEmpty() ) |
a660d684 KB |
62 | { |
63 | ... | |
64 | f = wxFindNextFile(); | |
65 | } | |
66 | \end{verbatim} | |
67 | ||
68 | \membersection{::wxFindNextFile}\label{wxfindnextfile} | |
69 | ||
5ab656cd | 70 | \func{wxString}{wxFindNextFile}{\void} |
a660d684 KB |
71 | |
72 | Returns the next file that matches the path passed to \helpref{wxFindFirstFile}{wxfindfirstfile}. | |
73 | ||
5ab656cd VZ |
74 | See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example. |
75 | ||
631f1bfe JS |
76 | \membersection{::wxGetOSDirectory}\label{wxgetosdirectory} |
77 | ||
78 | \func{wxString}{wxGetOSDirectory}{\void} | |
79 | ||
80 | Returns the Windows directory under Windows; on other platforms returns the empty string. | |
81 | ||
a660d684 KB |
82 | \membersection{::wxIsAbsolutePath} |
83 | ||
84 | \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}} | |
85 | ||
86 | Returns TRUE if the argument is an absolute filename, i.e. with a slash | |
87 | or drive name at the beginning. | |
88 | ||
89 | \membersection{::wxPathOnly} | |
90 | ||
91 | \func{wxString}{wxPathOnly}{\param{const wxString\& }{path}} | |
92 | ||
532372a3 | 93 | Returns the directory part of the filename. |
a660d684 KB |
94 | |
95 | \membersection{::wxUnix2DosFilename} | |
96 | ||
97 | \func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}} | |
98 | ||
e2a6f233 | 99 | Converts a Unix to a DOS filename by replacing forward |
a660d684 KB |
100 | slashes with backslashes. |
101 | ||
102 | \membersection{::wxConcatFiles} | |
103 | ||
104 | \func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, | |
105 | \param{const wxString\& }{file3}} | |
106 | ||
107 | Concatenates {\it file1} and {\it file2} to {\it file3}, returning | |
108 | TRUE if successful. | |
109 | ||
110 | \membersection{::wxCopyFile} | |
111 | ||
112 | \func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}} | |
113 | ||
114 | Copies {\it file1} to {\it file2}, returning TRUE if successful. | |
115 | ||
7af89395 VZ |
116 | \membersection{::wxGetCwd}\label{wxgetcwd} |
117 | ||
118 | \func{wxString}{wxGetCwd}{\void} | |
119 | ||
120 | Returns a string containing the current (or working) directory. | |
121 | ||
a660d684 KB |
122 | \membersection{::wxGetWorkingDirectory} |
123 | ||
532372a3 | 124 | \func{wxString}{wxGetWorkingDirectory}{\param{char*}{buf=NULL}, \param{int }{sz=1000}} |
a660d684 | 125 | |
7af89395 VZ |
126 | This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead. |
127 | ||
a660d684 KB |
128 | Copies the current working directory into the buffer if supplied, or |
129 | copies the working directory into new storage (which you must delete yourself) | |
130 | if the buffer is NULL. | |
131 | ||
132 | {\it sz} is the size of the buffer if supplied. | |
133 | ||
134 | \membersection{::wxGetTempFileName} | |
135 | ||
532372a3 | 136 | \func{char*}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char* }{buf=NULL}} |
a660d684 KB |
137 | |
138 | Makes a temporary filename based on {\it prefix}, opens and closes the file, | |
139 | and places the name in {\it buf}. If {\it buf} is NULL, new store | |
140 | is allocated for the temporary filename using {\it new}. | |
141 | ||
142 | Under Windows, the filename will include the drive and name of the | |
143 | directory allocated for temporary files (usually the contents of the | |
e2a6f233 | 144 | TEMP variable). Under Unix, the {\tt /tmp} directory is used. |
a660d684 KB |
145 | |
146 | It is the application's responsibility to create and delete the file. | |
147 | ||
148 | \membersection{::wxIsWild}\label{wxiswild} | |
149 | ||
150 | \func{bool}{wxIsWild}{\param{const wxString\& }{pattern}} | |
151 | ||
152 | Returns TRUE if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}. | |
153 | ||
154 | \membersection{::wxMatchWild}\label{wxmatchwild} | |
155 | ||
156 | \func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}} | |
157 | ||
158 | Returns TRUE if the {\it pattern}\/ matches the {\it text}\/; if {\it | |
159 | dot\_special}\/ is TRUE, filenames beginning with a dot are not matched | |
160 | with wildcard characters. See \helpref{wxIsWild}{wxiswild}. | |
161 | ||
162 | \membersection{::wxMkdir} | |
163 | ||
1a33c3ba | 164 | \func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}} |
a660d684 KB |
165 | |
166 | Makes the directory {\it dir}, returning TRUE if successful. | |
167 | ||
1a33c3ba VZ |
168 | {\it perm} is the access mask for the directory for the systems on which it is |
169 | supported (Unix) and doesn't have effect for the other ones. | |
170 | ||
a660d684 KB |
171 | \membersection{::wxRemoveFile} |
172 | ||
173 | \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}} | |
174 | ||
175 | Removes {\it file}, returning TRUE if successful. | |
176 | ||
177 | \membersection{::wxRenameFile} | |
178 | ||
179 | \func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}} | |
180 | ||
181 | Renames {\it file1} to {\it file2}, returning TRUE if successful. | |
182 | ||
183 | \membersection{::wxRmdir} | |
184 | ||
185 | \func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}} | |
186 | ||
187 | Removes the directory {\it dir}, returning TRUE if successful. Does not work under VMS. | |
188 | ||
189 | The {\it flags} parameter is reserved for future use. | |
190 | ||
191 | \membersection{::wxSetWorkingDirectory} | |
192 | ||
193 | \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}} | |
194 | ||
195 | Sets the current working directory, returning TRUE if the operation succeeded. | |
196 | Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification. | |
197 | ||
d37fd2fa VZ |
198 | \membersection{::wxSplitPath}\label{wxsplitfunction} |
199 | ||
200 | \func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{const wxString *}{ path}, \param{const wxString *}{ name}, \param{const wxString *}{ ext}} | |
201 | ||
202 | This function splits a full file name into components: the path (including possible disk/drive | |
203 | specification under Windows), the base name and the extension. Any of the output parameters | |
204 | ({\it path}, {\it name} or {\it ext}) may be NULL if you are not interested in the value of | |
205 | a particular component. | |
206 | ||
207 | wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under | |
208 | Windows, however it will not consider backslashes as path separators under Unix (where backslash | |
209 | is a valid character in a filename). | |
210 | ||
211 | On entry, {\it fullname} should be non NULL (it may be empty though). | |
212 | ||
213 | On return, {\it path} contains the file path (without the trailing separator), {\it name} | |
214 | contains the file name and {\it ext} contains the file extension without leading dot. All | |
215 | three of them may be empty if the corresponding component is. The old contents of the | |
216 | strings pointed to by these parameters will be overwritten in any case (if the pointers | |
217 | are not NULL). | |
218 | ||
ed93168b VZ |
219 | \membersection{::wxTransferFileToStream}\label{wxtransferfiletostream} |
220 | ||
221 | \func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}} | |
222 | ||
223 | Copies the given file to {\it stream}. Useful when converting an old application to | |
224 | use streams (within the document/view framework, for example). | |
225 | ||
226 | Use of this function requires the file wx\_doc.h to be included. | |
227 | ||
228 | \membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile} | |
229 | ||
230 | \func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}} | |
231 | ||
232 | Copies the given stream to the file {\it filename}. Useful when converting an old application to | |
233 | use streams (within the document/view framework, for example). | |
234 | ||
235 | Use of this function requires the file wx\_doc.h to be included. | |
236 | ||
d524e22d VZ |
237 | \section{Network functions}\label{networkfunctions} |
238 | ||
239 | \membersection{::wxGetFullHostName}\label{wxgetfullhostname} | |
240 | ||
241 | \func{wxString}{wxGetFullHostName}{\void} | |
242 | ||
243 | Returns the FQDN (fully qualified domain host name) or an empty string on | |
244 | error. | |
245 | ||
246 | See also: \helpref{wxGetHostName}{wxgethostname} | |
247 | ||
248 | \wxheading{Include files} | |
249 | ||
250 | <wx/utils.h> | |
251 | ||
252 | \membersection{::wxGetEmailAddress}\label{wxgetemailaddress} | |
253 | ||
254 | \func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}} | |
255 | ||
256 | Copies the user's email address into the supplied buffer, by | |
257 | concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp | |
258 | and \helpref{wxGetUserId}{wxgetuserid}. | |
259 | ||
260 | Returns TRUE if successful, FALSE otherwise. | |
261 | ||
262 | \wxheading{Include files} | |
263 | ||
264 | <wx/utils.h> | |
265 | ||
266 | \membersection{::wxGetHostName}\label{wxgethostname} | |
267 | ||
268 | \func{wxString}{wxGetHostName}{\void} | |
269 | \func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}} | |
270 | ||
271 | Copies the current host machine's name into the supplied buffer. Please note | |
272 | that the returned name is {\it not} fully qualified, i.e. it does not include | |
273 | the domain name. | |
274 | ||
275 | Under Windows or NT, this function first looks in the environment | |
276 | variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp | |
277 | in the {\bf wxWindows} section of the WIN.INI file is tried. | |
278 | ||
279 | The first variant of this function returns the hostname if successful or an | |
280 | empty string otherwise. The second (deprecated) function returns TRUE | |
281 | if successful, FALSE otherwise. | |
282 | ||
283 | See also: \helpref{wxGetFullHostName}{wxgetfullhostname} | |
284 | ||
285 | \wxheading{Include files} | |
286 | ||
287 | <wx/utils.h> | |
288 | ||
289 | \section{User identification}\label{useridfunctions} | |
290 | ||
291 | \membersection{::wxGetUserId}\label{wxgetuserid} | |
292 | ||
293 | \func{wxString}{wxGetUserId}{\void} | |
294 | \func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}} | |
295 | ||
296 | This function returns the "user id" also known as "login name" under Unix i.e. | |
297 | something like "jsmith". It uniquely identifies the current user (on this system). | |
298 | ||
299 | Under Windows or NT, this function first looks in the environment | |
300 | variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp | |
301 | in the {\bf wxWindows} section of the WIN.INI file is tried. | |
302 | ||
303 | The first variant of this function returns the login name if successful or an | |
304 | empty string otherwise. The second (deprecated) function returns TRUE | |
305 | if successful, FALSE otherwise. | |
306 | ||
307 | See also: \helpref{wxGetUserName}{wxgetusername} | |
308 | ||
309 | \wxheading{Include files} | |
310 | ||
311 | <wx/utils.h> | |
312 | ||
313 | \membersection{::wxGetUserName}\label{wxgetusername} | |
314 | ||
315 | \func{wxString}{wxGetUserName}{\void} | |
316 | \func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}} | |
317 | ||
318 | This function returns the full user name (something like "Mr. John Smith"). | |
319 | ||
320 | Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp | |
321 | in the {\bf wxWindows} section of the WIN.INI file. If PenWindows | |
322 | is running, the entry {\bf Current} in the section {\bf User} of | |
323 | the PENWIN.INI file is used. | |
324 | ||
325 | The first variant of this function returns the user name if successful or an | |
326 | empty string otherwise. The second (deprecated) function returns TRUE | |
327 | if successful, FALSE otherwise. | |
328 | ||
329 | See also: \helpref{wxGetUserId}{wxgetuserid} | |
330 | ||
331 | \wxheading{Include files} | |
332 | ||
333 | <wx/utils.h> | |
334 | ||
a660d684 KB |
335 | \section{String functions} |
336 | ||
337 | \membersection{::copystring} | |
338 | ||
339 | \func{char*}{copystring}{\param{const char* }{s}} | |
340 | ||
341 | Makes a copy of the string {\it s} using the C++ new operator, so it can be | |
342 | deleted with the {\it delete} operator. | |
343 | ||
344 | \membersection{::wxStringMatch} | |
345 | ||
346 | \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\ | |
347 | \param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}} | |
348 | ||
349 | Returns TRUE if the substring {\it s1} is found within {\it s2}, | |
350 | ignoring case if {\it exact} is FALSE. If {\it subString} is FALSE, | |
351 | no substring matching is done. | |
352 | ||
353 | \membersection{::wxStringEq}\label{wxstringeq} | |
354 | ||
355 | \func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}} | |
356 | ||
357 | A macro defined as: | |
358 | ||
359 | \begin{verbatim} | |
360 | #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0)) | |
361 | \end{verbatim} | |
362 | ||
ed93168b | 363 | \membersection{::IsEmpty}\label{isempty} |
a660d684 | 364 | |
ed93168b | 365 | \func{bool}{IsEmpty}{\param{const char *}{ p}} |
a660d684 | 366 | |
ed93168b VZ |
367 | Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL |
368 | pointer to this function and it will return TRUE for it. | |
a660d684 | 369 | |
ed93168b | 370 | \membersection{::Stricmp}\label{stricmp} |
a660d684 | 371 | |
ed93168b | 372 | \func{int}{Stricmp}{\param{const char *}{p1}, \param{const char *}{p2}} |
a660d684 | 373 | |
ed93168b VZ |
374 | Returns a negative value, 0, or positive value if {\it p1} is less than, equal |
375 | to or greater than {\it p2}. The comparison is case-insensitive. | |
a660d684 | 376 | |
ed93168b VZ |
377 | This function complements the standard C function {\it strcmp()} which performs |
378 | case-sensitive comparison. | |
a660d684 | 379 | |
ed93168b VZ |
380 | \membersection{::Strlen}\label{strlen} |
381 | ||
382 | \func{size\_t}{Strlen}{\param{const char *}{ p}} | |
383 | ||
384 | This is a safe version of standard function {\it strlen()}: it does exactly the | |
385 | same thing (i.e. returns the length of the string) except that it returns 0 if | |
386 | {\it p} is the NULL pointer. | |
387 | ||
388 | \membersection{::wxGetTranslation}\label{wxgettranslation} | |
389 | ||
390 | \func{const char *}{wxGetTranslation}{\param{const char * }{str}} | |
391 | ||
392 | This function returns the translation of string {\it str} in the current | |
393 | \helpref{locale}{wxlocale}. If the string is not found in any of the loaded | |
394 | message catalogs (see \helpref{i18n overview}{internationalization}), the | |
395 | original string is returned. In debug build, an error message is logged - this | |
396 | should help to find the strings which were not yet translated. As this function | |
397 | is used very often, an alternative syntax is provided: the \_() macro is | |
398 | defined as wxGetTranslation(). | |
a660d684 KB |
399 | |
400 | \section{Dialog functions}\label{dialogfunctions} | |
401 | ||
402 | Below are a number of convenience functions for getting input from the | |
403 | user or displaying messages. Note that in these functions the last three | |
404 | parameters are optional. However, it is recommended to pass a parent frame | |
405 | parameter, or (in MS Windows or Motif) the wrong window frame may be brought to | |
406 | the front when the dialog box is popped up. | |
407 | ||
408 | \membersection{::wxFileSelector}\label{wxfileselector} | |
409 | ||
f5ee2e5f JS |
410 | \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\ |
411 | \param{const wxString\& }{default\_filename = ""}, \param{const wxString\& }{default\_extension = ""},\\ | |
412 | \param{const wxString\& }{wildcard = ``*.*''}, \param{int }{flags = 0}, \param{wxWindow *}{parent = ""},\\ | |
a660d684 KB |
413 | \param{int}{ x = -1}, \param{int}{ y = -1}} |
414 | ||
415 | Pops up a file selector box. In Windows, this is the common file selector | |
416 | dialog. In X, this is a file selector box with somewhat less functionality. | |
417 | The path and filename are distinct elements of a full file pathname. | |
706bb5f9 | 418 | If path is empty, the current directory will be used. If filename is empty, |
a660d684 KB |
419 | no default filename will be supplied. The wildcard determines what files |
420 | are displayed in the file selector, and file extension supplies a type | |
421 | extension for the required filename. Flags may be a combination of wxOPEN, | |
422 | wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, or 0. They are only significant | |
423 | at present in Windows. | |
424 | ||
425 | Both the X and Windows versions implement a wildcard filter. Typing a | |
426 | filename containing wildcards (*, ?) in the filename text item, and | |
427 | clicking on Ok, will result in only those files matching the pattern being | |
428 | displayed. In the X version, supplying no default name will result in the | |
429 | wildcard filter being inserted in the filename text item; the filter is | |
430 | ignored if a default name is supplied. | |
431 | ||
432 | Under Windows (only), the wildcard may be a specification for multiple | |
433 | types of file with a description for each, such as: | |
434 | ||
435 | \begin{verbatim} | |
58abfef6 | 436 | "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif" |
a660d684 KB |
437 | \end{verbatim} |
438 | ||
706bb5f9 | 439 | The application must check for an empty return value (the user pressed |
a660d684 KB |
440 | Cancel). For example: |
441 | ||
442 | \begin{verbatim} | |
f5ee2e5f | 443 | const wxString& s = wxFileSelector("Choose a file to open"); |
a660d684 KB |
444 | if (s) |
445 | { | |
446 | ... | |
447 | } | |
448 | \end{verbatim} | |
449 | ||
954b8ae6 JS |
450 | \wxheading{Include files} |
451 | ||
452 | <wx/filedlg.h> | |
453 | ||
a660d684 KB |
454 | \membersection{::wxGetTextFromUser}\label{wxgettextfromuser} |
455 | ||
456 | \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\ | |
457 | \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\ | |
458 | \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}} | |
459 | ||
460 | Pop up a dialog box with title set to {\it caption}, message {\it message}, and a | |
461 | \rtfsp{\it default\_value}. The user may type in text and press OK to return this text, | |
532372a3 | 462 | or press Cancel to return the empty string. |
a660d684 KB |
463 | |
464 | If {\it centre} is TRUE, the message text (which may include new line characters) | |
465 | is centred; if FALSE, the message is left-justified. | |
466 | ||
954b8ae6 JS |
467 | \wxheading{Include files} |
468 | ||
469 | <wx/textdlg.h> | |
470 | ||
a660d684 KB |
471 | \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice} |
472 | ||
473 | \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\ | |
474 | \param{int }{nsel}, \param{int *}{selection}, | |
475 | \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\ | |
476 | \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}} | |
477 | ||
478 | Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection | |
479 | listbox. The user may choose one or more item(s) and press OK or Cancel. | |
480 | ||
481 | The number of initially selected choices, and array of the selected indices, | |
482 | are passed in; this array will contain the user selections on exit, with | |
483 | the function returning the number of selections. {\it selection} must be | |
484 | as big as the number of choices, in case all are selected. | |
485 | ||
486 | If Cancel is pressed, -1 is returned. | |
487 | ||
488 | {\it choices} is an array of {\it n} strings for the listbox. | |
489 | ||
490 | If {\it centre} is TRUE, the message text (which may include new line characters) | |
491 | is centred; if FALSE, the message is left-justified. | |
492 | ||
954b8ae6 JS |
493 | \wxheading{Include files} |
494 | ||
495 | <wx/choicdlg.h> | |
496 | ||
a660d684 KB |
497 | \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice} |
498 | ||
499 | \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\ | |
500 | \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\ | |
501 | \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}} | |
502 | ||
503 | Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection | |
504 | listbox. The user may choose an item and press OK to return a string or | |
532372a3 | 505 | Cancel to return the empty string. |
a660d684 KB |
506 | |
507 | {\it choices} is an array of {\it n} strings for the listbox. | |
508 | ||
509 | If {\it centre} is TRUE, the message text (which may include new line characters) | |
510 | is centred; if FALSE, the message is left-justified. | |
511 | ||
954b8ae6 JS |
512 | \wxheading{Include files} |
513 | ||
514 | <wx/choicdlg.h> | |
515 | ||
a660d684 KB |
516 | \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex} |
517 | ||
518 | \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\ | |
519 | \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\ | |
520 | \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}} | |
521 | ||
522 | As {\bf wxGetSingleChoice} but returns the index representing the selected string. | |
523 | If the user pressed cancel, -1 is returned. | |
524 | ||
954b8ae6 JS |
525 | \wxheading{Include files} |
526 | ||
527 | <wx/choicdlg.h> | |
528 | ||
a660d684 KB |
529 | \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata} |
530 | ||
531 | \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\ | |
532 | \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\ | |
533 | \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}} | |
534 | ||
535 | As {\bf wxGetSingleChoice} but takes an array of client data pointers | |
536 | corresponding to the strings, and returns one of these pointers. | |
537 | ||
954b8ae6 JS |
538 | \wxheading{Include files} |
539 | ||
540 | <wx/choicdlg.h> | |
541 | ||
a660d684 KB |
542 | \membersection{::wxMessageBox}\label{wxmessagebox} |
543 | ||
544 | \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\ | |
545 | \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}} | |
546 | ||
547 | General purpose message dialog. {\it style} may be a bit list of the | |
548 | following identifiers: | |
549 | ||
550 | \begin{twocollist}\itemsep=0pt | |
551 | \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with | |
552 | wxCANCEL.} | |
553 | \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with | |
554 | wxYES\_NO or wxOK.} | |
555 | \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.} | |
556 | \twocolitem{wxCENTRE}{Centres the text.} | |
557 | \twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.} | |
558 | \twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.} | |
559 | \twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.} | |
560 | \twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.} | |
561 | \end{twocollist} | |
562 | ||
563 | The return value is one of: wxYES, wxNO, wxCANCEL, wxOK. | |
564 | ||
565 | For example: | |
566 | ||
567 | \begin{verbatim} | |
568 | ... | |
569 | int answer = wxMessageBox("Quit program?", "Confirm", | |
570 | wxYES_NO | wxCANCEL, main_frame); | |
571 | if (answer == wxYES) | |
572 | delete main_frame; | |
573 | ... | |
574 | \end{verbatim} | |
575 | ||
576 | {\it message} may contain newline characters, in which case the | |
577 | message will be split into separate lines, to cater for large messages. | |
578 | ||
579 | Under Windows, the native MessageBox function is used unless wxCENTRE | |
580 | is specified in the style, in which case a generic function is used. | |
581 | This is because the native MessageBox function cannot centre text. | |
582 | The symbols are not shown when the generic function is used. | |
583 | ||
954b8ae6 JS |
584 | \wxheading{Include files} |
585 | ||
586 | <wx/msgdlg.h> | |
587 | ||
a660d684 KB |
588 | \section{GDI functions}\label{gdifunctions} |
589 | ||
590 | The following are relevant to the GDI (Graphics Device Interface). | |
591 | ||
954b8ae6 JS |
592 | \wxheading{Include files} |
593 | ||
594 | <wx/gdicmn.h> | |
595 | ||
a660d684 KB |
596 | \membersection{::wxColourDisplay} |
597 | ||
598 | \func{bool}{wxColourDisplay}{\void} | |
599 | ||
600 | Returns TRUE if the display is colour, FALSE otherwise. | |
601 | ||
602 | \membersection{::wxDisplayDepth} | |
603 | ||
604 | \func{int}{wxDisplayDepth}{\void} | |
605 | ||
606 | Returns the depth of the display (a value of 1 denotes a monochrome display). | |
607 | ||
e2a6f233 | 608 | \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable} |
a660d684 | 609 | |
e2a6f233 | 610 | \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY}, |
a660d684 KB |
611 | \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}} |
612 | ||
e2a6f233 | 613 | Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc}) |
a660d684 KB |
614 | makes it into a placeable metafile by prepending a header containing the given |
615 | bounding box. The bounding box may be obtained from a device context after drawing | |
616 | into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY. | |
617 | ||
618 | In addition to adding the placeable metafile header, this function adds | |
619 | the equivalent of the following code to the start of the metafile data: | |
620 | ||
621 | \begin{verbatim} | |
622 | SetMapMode(dc, MM_ANISOTROPIC); | |
623 | SetWindowOrg(dc, minX, minY); | |
624 | SetWindowExt(dc, maxX - minX, maxY - minY); | |
625 | \end{verbatim} | |
626 | ||
e3065973 | 627 | This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes. |
a660d684 KB |
628 | |
629 | Placeable metafiles may be imported by many Windows applications, and can be | |
630 | used in RTF (Rich Text Format) files. | |
631 | ||
632 | {\it scale} allows the specification of scale for the metafile. | |
633 | ||
634 | This function is only available under Windows. | |
635 | ||
636 | \membersection{::wxSetCursor}\label{wxsetcursor} | |
637 | ||
638 | \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}} | |
639 | ||
640 | Globally sets the cursor; only has an effect in MS Windows. | |
641 | See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}. | |
642 | ||
a660d684 KB |
643 | \section{Printer settings}\label{printersettings} |
644 | ||
645 | The following functions are used to control PostScript printing. Under | |
646 | Windows, PostScript output can only be sent to a file. | |
647 | ||
954b8ae6 JS |
648 | \wxheading{Include files} |
649 | ||
650 | <wx/dcps.h> | |
651 | ||
a660d684 KB |
652 | \membersection{::wxGetPrinterCommand} |
653 | ||
654 | \func{wxString}{wxGetPrinterCommand}{\void} | |
655 | ||
656 | Gets the printer command used to print a file. The default is {\tt lpr}. | |
657 | ||
658 | \membersection{::wxGetPrinterFile} | |
659 | ||
660 | \func{wxString}{wxGetPrinterFile}{\void} | |
661 | ||
662 | Gets the PostScript output filename. | |
663 | ||
664 | \membersection{::wxGetPrinterMode} | |
665 | ||
666 | \func{int}{wxGetPrinterMode}{\void} | |
667 | ||
668 | Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER). | |
669 | The default is PS\_PREVIEW. | |
670 | ||
671 | \membersection{::wxGetPrinterOptions} | |
672 | ||
673 | \func{wxString}{wxGetPrinterOptions}{\void} | |
674 | ||
675 | Gets the additional options for the print command (e.g. specific printer). The default is nothing. | |
676 | ||
677 | \membersection{::wxGetPrinterOrientation} | |
678 | ||
679 | \func{int}{wxGetPrinterOrientation}{\void} | |
680 | ||
681 | Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT. | |
682 | ||
683 | \membersection{::wxGetPrinterPreviewCommand} | |
684 | ||
685 | \func{wxString}{wxGetPrinterPreviewCommand}{\void} | |
686 | ||
687 | Gets the command used to view a PostScript file. The default depends on the platform. | |
688 | ||
689 | \membersection{::wxGetPrinterScaling} | |
690 | ||
691 | \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}} | |
692 | ||
693 | Gets the scaling factor for PostScript output. The default is 1.0, 1.0. | |
694 | ||
695 | \membersection{::wxGetPrinterTranslation} | |
696 | ||
697 | \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}} | |
698 | ||
699 | Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0. | |
700 | ||
701 | \membersection{::wxSetPrinterCommand} | |
702 | ||
703 | \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}} | |
704 | ||
705 | Sets the printer command used to print a file. The default is {\tt lpr}. | |
706 | ||
707 | \membersection{::wxSetPrinterFile} | |
708 | ||
709 | \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}} | |
710 | ||
711 | Sets the PostScript output filename. | |
712 | ||
713 | \membersection{::wxSetPrinterMode} | |
714 | ||
715 | \func{void}{wxSetPrinterMode}{\param{int }{mode}} | |
716 | ||
717 | Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER). | |
718 | The default is PS\_PREVIEW. | |
719 | ||
720 | \membersection{::wxSetPrinterOptions} | |
721 | ||
722 | \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}} | |
723 | ||
724 | Sets the additional options for the print command (e.g. specific printer). The default is nothing. | |
725 | ||
726 | \membersection{::wxSetPrinterOrientation} | |
727 | ||
728 | \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}} | |
729 | ||
730 | Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT. | |
731 | ||
732 | \membersection{::wxSetPrinterPreviewCommand} | |
733 | ||
734 | \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}} | |
735 | ||
736 | Sets the command used to view a PostScript file. The default depends on the platform. | |
737 | ||
738 | \membersection{::wxSetPrinterScaling} | |
739 | ||
740 | \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}} | |
741 | ||
742 | Sets the scaling factor for PostScript output. The default is 1.0, 1.0. | |
743 | ||
744 | \membersection{::wxSetPrinterTranslation} | |
745 | ||
746 | \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}} | |
747 | ||
748 | Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0. | |
749 | ||
750 | \section{Clipboard functions}\label{clipsboard} | |
751 | ||
752 | These clipboard functions are implemented for Windows only. | |
753 | ||
954b8ae6 JS |
754 | \wxheading{Include files} |
755 | ||
756 | <wx/clipbrd.h> | |
757 | ||
a660d684 KB |
758 | \membersection{::wxClipboardOpen} |
759 | ||
760 | \func{bool}{wxClipboardOpen}{\void} | |
761 | ||
762 | Returns TRUE if this application has already opened the clipboard. | |
763 | ||
764 | \membersection{::wxCloseClipboard} | |
765 | ||
766 | \func{bool}{wxCloseClipboard}{\void} | |
767 | ||
768 | Closes the clipboard to allow other applications to use it. | |
769 | ||
770 | \membersection{::wxEmptyClipboard} | |
771 | ||
772 | \func{bool}{wxEmptyClipboard}{\void} | |
773 | ||
774 | Empties the clipboard. | |
775 | ||
776 | \membersection{::wxEnumClipboardFormats} | |
777 | ||
778 | \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}} | |
779 | ||
780 | Enumerates the formats found in a list of available formats that belong | |
781 | to the clipboard. Each call to this function specifies a known | |
782 | available format; the function returns the format that appears next in | |
783 | the list. | |
784 | ||
785 | {\it dataFormat} specifies a known format. If this parameter is zero, | |
786 | the function returns the first format in the list. | |
787 | ||
788 | The return value specifies the next known clipboard data format if the | |
789 | function is successful. It is zero if the {\it dataFormat} parameter specifies | |
790 | the last format in the list of available formats, or if the clipboard | |
791 | is not open. | |
792 | ||
793 | Before it enumerates the formats function, an application must open the clipboard by using the | |
794 | wxOpenClipboard function. | |
795 | ||
796 | \membersection{::wxGetClipboardData} | |
797 | ||
798 | \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}} | |
799 | ||
800 | Gets data from the clipboard. | |
801 | ||
802 | {\it dataFormat} may be one of: | |
803 | ||
804 | \begin{itemize}\itemsep=0pt | |
805 | \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string. | |
806 | \item wxCF\_BITMAP: returns a new wxBitmap. | |
807 | \end{itemize} | |
808 | ||
809 | The clipboard must have previously been opened for this call to succeed. | |
810 | ||
811 | \membersection{::wxGetClipboardFormatName} | |
812 | ||
813 | \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}} | |
814 | ||
815 | Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum | |
816 | length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format. | |
817 | ||
818 | \membersection{::wxIsClipboardFormatAvailable} | |
819 | ||
820 | \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}} | |
821 | ||
822 | Returns TRUE if the given data format is available on the clipboard. | |
823 | ||
824 | \membersection{::wxOpenClipboard} | |
825 | ||
826 | \func{bool}{wxOpenClipboard}{\void} | |
827 | ||
828 | Opens the clipboard for passing data to it or getting data from it. | |
829 | ||
830 | \membersection{::wxRegisterClipboardFormat} | |
831 | ||
832 | \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}} | |
833 | ||
834 | Registers the clipboard data format name and returns an identifier. | |
835 | ||
836 | \membersection{::wxSetClipboardData} | |
837 | ||
838 | \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}} | |
839 | ||
840 | Passes data to the clipboard. | |
841 | ||
842 | {\it dataFormat} may be one of: | |
843 | ||
844 | \begin{itemize}\itemsep=0pt | |
845 | \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string. | |
846 | \item wxCF\_BITMAP: {\it data} is a wxBitmap. | |
847 | \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap). | |
e2a6f233 | 848 | \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions. |
a660d684 KB |
849 | \end{itemize} |
850 | ||
851 | The clipboard must have previously been opened for this call to succeed. | |
852 | ||
853 | \section{Miscellaneous functions}\label{miscellany} | |
854 | ||
954b8ae6 | 855 | \membersection{::wxNewId} |
a660d684 | 856 | |
954b8ae6 | 857 | \func{long}{wxNewId}{\void} |
a660d684 KB |
858 | |
859 | Generates an integer identifier unique to this run of the program. | |
860 | ||
954b8ae6 JS |
861 | \wxheading{Include files} |
862 | ||
863 | <wx/utils.h> | |
a660d684 | 864 | |
954b8ae6 JS |
865 | \membersection{::wxRegisterId} |
866 | ||
867 | \func{void}{wxRegisterId}{\param{long}{ id}} | |
a660d684 KB |
868 | |
869 | Ensures that ids subsequently generated by {\bf NewId} do not clash with | |
870 | the given {\bf id}. | |
871 | ||
954b8ae6 JS |
872 | \wxheading{Include files} |
873 | ||
874 | <wx/utils.h> | |
875 | ||
a660d684 KB |
876 | \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor} |
877 | ||
878 | \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}} | |
879 | ||
880 | Changes the cursor to the given cursor for all windows in the application. | |
881 | Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back | |
882 | to its previous state. These two calls can be nested, and a counter | |
883 | ensures that only the outer calls take effect. | |
884 | ||
e2a6f233 | 885 | See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}. |
a660d684 | 886 | |
954b8ae6 JS |
887 | \wxheading{Include files} |
888 | ||
889 | <wx/utils.h> | |
890 | ||
a660d684 KB |
891 | \membersection{::wxBell} |
892 | ||
893 | \func{void}{wxBell}{\void} | |
894 | ||
895 | Ring the system bell. | |
896 | ||
954b8ae6 | 897 | \wxheading{Include files} |
a660d684 | 898 | |
954b8ae6 | 899 | <wx/utils.h> |
a660d684 KB |
900 | |
901 | \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject} | |
902 | ||
903 | \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}} | |
904 | ||
905 | Creates and returns an object of the given class, if the class has been | |
906 | registered with the dynamic class system using DECLARE... and IMPLEMENT... macros. | |
907 | ||
e2a6f233 JS |
908 | \membersection{::wxDDECleanUp}\label{wxddecleanup} |
909 | ||
910 | \func{void}{wxDDECleanUp}{\void} | |
911 | ||
912 | Called when wxWindows exits, to clean up the DDE system. This no longer needs to be | |
913 | called by the application. | |
914 | ||
915 | See also helpref{wxDDEInitialize}{wxddeinitialize}. | |
916 | ||
954b8ae6 JS |
917 | \wxheading{Include files} |
918 | ||
919 | <wx/dde.h> | |
920 | ||
e2a6f233 JS |
921 | \membersection{::wxDDEInitialize}\label{wxddeinitialize} |
922 | ||
923 | \func{void}{wxDDEInitialize}{\void} | |
924 | ||
925 | Initializes the DDE system. May be called multiple times without harm. | |
926 | ||
927 | This no longer needs to be called by the application: it will be called | |
928 | by wxWindows if necessary. | |
929 | ||
930 | See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection}, | |
931 | \helpref{wxDDECleanUp}{wxddecleanup}. | |
932 | ||
954b8ae6 JS |
933 | \wxheading{Include files} |
934 | ||
935 | <wx/dde.h> | |
936 | ||
e2a6f233 | 937 | \membersection{::wxDebugMsg}\label{wxdebugmsg} |
a660d684 KB |
938 | |
939 | \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}} | |
940 | ||
941 | Display a debugging message; under Windows, this will appear on the | |
e2a6f233 | 942 | debugger command window, and under Unix, it will be written to standard |
a660d684 KB |
943 | error. |
944 | ||
945 | The syntax is identical to {\bf printf}: pass a format string and a | |
946 | variable list of arguments. | |
947 | ||
948 | Note that under Windows, you can see the debugging messages without a | |
949 | debugger if you have the DBWIN debug log application that comes with | |
950 | Microsoft C++. | |
951 | ||
952 | {\bf Tip:} under Windows, if your application crashes before the | |
953 | message appears in the debugging window, put a wxYield call after | |
954 | each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s | |
955 | (at least for Watcom C++): preformat your messages and use OutputDebugString | |
956 | instead. | |
957 | ||
6fb26ea3 JS |
958 | This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}. |
959 | ||
954b8ae6 JS |
960 | \wxheading{Include files} |
961 | ||
962 | <wx/utils.h> | |
963 | ||
a660d684 KB |
964 | \membersection{::wxDisplaySize} |
965 | ||
966 | \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}} | |
967 | ||
968 | Gets the physical size of the display in pixels. | |
969 | ||
954b8ae6 JS |
970 | \wxheading{Include files} |
971 | ||
972 | <wx/gdicmn.h> | |
973 | ||
a660d684 KB |
974 | \membersection{::wxEntry}\label{wxentry} |
975 | ||
976 | This initializes wxWindows in a platform-dependent way. Use this if you | |
977 | are not using the default wxWindows entry code (e.g. main or WinMain). For example, | |
978 | you can initialize wxWindows from an Microsoft Foundation Classes application using | |
954b8ae6 | 979 | this function. |
a660d684 KB |
980 | |
981 | \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance}, | |
982 | \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}} | |
983 | ||
984 | wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the | |
985 | function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows | |
986 | message loop will be entered. | |
987 | ||
988 | \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance}, | |
989 | \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}} | |
990 | ||
991 | wxWindows initialization under Windows (for applications constructed as a DLL). | |
992 | ||
993 | \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}} | |
994 | ||
e2a6f233 | 995 | wxWindows initialization under Unix. |
a660d684 | 996 | |
954b8ae6 JS |
997 | \wxheading{Remarks} |
998 | ||
999 | To clean up wxWindows, call wxApp::OnExit followed by the static function | |
1000 | wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows: | |
1001 | ||
1002 | \begin{verbatim} | |
1003 | int CTheApp::ExitInstance() | |
1004 | { | |
1005 | // OnExit isn't called by CleanUp so must be called explicitly. | |
1006 | wxTheApp->OnExit(); | |
1007 | wxApp::CleanUp(); | |
1008 | ||
1009 | return CWinApp::ExitInstance(); | |
1010 | } | |
1011 | \end{verbatim} | |
1012 | ||
1013 | \wxheading{Include files} | |
1014 | ||
1015 | <wx/app.h> | |
1016 | ||
a660d684 KB |
1017 | \membersection{::wxError}\label{wxerror} |
1018 | ||
1019 | \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}} | |
1020 | ||
1021 | Displays {\it msg} and continues. This writes to standard error under | |
e2a6f233 | 1022 | Unix, and pops up a message box under Windows. Used for internal |
a660d684 KB |
1023 | wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}. |
1024 | ||
954b8ae6 JS |
1025 | \wxheading{Include files} |
1026 | ||
1027 | <wx/utils.h> | |
1028 | ||
a660d684 KB |
1029 | \membersection{::wxEndBusyCursor}\label{wxendbusycursor} |
1030 | ||
1031 | \func{void}{wxEndBusyCursor}{\void} | |
1032 | ||
1033 | Changes the cursor back to the original cursor, for all windows in the application. | |
1034 | Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}. | |
1035 | ||
e2a6f233 | 1036 | See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}. |
a660d684 | 1037 | |
954b8ae6 JS |
1038 | \wxheading{Include files} |
1039 | ||
1040 | <wx/utils.h> | |
1041 | ||
a660d684 KB |
1042 | \membersection{::wxExecute}\label{wxexecute} |
1043 | ||
eafc087e | 1044 | \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}} |
a660d684 | 1045 | |
e2a6f233 | 1046 | \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}} |
a660d684 | 1047 | |
e2a6f233 | 1048 | Executes another program in Unix or Windows. |
a660d684 KB |
1049 | |
1050 | The first form takes a command string, such as {\tt "emacs file.txt"}. | |
1051 | ||
1052 | The second form takes an array of values: a command, any number of | |
1053 | arguments, terminated by NULL. | |
1054 | ||
1055 | If {\it sync} is FALSE (the default), flow of control immediately returns. | |
1056 | If TRUE, the current application waits until the other program has terminated. | |
1057 | ||
43bb3699 | 1058 | In the case of synchronous execution, the return value is the exit code of |
e6045e08 VZ |
1059 | the process (which terminates by the moment the function returns) and will be |
1060 | $-1$ if the process couldn't be started and typically 0 if the process | |
34adc693 KB |
1061 | terminated successfully. Also, while waiting for the process to |
1062 | terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller | |
1063 | should ensure that this can cause no recursion, in the simples case by | |
1064 | calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}. | |
e6045e08 VZ |
1065 | |
1066 | For asynchronous execution, however, the return value is the process id and | |
1067 | zero value indicates that the command could not be executed. | |
a660d684 | 1068 | |
7e84f02d VZ |
1069 | If callback isn't NULL and if execution is asynchronous (note that callback |
1070 | parameter can not be non NULL for synchronous execution), | |
eafc087e GL |
1071 | \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when |
1072 | the process finishes. | |
1073 | ||
1074 | See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}. | |
a660d684 | 1075 | |
954b8ae6 JS |
1076 | \wxheading{Include files} |
1077 | ||
1078 | <wx/utils.h> | |
1079 | ||
a660d684 KB |
1080 | \membersection{::wxExit}\label{wxexit} |
1081 | ||
1082 | \func{void}{wxExit}{\void} | |
1083 | ||
1084 | Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}. | |
1085 | Should only be used in an emergency: normally the top-level frame | |
1086 | should be deleted (after deleting all other frames) to terminate the | |
1087 | application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}. | |
1088 | ||
954b8ae6 JS |
1089 | \wxheading{Include files} |
1090 | ||
1091 | <wx/app.h> | |
1092 | ||
a660d684 KB |
1093 | \membersection{::wxFatalError}\label{wxfatalerror} |
1094 | ||
1095 | \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}} | |
1096 | ||
e2a6f233 | 1097 | Displays {\it msg} and exits. This writes to standard error under Unix, |
a660d684 KB |
1098 | and pops up a message box under Windows. Used for fatal internal |
1099 | wxWindows errors. See also \helpref{wxError}{wxerror}. | |
1100 | ||
954b8ae6 JS |
1101 | \wxheading{Include files} |
1102 | ||
1103 | <wx/utils.h> | |
1104 | ||
a660d684 KB |
1105 | \membersection{::wxFindMenuItemId} |
1106 | ||
1107 | \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}} | |
1108 | ||
1109 | Find a menu item identifier associated with the given frame's menu bar. | |
1110 | ||
954b8ae6 JS |
1111 | \wxheading{Include files} |
1112 | ||
1113 | <wx/utils.h> | |
1114 | ||
a660d684 KB |
1115 | \membersection{::wxFindWindowByLabel} |
1116 | ||
1117 | \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}} | |
1118 | ||
1119 | Find a window by its label. Depending on the type of window, the label may be a window title | |
1120 | or panel item label. If {\it parent} is NULL, the search will start from all top-level | |
1121 | frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. | |
1122 | The search is recursive in both cases. | |
1123 | ||
954b8ae6 JS |
1124 | \wxheading{Include files} |
1125 | ||
1126 | <wx/utils.h> | |
1127 | ||
a660d684 KB |
1128 | \membersection{::wxFindWindowByName}\label{wxfindwindowbyname} |
1129 | ||
1130 | \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}} | |
1131 | ||
1132 | Find a window by its name (as given in a window constructor or {\bf Create} function call). | |
1133 | If {\it parent} is NULL, the search will start from all top-level | |
1134 | frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. | |
1135 | The search is recursive in both cases. | |
1136 | ||
1137 | If no such named window is found, {\bf wxFindWindowByLabel} is called. | |
1138 | ||
954b8ae6 JS |
1139 | \wxheading{Include files} |
1140 | ||
1141 | <wx/utils.h> | |
1142 | ||
a660d684 KB |
1143 | \membersection{::wxGetActiveWindow}\label{wxgetactivewindow} |
1144 | ||
1145 | \func{wxWindow *}{wxGetActiveWindow}{\void} | |
1146 | ||
1147 | Gets the currently active window (Windows only). | |
1148 | ||
954b8ae6 JS |
1149 | \wxheading{Include files} |
1150 | ||
1151 | <wx/windows.h> | |
1152 | ||
a660d684 KB |
1153 | \membersection{::wxGetDisplayName}\label{wxgetdisplayname} |
1154 | ||
1155 | \func{wxString}{wxGetDisplayName}{\void} | |
1156 | ||
1157 | Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}. | |
1158 | ||
954b8ae6 JS |
1159 | \wxheading{Include files} |
1160 | ||
1161 | <wx/utils.h> | |
1162 | ||
a660d684 KB |
1163 | \membersection{::wxGetHomeDir} |
1164 | ||
1165 | \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}} | |
1166 | ||
e2a6f233 | 1167 | Fills the buffer with a string representing the user's home directory (Unix only). |
a660d684 | 1168 | |
954b8ae6 JS |
1169 | \wxheading{Include files} |
1170 | ||
1171 | <wx/utils.h> | |
1172 | ||
a660d684 KB |
1173 | \membersection{::wxGetHostName} |
1174 | ||
1175 | \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}} | |
1176 | ||
1177 | Copies the host name of the machine the program is running on into the | |
1178 | buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if | |
e2a6f233 | 1179 | successful. Under Unix, this will return a machine name. Under Windows, |
a660d684 KB |
1180 | this returns ``windows''. |
1181 | ||
954b8ae6 JS |
1182 | \wxheading{Include files} |
1183 | ||
1184 | <wx/utils.h> | |
1185 | ||
a660d684 KB |
1186 | \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime} |
1187 | ||
1188 | \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}} | |
1189 | ||
1190 | Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}. | |
1191 | ||
1192 | If {\it resetTimer} is TRUE (the default), the timer is reset to zero | |
1193 | by this call. | |
1194 | ||
1195 | See also \helpref{wxTimer}{wxtimer}. | |
1196 | ||
954b8ae6 JS |
1197 | \wxheading{Include files} |
1198 | ||
1199 | <wx/timer.h> | |
1200 | ||
e2a6f233 | 1201 | \membersection{::wxGetFreeMemory}\label{wxgetfreememory} |
a660d684 KB |
1202 | |
1203 | \func{long}{wxGetFreeMemory}{\void} | |
1204 | ||
1205 | Returns the amount of free memory in Kbytes under environments which | |
1206 | support it, and -1 if not supported. Currently, returns a positive value | |
e2a6f233 | 1207 | under Windows, and -1 under Unix. |
a660d684 | 1208 | |
954b8ae6 JS |
1209 | \wxheading{Include files} |
1210 | ||
1211 | <wx/utils.h> | |
1212 | ||
a660d684 KB |
1213 | \membersection{::wxGetMousePosition} |
1214 | ||
1215 | \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}} | |
1216 | ||
1217 | Returns the mouse position in screen coordinates. | |
1218 | ||
954b8ae6 JS |
1219 | \wxheading{Include files} |
1220 | ||
1221 | <wx/utils.h> | |
1222 | ||
a660d684 KB |
1223 | \membersection{::wxGetOsVersion} |
1224 | ||
1225 | \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}} | |
1226 | ||
1227 | Gets operating system version information. | |
1228 | ||
1229 | \begin{twocollist}\itemsep=0pt | |
1230 | \twocolitemruled{Platform}{Return tyes} | |
1231 | \twocolitem{Macintosh}{Return value is wxMACINTOSH.} | |
12a44087 | 1232 | \twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) } |
a660d684 KB |
1233 | \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.} |
1234 | \twocolitem{OS/2}{Return value is wxOS2\_PM.} | |
1235 | \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.} | |
1236 | \twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.} | |
1237 | \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.} | |
1238 | \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.} | |
1239 | \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.} | |
1240 | \end{twocollist} | |
1241 | ||
954b8ae6 JS |
1242 | \wxheading{Include files} |
1243 | ||
1244 | <wx/utils.h> | |
1245 | ||
a660d684 KB |
1246 | \membersection{::wxGetResource}\label{wxgetresource} |
1247 | ||
1248 | \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, | |
1249 | \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}} | |
1250 | ||
1251 | \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, | |
1252 | \param{float *}{value}, \param{const wxString\& }{file = NULL}} | |
1253 | ||
1254 | \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, | |
1255 | \param{long *}{value}, \param{const wxString\& }{file = NULL}} | |
1256 | ||
1257 | \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, | |
1258 | \param{int *}{value}, \param{const wxString\& }{file = NULL}} | |
1259 | ||
1260 | Gets a resource value from the resource database (for example, WIN.INI, or | |
1261 | .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used, | |
1262 | otherwise the specified file is used. | |
1263 | ||
e2a6f233 | 1264 | Under X, if an application class (wxApp::GetClassName) has been defined, |
a660d684 KB |
1265 | it is appended to the string /usr/lib/X11/app-defaults/ to try to find |
1266 | an applications default file when merging all resource databases. | |
1267 | ||
1268 | The reason for passing the result in an argument is that it | |
1269 | can be convenient to define a default value, which gets overridden | |
1270 | if the value exists in the resource file. It saves a separate | |
1271 | test for that resource's existence, and it also allows | |
1272 | the overloading of the function for different types. | |
1273 | ||
e2a6f233 | 1274 | See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}. |
a660d684 | 1275 | |
954b8ae6 JS |
1276 | \wxheading{Include files} |
1277 | ||
1278 | <wx/utils.h> | |
1279 | ||
a660d684 KB |
1280 | \membersection{::wxGetUserId} |
1281 | ||
1282 | \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}} | |
1283 | ||
1284 | Copies the user's login identity (such as ``jacs'') into the buffer {\it | |
1285 | buf}, of maximum size {\it bufSize}, returning TRUE if successful. | |
1286 | Under Windows, this returns ``user''. | |
1287 | ||
954b8ae6 JS |
1288 | \wxheading{Include files} |
1289 | ||
1290 | <wx/utils.h> | |
1291 | ||
a660d684 KB |
1292 | \membersection{::wxGetUserName} |
1293 | ||
1294 | \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}} | |
1295 | ||
1296 | Copies the user's name (such as ``Julian Smart'') into the buffer {\it | |
1297 | buf}, of maximum size {\it bufSize}, returning TRUE if successful. | |
1298 | Under Windows, this returns ``unknown''. | |
1299 | ||
954b8ae6 JS |
1300 | \wxheading{Include files} |
1301 | ||
1302 | <wx/utils.h> | |
1303 | ||
a660d684 KB |
1304 | \membersection{::wxKill}\label{wxkill} |
1305 | ||
1306 | \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}} | |
1307 | ||
e2a6f233 | 1308 | Under Unix (the only supported platform), equivalent to the Unix kill function. |
a660d684 KB |
1309 | Returns 0 on success, -1 on failure. |
1310 | ||
1311 | Tip: sending a signal of 0 to a process returns -1 if the process does not exist. | |
1312 | It does not raise a signal in the receiving process. | |
1313 | ||
954b8ae6 | 1314 | \wxheading{Include files} |
a660d684 | 1315 | |
954b8ae6 | 1316 | <wx/utils.h> |
a660d684 | 1317 | |
a660d684 KB |
1318 | \membersection{::wxIsBusy}\label{wxisbusy} |
1319 | ||
1320 | \func{bool}{wxIsBusy}{\void} | |
1321 | ||
1322 | Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp | |
1323 | \helpref{wxEndBusyCursor}{wxendbusycursor} calls. | |
1324 | ||
e2a6f233 JS |
1325 | See also \helpref{wxBusyCursor}{wxbusycursor}. |
1326 | ||
954b8ae6 JS |
1327 | \wxheading{Include files} |
1328 | ||
1329 | <wx/utils.h> | |
1330 | ||
a660d684 KB |
1331 | \membersection{::wxLoadUserResource}\label{wxloaduserresource} |
1332 | ||
1333 | \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}} | |
1334 | ||
1335 | Loads a user-defined Windows resource as a string. If the resource is found, the function creates | |
1336 | a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned. | |
1337 | ||
1338 | The resource must be defined in the {\tt .rc} file using the following syntax: | |
1339 | ||
1340 | \begin{verbatim} | |
1341 | myResource TEXT file.ext | |
1342 | \end{verbatim} | |
1343 | ||
1344 | where {\tt file.ext} is a file that the resource compiler can find. | |
1345 | ||
1346 | One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers | |
1347 | cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed | |
1348 | using \helpref{wxResourceParseString}{wxresourceparsestring}. | |
1349 | ||
1350 | This function is available under Windows only. | |
1351 | ||
954b8ae6 JS |
1352 | \wxheading{Include files} |
1353 | ||
1354 | <wx/utils.h> | |
1355 | ||
a660d684 KB |
1356 | \membersection{::wxNow}\label{wxnow} |
1357 | ||
1358 | \func{wxString}{wxNow}{\void} | |
1359 | ||
1360 | Returns a string representing the current date and time. | |
1361 | ||
954b8ae6 JS |
1362 | \wxheading{Include files} |
1363 | ||
1364 | <wx/utils.h> | |
1365 | ||
a660d684 KB |
1366 | \membersection{::wxPostDelete}\label{wxpostdelete} |
1367 | ||
1368 | \func{void}{wxPostDelete}{\param{wxObject *}{object}} | |
1369 | ||
954b8ae6 | 1370 | Tells the system to delete the specified object when |
a660d684 KB |
1371 | all other events have been processed. In some environments, it is |
1372 | necessary to use this instead of deleting a frame directly with the | |
954b8ae6 | 1373 | delete operator, because some GUIs will still send events to a deleted window. |
a660d684 KB |
1374 | |
1375 | Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead. | |
1376 | ||
954b8ae6 JS |
1377 | \wxheading{Include files} |
1378 | ||
1379 | <wx/utils.h> | |
1380 | ||
6776a0b2 | 1381 | \membersection{::wxSafeYield}\label{wxsafeyield} |
43bb3699 VZ |
1382 | |
1383 | \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}} | |
1384 | ||
1385 | This function is similar to wxYield, except that it disables the user input to | |
a818ccea KB |
1386 | all program windows before calling wxYield and re-enables it again |
1387 | afterwards. If {\it win} is not NULL, this window will remain enabled, | |
1388 | allowing the implementation of some limited user interaction. | |
43bb3699 VZ |
1389 | |
1390 | Returns the result of the call to \helpref{::wxYield}{wxyield}. | |
1391 | ||
1392 | \wxheading{Include files} | |
1393 | ||
1394 | <wx/utils.h> | |
1395 | ||
6776a0b2 | 1396 | \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows} |
95dee651 KB |
1397 | |
1398 | \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}} | |
1399 | ||
1400 | This function enables or disables all top level windows. It is used by | |
1401 | \helpref{::wxSafeYield}{wxsafeyield}. | |
1402 | ||
1403 | \wxheading{Include files} | |
1404 | ||
1405 | <wx/utils.h> | |
1406 | ||
1407 | ||
a660d684 KB |
1408 | \membersection{::wxSetDisplayName}\label{wxsetdisplayname} |
1409 | ||
1410 | \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}} | |
1411 | ||
1412 | Under X only, sets the current display name. This is the X host and display name such | |
1413 | as ``colonsay:0.0", and the function indicates which display should be used for creating | |
1414 | windows from this point on. Setting the display within an application allows multiple | |
1415 | displays to be used. | |
1416 | ||
1417 | See also \helpref{wxGetDisplayName}{wxgetdisplayname}. | |
1418 | ||
954b8ae6 JS |
1419 | \wxheading{Include files} |
1420 | ||
1421 | <wx/utils.h> | |
1422 | ||
a660d684 KB |
1423 | \membersection{::wxShell}\label{wxshell} |
1424 | ||
1425 | \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}} | |
1426 | ||
1427 | Executes a command in an interactive shell window. If no command is | |
1428 | specified, then just the shell is spawned. | |
1429 | ||
1430 | See also \helpref{wxExecute}{wxexecute}. | |
1431 | ||
954b8ae6 JS |
1432 | \wxheading{Include files} |
1433 | ||
1434 | <wx/utils.h> | |
1435 | ||
e2a6f233 | 1436 | \membersection{::wxSleep}\label{wxsleep} |
a660d684 KB |
1437 | |
1438 | \func{void}{wxSleep}{\param{int}{ secs}} | |
1439 | ||
e2a6f233 | 1440 | Sleeps for the specified number of seconds. |
a660d684 | 1441 | |
954b8ae6 JS |
1442 | \wxheading{Include files} |
1443 | ||
1444 | <wx/utils.h> | |
1445 | ||
a660d684 KB |
1446 | \membersection{::wxStripMenuCodes} |
1447 | ||
8a2c6ef8 JS |
1448 | \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}} |
1449 | ||
1450 | \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}} | |
a660d684 KB |
1451 | |
1452 | Strips any menu codes from {\it in} and places the result | |
8a2c6ef8 JS |
1453 | in {\it out} (or returns the new string, in the first form). |
1454 | ||
1455 | Menu codes include \& (mark the next character with an underline | |
a660d684 KB |
1456 | as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows). |
1457 | ||
954b8ae6 JS |
1458 | \wxheading{Include files} |
1459 | ||
1460 | <wx/utils.h> | |
1461 | ||
a660d684 KB |
1462 | \membersection{::wxStartTimer}\label{wxstarttimer} |
1463 | ||
1464 | \func{void}{wxStartTimer}{\void} | |
1465 | ||
1466 | Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time. | |
1467 | ||
1468 | See also \helpref{wxTimer}{wxtimer}. | |
1469 | ||
954b8ae6 JS |
1470 | \wxheading{Include files} |
1471 | ||
1472 | <wx/timer.h> | |
1473 | ||
a660d684 KB |
1474 | \membersection{::wxToLower}\label{wxtolower} |
1475 | ||
1476 | \func{char}{wxToLower}{\param{char }{ch}} | |
1477 | ||
1478 | Converts the character to lower case. This is implemented as a macro for efficiency. | |
1479 | ||
954b8ae6 JS |
1480 | \wxheading{Include files} |
1481 | ||
1482 | <wx/utils.h> | |
1483 | ||
a660d684 KB |
1484 | \membersection{::wxToUpper}\label{wxtoupper} |
1485 | ||
1486 | \func{char}{wxToUpper}{\param{char }{ch}} | |
1487 | ||
1488 | Converts the character to upper case. This is implemented as a macro for efficiency. | |
1489 | ||
954b8ae6 JS |
1490 | \wxheading{Include files} |
1491 | ||
1492 | <wx/utils.h> | |
1493 | ||
a660d684 KB |
1494 | \membersection{::wxTrace}\label{wxtrace} |
1495 | ||
1496 | \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}} | |
1497 | ||
1498 | Takes printf-style variable argument syntax. Output | |
1499 | is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}). | |
1500 | ||
6fb26ea3 JS |
1501 | This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}. |
1502 | ||
954b8ae6 JS |
1503 | \wxheading{Include files} |
1504 | ||
1505 | <wx/memory.h> | |
1506 | ||
a660d684 KB |
1507 | \membersection{::wxTraceLevel}\label{wxtracelevel} |
1508 | ||
1509 | \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}} | |
1510 | ||
1511 | Takes printf-style variable argument syntax. Output | |
1512 | is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}). | |
1513 | The first argument should be the level at which this information is appropriate. | |
1514 | It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than | |
1515 | this value. | |
1516 | ||
6fb26ea3 JS |
1517 | This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}. |
1518 | ||
954b8ae6 JS |
1519 | \wxheading{Include files} |
1520 | ||
1521 | <wx/memory.h> | |
1522 | ||
afb74891 VZ |
1523 | \membersection{::wxUsleep}\label{wxusleep} |
1524 | ||
1525 | \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}} | |
1526 | ||
1527 | Sleeps for the specified number of milliseconds. Notice that usage of this | |
1528 | function is encouraged instead of calling usleep(3) directly because the | |
1529 | standard usleep() function is not MT safe. | |
1530 | ||
1531 | \wxheading{Include files} | |
1532 | ||
1533 | <wx/utils.h> | |
1534 | ||
a660d684 KB |
1535 | \membersection{::wxWriteResource}\label{wxwriteresource} |
1536 | ||
1537 | \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, | |
1538 | \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}} | |
1539 | ||
1540 | \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, | |
1541 | \param{float }{value}, \param{const wxString\& }{file = NULL}} | |
1542 | ||
1543 | \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, | |
1544 | \param{long }{value}, \param{const wxString\& }{file = NULL}} | |
1545 | ||
1546 | \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, | |
1547 | \param{int }{value}, \param{const wxString\& }{file = NULL}} | |
1548 | ||
1549 | Writes a resource value into the resource database (for example, WIN.INI, or | |
1550 | .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used, | |
1551 | otherwise the specified file is used. | |
1552 | ||
1553 | Under X, the resource databases are cached until the internal function | |
1554 | \rtfsp{\bf wxFlushResources} is called automatically on exit, when | |
1555 | all updated resource databases are written to their files. | |
1556 | ||
1557 | Note that it is considered bad manners to write to the .Xdefaults | |
e2a6f233 | 1558 | file under Unix, although the WIN.INI file is fair game under Windows. |
a660d684 | 1559 | |
e2a6f233 | 1560 | See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}. |
a660d684 | 1561 | |
954b8ae6 JS |
1562 | \wxheading{Include files} |
1563 | ||
1564 | <wx/utils.h> | |
1565 | ||
fd34e3a5 | 1566 | \membersection{::wxYield}\label{wxyield} |
a660d684 KB |
1567 | |
1568 | \func{bool}{wxYield}{\void} | |
1569 | ||
1570 | Yields control to pending messages in the windowing system. This can be useful, for example, when a | |
1571 | time-consuming process writes to a text window. Without an occasional | |
1572 | yield, the text window will not be updated properly, and (since Windows | |
1573 | multitasking is cooperative) other processes will not respond. | |
1574 | ||
1575 | Caution should be exercised, however, since yielding may allow the | |
1576 | user to perform actions which are not compatible with the current task. | |
1577 | Disabling menu items or whole menus during processing can avoid unwanted | |
43bb3699 VZ |
1578 | reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better |
1579 | function. | |
a660d684 | 1580 | |
954b8ae6 JS |
1581 | \wxheading{Include files} |
1582 | ||
1583 | <wx/utils.h> | |
1584 | ||
a660d684 KB |
1585 | \section{Macros}\label{macros} |
1586 | ||
1587 | These macros are defined in wxWindows. | |
1588 | ||
1589 | \membersection{CLASSINFO}\label{classinfo} | |
1590 | ||
1591 | \func{wxClassInfo *}{CLASSINFO}{className} | |
1592 | ||
1593 | Returns a pointer to the wxClassInfo object associated with this class. | |
1594 | ||
954b8ae6 JS |
1595 | \wxheading{Include files} |
1596 | ||
1597 | <wx/object.h> | |
1598 | ||
a660d684 KB |
1599 | \membersection{DECLARE\_ABSTRACT\_CLASS} |
1600 | ||
1601 | \func{}{DECLARE\_ABSTRACT\_CLASS}{className} | |
1602 | ||
1603 | Used inside a class declaration to declare that the class should be | |
1604 | made known to the class hierarchy, but objects of this class cannot be created | |
1605 | dynamically. The same as DECLARE\_CLASS. | |
1606 | ||
1607 | Example: | |
1608 | ||
1609 | \begin{verbatim} | |
1610 | class wxCommand: public wxObject | |
1611 | { | |
1612 | DECLARE_ABSTRACT_CLASS(wxCommand) | |
1613 | ||
1614 | private: | |
1615 | ... | |
1616 | public: | |
1617 | ... | |
1618 | }; | |
1619 | \end{verbatim} | |
1620 | ||
954b8ae6 JS |
1621 | \wxheading{Include files} |
1622 | ||
1623 | <wx/object.h> | |
1624 | ||
a660d684 KB |
1625 | \membersection{DECLARE\_APP}\label{declareapp} |
1626 | ||
1627 | \func{}{DECLARE\_APP}{className} | |
1628 | ||
1629 | This is used in headers to create a forward declaration of the wxGetApp function implemented | |
1630 | by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}. | |
1631 | ||
1632 | Example: | |
1633 | ||
1634 | \begin{verbatim} | |
1635 | DECLARE_APP(MyApp) | |
1636 | \end{verbatim} | |
1637 | ||
954b8ae6 JS |
1638 | \wxheading{Include files} |
1639 | ||
1640 | <wx/app.h> | |
1641 | ||
a660d684 KB |
1642 | \membersection{DECLARE\_CLASS} |
1643 | ||
1644 | \func{}{DECLARE\_CLASS}{className} | |
1645 | ||
1646 | Used inside a class declaration to declare that the class should be | |
1647 | made known to the class hierarchy, but objects of this class cannot be created | |
1648 | dynamically. The same as DECLARE\_ABSTRACT\_CLASS. | |
1649 | ||
954b8ae6 JS |
1650 | \wxheading{Include files} |
1651 | ||
1652 | <wx/object.h> | |
1653 | ||
a660d684 KB |
1654 | \membersection{DECLARE\_DYNAMIC\_CLASS} |
1655 | ||
1656 | \func{}{DECLARE\_DYNAMIC\_CLASS}{className} | |
1657 | ||
1658 | Used inside a class declaration to declare that the objects of this class should be dynamically | |
1659 | createable from run-time type information. | |
1660 | ||
1661 | Example: | |
1662 | ||
1663 | \begin{verbatim} | |
1664 | class wxFrame: public wxWindow | |
1665 | { | |
1666 | DECLARE_DYNAMIC_CLASS(wxFrame) | |
1667 | ||
1668 | private: | |
1669 | const wxString\& frameTitle; | |
1670 | public: | |
1671 | ... | |
1672 | }; | |
1673 | \end{verbatim} | |
1674 | ||
954b8ae6 JS |
1675 | \wxheading{Include files} |
1676 | ||
1677 | <wx/object.h> | |
1678 | ||
a660d684 KB |
1679 | \membersection{IMPLEMENT\_ABSTRACT\_CLASS} |
1680 | ||
1681 | \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName} | |
1682 | ||
1683 | Used in a C++ implementation file to complete the declaration of | |
1684 | a class that has run-time type information. The same as IMPLEMENT\_CLASS. | |
1685 | ||
1686 | Example: | |
1687 | ||
1688 | \begin{verbatim} | |
1689 | IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject) | |
1690 | ||
1691 | wxCommand::wxCommand(void) | |
1692 | { | |
1693 | ... | |
1694 | } | |
1695 | \end{verbatim} | |
1696 | ||
954b8ae6 JS |
1697 | \wxheading{Include files} |
1698 | ||
1699 | <wx/object.h> | |
1700 | ||
a660d684 KB |
1701 | \membersection{IMPLEMENT\_ABSTRACT\_CLASS2} |
1702 | ||
1703 | \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2} | |
1704 | ||
1705 | Used in a C++ implementation file to complete the declaration of | |
1706 | a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2. | |
1707 | ||
954b8ae6 JS |
1708 | \wxheading{Include files} |
1709 | ||
1710 | <wx/object.h> | |
1711 | ||
a660d684 KB |
1712 | \membersection{IMPLEMENT\_APP}\label{implementapp} |
1713 | ||
1714 | \func{}{IMPLEMENT\_APP}{className} | |
1715 | ||
1716 | This is used in the application class implementation file to make the application class known to | |
1717 | wxWindows for dynamic construction. You use this instead of | |
1718 | ||
1719 | Old form: | |
1720 | ||
1721 | \begin{verbatim} | |
1722 | MyApp myApp; | |
1723 | \end{verbatim} | |
1724 | ||
1725 | New form: | |
1726 | ||
1727 | \begin{verbatim} | |
1728 | IMPLEMENT_APP(MyApp) | |
1729 | \end{verbatim} | |
1730 | ||
1731 | See also \helpref{DECLARE\_APP}{declareapp}. | |
1732 | ||
954b8ae6 JS |
1733 | \wxheading{Include files} |
1734 | ||
1735 | <wx/app.h> | |
1736 | ||
a660d684 KB |
1737 | \membersection{IMPLEMENT\_CLASS} |
1738 | ||
1739 | \func{}{IMPLEMENT\_CLASS}{className, baseClassName} | |
1740 | ||
1741 | Used in a C++ implementation file to complete the declaration of | |
1742 | a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS. | |
1743 | ||
954b8ae6 JS |
1744 | \wxheading{Include files} |
1745 | ||
1746 | <wx/object.h> | |
1747 | ||
a660d684 KB |
1748 | \membersection{IMPLEMENT\_CLASS2} |
1749 | ||
1750 | \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2} | |
1751 | ||
1752 | Used in a C++ implementation file to complete the declaration of a | |
1753 | class that has run-time type information and two base classes. The | |
1754 | same as IMPLEMENT\_ABSTRACT\_CLASS2. | |
1755 | ||
954b8ae6 JS |
1756 | \wxheading{Include files} |
1757 | ||
1758 | <wx/object.h> | |
1759 | ||
a660d684 KB |
1760 | \membersection{IMPLEMENT\_DYNAMIC\_CLASS} |
1761 | ||
1762 | \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName} | |
1763 | ||
1764 | Used in a C++ implementation file to complete the declaration of | |
1765 | a class that has run-time type information, and whose instances | |
1766 | can be created dynamically. | |
1767 | ||
1768 | Example: | |
1769 | ||
1770 | \begin{verbatim} | |
1771 | IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow) | |
1772 | ||
1773 | wxFrame::wxFrame(void) | |
1774 | { | |
1775 | ... | |
1776 | } | |
1777 | \end{verbatim} | |
1778 | ||
954b8ae6 JS |
1779 | \wxheading{Include files} |
1780 | ||
1781 | <wx/object.h> | |
1782 | ||
a660d684 KB |
1783 | \membersection{IMPLEMENT\_DYNAMIC\_CLASS2} |
1784 | ||
1785 | \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2} | |
1786 | ||
1787 | Used in a C++ implementation file to complete the declaration of | |
1788 | a class that has run-time type information, and whose instances | |
1789 | can be created dynamically. Use this for classes derived from two | |
1790 | base classes. | |
1791 | ||
954b8ae6 JS |
1792 | \wxheading{Include files} |
1793 | ||
1794 | <wx/object.h> | |
1795 | ||
34636400 VZ |
1796 | \membersection{WXDEBUG\_NEW}\label{debugnew} |
1797 | ||
1798 | \func{}{WXDEBUG\_NEW}{arg} | |
1799 | ||
1800 | This is defined in debug mode to be call the redefined new operator | |
1801 | with filename and line number arguments. The definition is: | |
1802 | ||
1803 | \begin{verbatim} | |
1804 | #define WXDEBUG_NEW new(__FILE__,__LINE__) | |
1805 | \end{verbatim} | |
1806 | ||
1807 | In non-debug mode, this is defined as the normal new operator. | |
1808 | ||
1809 | \wxheading{Include files} | |
1810 | ||
1811 | <wx/object.h> | |
1812 | ||
1813 | \membersection{wxDynamicCast}\label{wxdynamiccast} | |
1814 | ||
1815 | \func{}{wxDynamicCast}{ptr, classname} | |
1816 | ||
1817 | This macro returns the pointer {\it ptr} cast to the type {\it classname *} if | |
1818 | the pointer is of this type (the check is done during the run-time) or NULL | |
1819 | otherwise. Usage of this macro is prefered over obsoleted wxObject::IsKindOf() | |
1820 | function. | |
1821 | ||
1822 | The {\it ptr} argument may be NULL, in which case NULL will be returned. | |
1823 | ||
1824 | Example: | |
1825 | ||
1826 | \begin{verbatim} | |
1827 | wxWindow *win = wxWindow::FindFocus(); | |
1828 | wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl); | |
1829 | if ( text ) | |
1830 | { | |
1831 | // a text control has the focus... | |
1832 | } | |
1833 | else | |
1834 | { | |
1835 | // no window has the focus or it's not a text control | |
1836 | } | |
1837 | \end{verbatim} | |
1838 | ||
1839 | \wxheading{See also} | |
1840 | ||
1841 | \helpref{RTTI overview}{runtimeclassoverview} | |
1842 | ||
a660d684 KB |
1843 | \membersection{WXTRACE}\label{trace} |
1844 | ||
34636400 VZ |
1845 | \wxheading{Include files} |
1846 | ||
1847 | <wx/object.h> | |
1848 | ||
a660d684 KB |
1849 | \func{}{WXTRACE}{formatString, ...} |
1850 | ||
1851 | Calls wxTrace with printf-style variable argument syntax. Output | |
1852 | is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}). | |
1853 | ||
6fb26ea3 JS |
1854 | This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}. |
1855 | ||
954b8ae6 JS |
1856 | \wxheading{Include files} |
1857 | ||
1858 | <wx/memory.h> | |
1859 | ||
a660d684 KB |
1860 | \membersection{WXTRACELEVEL}\label{tracelevel} |
1861 | ||
1862 | \func{}{WXTRACELEVEL}{level, formatString, ...} | |
1863 | ||
1864 | Calls wxTraceLevel with printf-style variable argument syntax. Output | |
1865 | is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}). | |
1866 | The first argument should be the level at which this information is appropriate. | |
1867 | It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than | |
1868 | this value. | |
1869 | ||
6fb26ea3 JS |
1870 | This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}. |
1871 | ||
954b8ae6 JS |
1872 | \wxheading{Include files} |
1873 | ||
1874 | <wx/memory.h> | |
1875 | ||
a660d684 KB |
1876 | \section{wxWindows resource functions}\label{resourcefuncs} |
1877 | ||
1878 | \overview{wxWindows resource system}{resourceformats} | |
1879 | ||
1880 | This section details functions for manipulating wxWindows (.WXR) resource | |
1881 | files and loading user interface elements from resources. | |
1882 | ||
1883 | \normalbox{Please note that this use of the word `resource' is different from that used when talking | |
1884 | about initialisation file resource reading and writing, using such functions | |
1885 | as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.} | |
1886 | ||
1887 | \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.} | |
1888 | ||
1889 | See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for | |
1890 | loading from resource data. | |
1891 | ||
954b8ae6 JS |
1892 | {\bf Warning:} this needs updating for wxWindows 2. |
1893 | ||
a660d684 KB |
1894 | \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier} |
1895 | ||
1896 | \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}} | |
1897 | ||
1898 | Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp | |
1899 | \verb$#$defining a name to an integer). Unlikely to be used by an application except | |
1900 | perhaps for implementing resource functionality for interpreted languages. | |
1901 | ||
1902 | \membersection{::wxResourceClear} | |
1903 | ||
1904 | \func{void}{wxResourceClear}{\void} | |
1905 | ||
1906 | Clears the wxWindows resource table. | |
1907 | ||
1908 | \membersection{::wxResourceCreateBitmap} | |
1909 | ||
1910 | \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}} | |
1911 | ||
1912 | Creates a new bitmap from a file, static data, or Windows resource, given a valid | |
1913 | wxWindows bitmap resource identifier. For example, if the .WXR file contains | |
1914 | the following: | |
1915 | ||
1916 | \begin{verbatim} | |
1917 | static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\ | |
1918 | bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\ | |
1919 | bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X'])."; | |
1920 | \end{verbatim} | |
1921 | ||
1922 | then this function can be called as follows: | |
1923 | ||
1924 | \begin{verbatim} | |
1925 | wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource"); | |
1926 | \end{verbatim} | |
1927 | ||
1928 | \membersection{::wxResourceCreateIcon} | |
1929 | ||
1930 | \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}} | |
1931 | ||
1932 | Creates a new icon from a file, static data, or Windows resource, given a valid | |
1933 | wxWindows icon resource identifier. For example, if the .WXR file contains | |
1934 | the following: | |
1935 | ||
1936 | \begin{verbatim} | |
1937 | static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\ | |
1938 | icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\ | |
1939 | icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X'])."; | |
1940 | \end{verbatim} | |
1941 | ||
1942 | then this function can be called as follows: | |
1943 | ||
1944 | \begin{verbatim} | |
1945 | wxIcon *icon = wxResourceCreateIcon("aiai_resource"); | |
1946 | \end{verbatim} | |
1947 | ||
1948 | \membersection{::wxResourceCreateMenuBar} | |
1949 | ||
1950 | \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}} | |
1951 | ||
1952 | Creates a new menu bar given a valid wxWindows menubar resource | |
1953 | identifier. For example, if the .WXR file contains the following: | |
1954 | ||
1955 | \begin{verbatim} | |
1956 | static const wxString\& menuBar11 = "menu(name = 'menuBar11',\ | |
1957 | menu = \ | |
1958 | [\ | |
1959 | ['&File', 1, '', \ | |
1960 | ['&Open File', 2, 'Open a file'],\ | |
1961 | ['&Save File', 3, 'Save a file'],\ | |
1962 | [],\ | |
1963 | ['E&xit', 4, 'Exit program']\ | |
1964 | ],\ | |
1965 | ['&Help', 5, '', \ | |
1966 | ['&About', 6, 'About this program']\ | |
1967 | ]\ | |
1968 | ])."; | |
1969 | \end{verbatim} | |
1970 | ||
1971 | then this function can be called as follows: | |
1972 | ||
1973 | \begin{verbatim} | |
1974 | wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11"); | |
1975 | \end{verbatim} | |
1976 | ||
1977 | ||
1978 | \membersection{::wxResourceGetIdentifier} | |
1979 | ||
1980 | \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}} | |
1981 | ||
1982 | Used for retrieving the integer value associated with an identifier. | |
1983 | A zero value indicates that the identifier was not found. | |
1984 | ||
1985 | See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}. | |
1986 | ||
1987 | \membersection{::wxResourceParseData}\label{wxresourcedata} | |
1988 | ||
1989 | \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}} | |
1990 | ||
1991 | Parses a string containing one or more wxWindows resource objects. If | |
1992 | the resource objects are global static data that are included into the | |
1993 | C++ program, then this function must be called for each variable | |
1994 | containing the resource data, to make it known to wxWindows. | |
1995 | ||
1996 | {\it resource} should contain data in the following form: | |
1997 | ||
1998 | \begin{verbatim} | |
1999 | dialog(name = 'dialog1', | |
2000 | style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE', | |
2001 | title = 'Test dialog box', | |
2002 | x = 312, y = 234, width = 400, height = 300, | |
2003 | modal = 0, | |
2004 | control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262, | |
2005 | [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]], | |
2006 | control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3', | |
2007 | 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.', | |
2008 | [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0], | |
2009 | [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]). | |
2010 | \end{verbatim} | |
2011 | ||
2012 | This function will typically be used after including a {\tt .wxr} file into | |
2013 | a C++ program as follows: | |
2014 | ||
2015 | \begin{verbatim} | |
2016 | #include "dialog1.wxr" | |
2017 | \end{verbatim} | |
2018 | ||
2019 | Each of the contained resources will declare a new C++ variable, and each | |
2020 | of these variables should be passed to wxResourceParseData. | |
2021 | ||
2022 | \membersection{::wxResourceParseFile} | |
2023 | ||
2024 | \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}} | |
2025 | ||
2026 | Parses a file containing one or more wxWindows resource objects | |
2027 | in C++-compatible syntax. Use this function to dynamically load | |
2028 | wxWindows resource data. | |
2029 | ||
2030 | \membersection{::wxResourceParseString}\label{wxresourceparsestring} | |
2031 | ||
2032 | \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}} | |
2033 | ||
2034 | Parses a string containing one or more wxWindows resource objects. If | |
2035 | the resource objects are global static data that are included into the | |
2036 | C++ program, then this function must be called for each variable | |
2037 | containing the resource data, to make it known to wxWindows. | |
2038 | ||
2039 | {\it resource} should contain data with the following form: | |
2040 | ||
2041 | \begin{verbatim} | |
2042 | static const wxString\& dialog1 = "dialog(name = 'dialog1',\ | |
2043 | style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\ | |
2044 | title = 'Test dialog box',\ | |
2045 | x = 312, y = 234, width = 400, height = 300,\ | |
2046 | modal = 0,\ | |
2047 | control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\ | |
2048 | [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\ | |
2049 | control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\ | |
2050 | 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\ | |
2051 | [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\ | |
2052 | [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]])."; | |
2053 | \end{verbatim} | |
2054 | ||
2055 | This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to | |
2056 | load an entire {\tt .wxr file} into a string. | |
2057 | ||
2058 | \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata} | |
2059 | ||
2060 | \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width}, | |
2061 | \param{int }{height}, \param{wxResourceTable *}{table = NULL}} | |
2062 | ||
2063 | \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}} | |
2064 | ||
2065 | Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system. | |
2066 | This is required if other resources will use the bitmap data, since otherwise there | |
2067 | is no connection between names used in resources, and the global bitmap data. | |
2068 | ||
2069 | \membersection{::wxResourceRegisterIconData} | |
2070 | ||
2071 | Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}. | |
2072 | ||
6fb26ea3 JS |
2073 | \section{Log functions}\label{logfunctions} |
2074 | ||
2075 | These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for | |
2076 | further information. | |
2077 | ||
954b8ae6 JS |
2078 | \wxheading{Include files} |
2079 | ||
2080 | <wx/log.h> | |
2081 | ||
6fb26ea3 JS |
2082 | \membersection{::wxLogError}\label{wxlogerror} |
2083 | ||
2084 | \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}} | |
2085 | ||
2086 | The function to use for error messages, i.e. the | |
2087 | messages that must be shown to the user. The default processing is to pop up a | |
2088 | message box to inform the user about it. | |
2089 | ||
2090 | \membersection{::wxLogFatalError}\label{wxlogfatalerror} | |
2091 | ||
2092 | \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}} | |
2093 | ||
2094 | Like \helpref{wxLogError}{wxlogerror}, but also | |
2095 | terminates the program with the exit code 3. Using {\it abort()} standard | |
2096 | function also terminates the program with this exit code. | |
2097 | ||
2098 | \membersection{::wxLogWarning}\label{wxlogwarning} | |
2099 | ||
2100 | \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}} | |
2101 | ||
2102 | For warnings - they are also normally shown to the | |
2103 | user, but don't interrupt the program work. | |
2104 | ||
2105 | \membersection{::wxLogMessage}\label{wxlogmessage} | |
2106 | ||
2107 | \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}} | |
2108 | ||
2109 | for all normal, informational messages. They also | |
2110 | appear in a message box by default (but it can be changed). Notice | |
2111 | that the standard behaviour is to not show informational messages if there are | |
2112 | any errors later - the logic being that the later error messages make the | |
2113 | informational messages preceding them meaningless. | |
2114 | ||
2115 | \membersection{::wxLogVerbose}\label{wxlogverbose} | |
2116 | ||
2117 | \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}} | |
2118 | ||
2119 | For verbose output. Normally, it's suppressed, but | |
2120 | might be activated if the user wishes to know more details about the program | |
2121 | progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}). | |
2122 | ||
2123 | \membersection{::wxLogStatus}\label{wxlogstatus} | |
2124 | ||
2125 | \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}} | |
2126 | ||
2127 | For status messages - they will go into the status | |
2128 | bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one. | |
2129 | ||
2130 | \membersection{::wxLogSysError}\label{wxlogsyserror} | |
2131 | ||
2132 | \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}} | |
2133 | ||
2134 | Mostly used by wxWindows itself, but might be | |
2135 | handy for logging errors after system call (API function) failure. It logs the | |
2136 | specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending | |
2137 | on the platform) and the corresponding error | |
2138 | message. The second form of this function takes the error code explitly as the | |
2139 | first argument. | |
2140 | ||
2141 | \membersection{::wxLogDebug}\label{wxlogdebug} | |
2142 | ||
2143 | \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}} | |
2144 | ||
2145 | The right function for debug output. It only | |
2146 | does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) | |
2147 | and expands to nothing in release mode (otherwise). | |
2148 | ||
2149 | \membersection{::wxLogTrace}\label{wxlogtrace} | |
2150 | ||
2151 | \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}} | |
2152 | ||
2153 | \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}} | |
2154 | ||
2155 | As {\bf wxLogDebug}, only does something in debug | |
2156 | build. The reason for making it a separate function from it is that usually | |
2157 | there are a lot of trace messages, so it might make sense to separate them | |
2158 | from other debug messages which would be flooded in them. Moreover, the second | |
2159 | version of this function takes a trace mask as the first argument which allows | |
2160 | to further restrict the amount of messages generated. The value of {\it mask} can be: | |
2161 | ||
2162 | \begin{itemize}\itemsep=0pt | |
2163 | \item wxTraceMemAlloc: trace memory allocation (new/delete) | |
2164 | \item wxTraceMessages: trace window messages/X callbacks | |
2165 | \item wxTraceResAlloc: trace GDI resource allocation | |
2166 | \item wxTraceRefCount: trace various ref counting operations | |
2167 | \end{itemize} | |
2168 | ||
2169 | \section{Debugging macros and functions}\label{debugmacros} | |
2170 | ||
2171 | Useful macros and functins for error checking and defensive programming. ASSERTs are only | |
2172 | compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release | |
2173 | builds. | |
2174 | ||
954b8ae6 JS |
2175 | \wxheading{Include files} |
2176 | ||
2177 | <wx/debug.h> | |
2178 | ||
6fb26ea3 JS |
2179 | \membersection{::wxOnAssert}\label{wxonassert} |
2180 | ||
2181 | \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}} | |
2182 | ||
2183 | This function may be redefined to do something non trivial and is called | |
2184 | whenever one of debugging macros fails (i.e. condition is false in an | |
5b6aa0ff JS |
2185 | assertion). |
2186 | % TODO: this should probably be an overridable in wxApp. | |
6fb26ea3 JS |
2187 | |
2188 | \membersection{wxASSERT}\label{wxassert} | |
2189 | ||
2190 | \func{}{wxASSERT}{\param{}{condition}} | |
2191 | ||
b207457c VZ |
2192 | Assert macro. An error message will be generated if the condition is FALSE in |
2193 | debug mode, but nothing will be done in the release build. | |
2194 | ||
2195 | Please note that the condition in wxASSERT() should have no side effects | |
2196 | because it will not be executed in release mode at all. | |
2197 | ||
2198 | See also: \helpref{wxASSERT\_MSG}{wxassertmsg} | |
6fb26ea3 JS |
2199 | |
2200 | \membersection{wxASSERT\_MSG}\label{wxassertmsg} | |
2201 | ||
2202 | \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}} | |
2203 | ||
2204 | Assert macro with message. An error message will be generated if the condition is FALSE. | |
2205 | ||
b207457c VZ |
2206 | See also: \helpref{wxASSERT}{wxassert} |
2207 | ||
6fb26ea3 JS |
2208 | \membersection{wxFAIL}\label{wxfail} |
2209 | ||
b207457c | 2210 | \func{}{wxFAIL}{\void} |
6fb26ea3 JS |
2211 | |
2212 | Will always generate an assert error if this code is reached (in debug mode). | |
2213 | ||
b207457c VZ |
2214 | See also: \helpref{wxFAIL\_MSG}{wxfailmsg} |
2215 | ||
6fb26ea3 JS |
2216 | \membersection{wxFAIL\_MSG}\label{wxfailmsg} |
2217 | ||
b207457c | 2218 | \func{}{wxFAIL\_MSG}{\param{}{msg}} |
6fb26ea3 JS |
2219 | |
2220 | Will always generate an assert error with specified message if this code is reached (in debug mode). | |
2221 | ||
b207457c VZ |
2222 | This macro is useful for marking unreachable" code areas, for example |
2223 | it may be used in the "default:" branch of a switch statement if all possible | |
2224 | cases are processed above. | |
2225 | ||
2226 | See also: \helpref{wxFAIL}{wxfail} | |
2227 | ||
6fb26ea3 JS |
2228 | \membersection{wxCHECK}\label{wxcheck} |
2229 | ||
2230 | \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}} | |
2231 | ||
2232 | Checks that the condition is true, returns with the given return value if not (FAILs in debug mode). | |
2233 | This check is done even in release mode. | |
2234 | ||
2235 | \membersection{wxCHECK\_MSG}\label{wxcheckmsg} | |
2236 | ||
2237 | \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}} | |
2238 | ||
2239 | Checks that the condition is true, returns with the given return value if not (FAILs in debug mode). | |
2240 | This check is done even in release mode. | |
2241 | ||
b207457c VZ |
2242 | This macro may be only used in non void functions, see also |
2243 | \helpref{wxCHECK\_RET}{wxcheckret}. | |
2244 | ||
2245 | \membersection{wxCHECK\_RET}\label{wxcheckret} | |
2246 | ||
2247 | \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}} | |
2248 | ||
2249 | Checks that the condition is true, and returns if not (FAILs with given error | |
2250 | message in debug mode). This check is done even in release mode. | |
2251 | ||
2252 | This macro should be used in void functions instead of | |
2253 | \helpref{wxCHECK\_MSG}{wxcheckmsg}. | |
2254 | ||
2255 | \membersection{wxCHECK2}\label{wxcheck2} | |
2256 | ||
2257 | \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}} | |
2258 | ||
2259 | Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute | |
2260 | {\it operation} if it is not. This is a generalisation of | |
2261 | \helpref{wxCHECK}{wxcheck} and may be used when something else than just | |
2262 | returning from the function must be done when the {\it condition} is false. | |
2263 | ||
2264 | This check is done even in release mode. | |
2265 | ||
2266 | \membersection{wxCHECK2\_MSG}\label{wxcheck2msg} | |
2267 | ||
2268 | \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}} | |
2269 | ||
2270 | This is the same as \helpref{wxCHECK2}{wxcheck2}, but | |
2271 | \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called | |
2272 | instead of wxFAIL() if the {\it condition} is false. | |
2273 |