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