1 \chapter{Functions
}\label{functions
}
2 \setheader{{\it CHAPTER
\thechapter}}{}{}{}{}{{\it CHAPTER
\thechapter}}%
3 \setfooter{\thepage}{}{}{}{}{\thepage}
5 The functions defined in wxWindows are described here.
7 \section{File functions
}\label{filefunctions
}
9 \wxheading{Include files
}
15 \helpref{wxPathList
}{wxpathlist
}
17 \membersection{::wxDirExists
}
19 \func{bool
}{wxDirExists
}{\param{const wxString\&
}{dirname
}}
21 Returns TRUE if the directory exists.
23 \membersection{::wxDos2UnixFilename
}
25 \func{void
}{Dos2UnixFilename
}{\param{const wxString\&
}{s
}}
27 Converts a DOS to a Unix filename by replacing backslashes with forward
30 \membersection{::wxFileExists
}
32 \func{bool
}{wxFileExists
}{\param{const wxString\&
}{filename
}}
34 Returns TRUE if the file exists.
36 \membersection{::wxFileNameFromPath
}
38 \func{wxString
}{wxFileNameFromPath
}{\param{const wxString\&
}{path
}}
40 \func{char*
}{wxFileNameFromPath
}{\param{char*
}{path
}}
42 Returns the filename for a full path. The second form returns a pointer to
43 temporary storage that should not be deallocated.
45 \membersection{::wxFindFirstFile
}\label{wxfindfirstfile
}
47 \func{wxString
}{wxFindFirstFile
}{\param{const char*
}{spec
},
\param{int
}{ flags =
0}}
49 This function does directory searching; returns the first file
50 that matches the path
{\it spec
}, or the empty string. Use
\helpref{wxFindNextFile
}{wxfindnextfile
} to
51 get the next matching file.
53 {\it spec
} may contain wildcards.
55 {\it flags
} is reserved for future use.
60 wxString f = wxFindFirstFile("/home/project/*.*");
61 while ( !f.IsEmpty() )
68 \membersection{::wxFindNextFile
}\label{wxfindnextfile
}
70 \func{wxString
}{wxFindFirstFile
}{\void}
72 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
74 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
76 \func{wxString
}{wxGetOSDirectory
}{\void}
78 Returns the Windows directory under Windows; on other platforms returns the empty string.
80 \membersection{::wxIsAbsolutePath
}
82 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
84 Returns TRUE if the argument is an absolute filename, i.e. with a slash
85 or drive name at the beginning.
87 \membersection{::wxPathOnly
}
89 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
91 Returns the directory part of the filename.
93 \membersection{::wxUnix2DosFilename
}
95 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
97 Converts a Unix to a DOS filename by replacing forward
98 slashes with backslashes.
100 \membersection{::wxConcatFiles
}
102 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
103 \param{const wxString\&
}{file3
}}
105 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
108 \membersection{::wxCopyFile
}
110 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
112 Copies
{\it file1
} to
{\it file2
}, returning TRUE if successful.
114 \membersection{::wxGetCwd
}\label{wxgetcwd
}
116 \func{wxString
}{wxGetCwd
}{\void}
118 Returns a string containing the current (or working) directory.
120 \membersection{::wxGetHostName
}\label{wxgethostname
}
122 \func{bool
}{wxGetHostName
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
124 Copies the current host machine's name into the supplied buffer.
126 Under Windows or NT, this function first looks in the environment
127 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
128 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
130 Returns TRUE if successful, FALSE otherwise.
132 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
134 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
136 Copies the user's email address into the supplied buffer, by
137 concatenating the values returned by
\helpref{wxGetHostName
}{wxgethostname
}\rtfsp
138 and
\helpref{wxGetUserId
}{wxgetuserid
}.
140 Returns TRUE if successful, FALSE otherwise.
142 \membersection{::wxGetUserId
}\label{wxgetuserid
}
144 \func{bool
}{wxGetUserId
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
146 Copies the current user id into the supplied buffer.
148 Under Windows or NT, this function first looks in the environment
149 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
150 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
152 Returns TRUE if successful, FALSE otherwise.
154 \membersection{::wxGetUserName
}\label{wxgetusername
}
156 \func{bool
}{wxGetUserName
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
158 Copies the current user name into the supplied buffer.
160 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
161 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
162 is running, the entry
{\bf Current
} in the section
{\bf User
} of
163 the PENWIN.INI file is used.
165 Returns TRUE if successful, FALSE otherwise.
167 \membersection{::wxGetWorkingDirectory
}
169 \func{wxString
}{wxGetWorkingDirectory
}{\param{char*
}{buf=NULL
},
\param{int
}{sz=
1000}}
171 This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
173 Copies the current working directory into the buffer if supplied, or
174 copies the working directory into new storage (which you must delete yourself)
175 if the buffer is NULL.
177 {\it sz
} is the size of the buffer if supplied.
179 \membersection{::wxGetTempFileName
}
181 \func{char*
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char*
}{buf=NULL
}}
183 Makes a temporary filename based on
{\it prefix
}, opens and closes the file,
184 and places the name in
{\it buf
}. If
{\it buf
} is NULL, new store
185 is allocated for the temporary filename using
{\it new
}.
187 Under Windows, the filename will include the drive and name of the
188 directory allocated for temporary files (usually the contents of the
189 TEMP variable). Under Unix, the
{\tt /tmp
} directory is used.
191 It is the application's responsibility to create and delete the file.
193 \membersection{::wxIsWild
}\label{wxiswild
}
195 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
197 Returns TRUE if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
199 \membersection{::wxMatchWild
}\label{wxmatchwild
}
201 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
203 Returns TRUE if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
204 dot
\_special}\/ is TRUE, filenames beginning with a dot are not matched
205 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
207 \membersection{::wxMkdir
}
209 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
}}
211 Makes the directory
{\it dir
}, returning TRUE if successful.
213 \membersection{::wxRemoveFile
}
215 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
217 Removes
{\it file
}, returning TRUE if successful.
219 \membersection{::wxRenameFile
}
221 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
223 Renames
{\it file1
} to
{\it file2
}, returning TRUE if successful.
225 \membersection{::wxRmdir
}
227 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
229 Removes the directory
{\it dir
}, returning TRUE if successful. Does not work under VMS.
231 The
{\it flags
} parameter is reserved for future use.
233 \membersection{::wxSetWorkingDirectory
}
235 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
237 Sets the current working directory, returning TRUE if the operation succeeded.
238 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
240 \membersection{::wxSplitPath
}\label{wxsplitfunction
}
242 \func{void
}{wxSplitPath
}{\param{const char *
}{ fullname
},
\param{const wxString *
}{ path
},
\param{const wxString *
}{ name
},
\param{const wxString *
}{ ext
}}
244 This function splits a full file name into components: the path (including possible disk/drive
245 specification under Windows), the base name and the extension. Any of the output parameters
246 (
{\it path
},
{\it name
} or
{\it ext
}) may be NULL if you are not interested in the value of
247 a particular component.
249 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
250 Windows, however it will not consider backslashes as path separators under Unix (where backslash
251 is a valid character in a filename).
253 On entry,
{\it fullname
} should be non NULL (it may be empty though).
255 On return,
{\it path
} contains the file path (without the trailing separator),
{\it name
}
256 contains the file name and
{\it ext
} contains the file extension without leading dot. All
257 three of them may be empty if the corresponding component is. The old contents of the
258 strings pointed to by these parameters will be overwritten in any case (if the pointers
261 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
263 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
265 Copies the given file to
{\it stream
}. Useful when converting an old application to
266 use streams (within the
document/view framework, for example).
268 Use of this function requires the file wx
\_doc.h to be included.
270 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
272 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
274 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
275 use streams (within the
document/view framework, for example).
277 Use of this function requires the file wx
\_doc.h to be included.
279 \section{String functions
}
281 \membersection{::copystring
}
283 \func{char*
}{copystring
}{\param{const char*
}{s
}}
285 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
286 deleted with the
{\it delete
} operator.
288 \membersection{::wxStringMatch
}
290 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
291 \param{bool
}{ subString = TRUE
},
\param{bool
}{ exact = FALSE
}}
293 Returns TRUE if the substring
{\it s1
} is found within
{\it s2
},
294 ignoring case if
{\it exact
} is FALSE. If
{\it subString
} is FALSE,
295 no substring matching is done.
297 \membersection{::wxStringEq
}\label{wxstringeq
}
299 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
304 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
307 \membersection{::IsEmpty
}\label{isempty
}
309 \func{bool
}{IsEmpty
}{\param{const char *
}{ p
}}
311 Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL
312 pointer to this function and it will return TRUE for it.
314 \membersection{::Stricmp
}\label{stricmp
}
316 \func{int
}{Stricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
318 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
319 to or greater than
{\it p2
}. The comparison is case-insensitive.
321 This function complements the standard C function
{\it strcmp()
} which performs
322 case-sensitive comparison.
324 \membersection{::Strlen
}\label{strlen
}
326 \func{size
\_t}{Strlen
}{\param{const char *
}{ p
}}
328 This is a safe version of standard function
{\it strlen()
}: it does exactly the
329 same thing (i.e. returns the length of the string) except that it returns
0 if
330 {\it p
} is the NULL pointer.
332 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
334 \func{const char *
}{wxGetTranslation
}{\param{const char *
}{str
}}
336 This function returns the translation of string
{\it str
} in the current
337 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
338 message catalogs (see
\helpref{i18n overview
}{internationalization
}), the
339 original string is returned. In debug build, an error message is logged - this
340 should help to find the strings which were not yet translated. As this function
341 is used very often, an alternative syntax is provided: the
\_() macro is
342 defined as wxGetTranslation().
344 \section{Dialog functions
}\label{dialogfunctions
}
346 Below are a number of convenience functions for getting input from the
347 user or displaying messages. Note that in these functions the last three
348 parameters are optional. However, it is recommended to pass a parent frame
349 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
350 the front when the dialog box is popped up.
352 \membersection{::wxFileSelector
}\label{wxfileselector
}
354 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
355 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
356 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = ""
},\\
357 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
359 Pops up a file selector box. In Windows, this is the common file selector
360 dialog. In X, this is a file selector box with somewhat less functionality.
361 The path and filename are distinct elements of a full file pathname.
362 If path is NULL, the current directory will be used. If filename is NULL,
363 no default filename will be supplied. The wildcard determines what files
364 are displayed in the file selector, and file extension supplies a type
365 extension for the required filename. Flags may be a combination of wxOPEN,
366 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, or
0. They are only significant
367 at present in Windows.
369 Both the X and Windows versions implement a wildcard filter. Typing a
370 filename containing wildcards
(*, ?) in the filename text item, and
371 clicking on Ok, will result in only those files matching the pattern being
372 displayed. In the X version, supplying no default name will result in the
373 wildcard filter being inserted in the filename text item; the filter is
374 ignored if a default name is supplied.
376 Under Windows (only), the wildcard may be a specification for multiple
377 types of file with a description for each, such as:
380 "BMP files (*.bmp) | *.bmp | GIF files (*.gif) | *.gif"
383 The application must check for a NULL return value (the user pressed
384 Cancel). For example:
387 const wxString& s = wxFileSelector("Choose a file to open");
394 \wxheading{Include files}
398 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
400 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
401 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
402 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
404 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
405 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
406 or press Cancel to return the empty string.
408 If {\it centre} is TRUE, the message text (which may include new line characters)
409 is centred; if FALSE, the message is left-justified.
411 \wxheading{Include files}
415 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
417 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
418 \param{int }{nsel}, \param{int *}{selection},
419 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
420 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
422 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
423 listbox. The user may choose one or more item(s) and press OK or Cancel.
425 The number of initially selected choices, and array of the selected indices,
426 are passed in; this array will contain the user selections on exit, with
427 the function returning the number of selections. {\it selection} must be
428 as big as the number of choices, in case all are selected.
430 If Cancel is pressed, -1 is returned.
432 {\it choices} is an array of {\it n} strings for the listbox.
434 If {\it centre} is TRUE, the message text (which may include new line characters)
435 is centred; if FALSE, the message is left-justified.
437 \wxheading{Include files}
441 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
443 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
444 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
445 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
447 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
448 listbox. The user may choose an item and press OK to return a string or
449 Cancel to return the empty string.
451 {\it choices} is an array of {\it n} strings for the listbox.
453 If {\it centre} is TRUE, the message text (which may include new line characters)
454 is centred; if FALSE, the message is left-justified.
456 \wxheading{Include files}
460 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
462 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
463 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
464 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
466 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
467 If the user pressed cancel, -1 is returned.
469 \wxheading{Include files}
473 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
475 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
476 \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
477 \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
479 As {\bf wxGetSingleChoice} but takes an array of client data pointers
480 corresponding to the strings, and returns one of these pointers.
482 \wxheading{Include files}
486 \membersection{::wxMessageBox}\label{wxmessagebox}
488 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
489 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
491 General purpose message dialog. {\it style} may be a bit list of the
492 following identifiers:
494 \begin{twocollist}\itemsep=0pt
495 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
497 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
499 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
500 \twocolitem{wxCENTRE}{Centres the text.}
501 \twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
502 \twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
503 \twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
504 \twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
507 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
513 int answer = wxMessageBox("Quit program?", "Confirm",
514 wxYES_NO | wxCANCEL, main_frame);
520 {\it message} may contain newline characters, in which case the
521 message will be split into separate lines, to cater for large messages.
523 Under Windows, the native MessageBox function is used unless wxCENTRE
524 is specified in the style, in which case a generic function is used.
525 This is because the native MessageBox function cannot centre text.
526 The symbols are not shown when the generic function is used.
528 \wxheading{Include files}
532 \section{GDI functions}\label{gdifunctions}
534 The following are relevant to the GDI (Graphics Device Interface).
536 \wxheading{Include files}
540 \membersection{::wxColourDisplay}
542 \func{bool}{wxColourDisplay}{\void}
544 Returns TRUE if the display is colour, FALSE otherwise.
546 \membersection{::wxDisplayDepth}
548 \func{int}{wxDisplayDepth}{\void}
550 Returns the depth of the display (a value of 1 denotes a monochrome display).
552 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
554 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
555 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
557 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
558 makes it into a placeable metafile by prepending a header containing the given
559 bounding box. The bounding box may be obtained from a device context after drawing
560 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
562 In addition to adding the placeable metafile header, this function adds
563 the equivalent of the following code to the start of the metafile data:
566 SetMapMode(dc, MM_ANISOTROPIC);
567 SetWindowOrg(dc, minX, minY);
568 SetWindowExt(dc, maxX - minX, maxY - minY);
571 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
573 Placeable metafiles may be imported by many Windows applications, and can be
574 used in RTF (Rich Text Format) files.
576 {\it scale} allows the specification of scale for the metafile.
578 This function is only available under Windows.
580 \membersection{::wxSetCursor}\label{wxsetcursor}
582 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
584 Globally sets the cursor; only has an effect in MS Windows.
585 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
587 \section{Printer settings}\label{printersettings}
589 The following functions are used to control PostScript printing. Under
590 Windows, PostScript output can only be sent to a file.
592 \wxheading{Include files}
596 \membersection{::wxGetPrinterCommand}
598 \func{wxString}{wxGetPrinterCommand}{\void}
600 Gets the printer command used to print a file. The default is {\tt lpr}.
602 \membersection{::wxGetPrinterFile}
604 \func{wxString}{wxGetPrinterFile}{\void}
606 Gets the PostScript output filename.
608 \membersection{::wxGetPrinterMode}
610 \func{int}{wxGetPrinterMode}{\void}
612 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
613 The default is PS\_PREVIEW.
615 \membersection{::wxGetPrinterOptions}
617 \func{wxString}{wxGetPrinterOptions}{\void}
619 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
621 \membersection{::wxGetPrinterOrientation}
623 \func{int}{wxGetPrinterOrientation}{\void}
625 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
627 \membersection{::wxGetPrinterPreviewCommand}
629 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
631 Gets the command used to view a PostScript file. The default depends on the platform.
633 \membersection{::wxGetPrinterScaling}
635 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
637 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
639 \membersection{::wxGetPrinterTranslation}
641 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
643 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
645 \membersection{::wxSetPrinterCommand}
647 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
649 Sets the printer command used to print a file. The default is {\tt lpr}.
651 \membersection{::wxSetPrinterFile}
653 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
655 Sets the PostScript output filename.
657 \membersection{::wxSetPrinterMode}
659 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
661 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
662 The default is PS\_PREVIEW.
664 \membersection{::wxSetPrinterOptions}
666 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
668 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
670 \membersection{::wxSetPrinterOrientation}
672 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
674 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
676 \membersection{::wxSetPrinterPreviewCommand}
678 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
680 Sets the command used to view a PostScript file. The default depends on the platform.
682 \membersection{::wxSetPrinterScaling}
684 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
686 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
688 \membersection{::wxSetPrinterTranslation}
690 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
692 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
694 \section{Clipboard functions}\label{clipsboard}
696 These clipboard functions are implemented for Windows only.
698 \wxheading{Include files}
702 \membersection{::wxClipboardOpen}
704 \func{bool}{wxClipboardOpen}{\void}
706 Returns TRUE if this application has already opened the clipboard.
708 \membersection{::wxCloseClipboard}
710 \func{bool}{wxCloseClipboard}{\void}
712 Closes the clipboard to allow other applications to use it.
714 \membersection{::wxEmptyClipboard}
716 \func{bool}{wxEmptyClipboard}{\void}
718 Empties the clipboard.
720 \membersection{::wxEnumClipboardFormats}
722 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
724 Enumerates the formats found in a list of available formats that belong
725 to the clipboard. Each call to this function specifies a known
726 available format; the function returns the format that appears next in
729 {\it dataFormat} specifies a known format. If this parameter is zero,
730 the function returns the first format in the list.
732 The return value specifies the next known clipboard data format if the
733 function is successful. It is zero if the {\it dataFormat} parameter specifies
734 the last format in the list of available formats, or if the clipboard
737 Before it enumerates the formats function, an application must open the clipboard by using the
738 wxOpenClipboard function.
740 \membersection{::wxGetClipboardData}
742 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
744 Gets data from the clipboard.
746 {\it dataFormat} may be one of:
748 \begin{itemize}\itemsep=0pt
749 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
750 \item wxCF\_BITMAP: returns a new wxBitmap.
753 The clipboard must have previously been opened for this call to succeed.
755 \membersection{::wxGetClipboardFormatName}
757 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
759 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
760 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
762 \membersection{::wxIsClipboardFormatAvailable}
764 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
766 Returns TRUE if the given data format is available on the clipboard.
768 \membersection{::wxOpenClipboard}
770 \func{bool}{wxOpenClipboard}{\void}
772 Opens the clipboard for passing data to it or getting data from it.
774 \membersection{::wxRegisterClipboardFormat}
776 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
778 Registers the clipboard data format name and returns an identifier.
780 \membersection{::wxSetClipboardData}
782 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
784 Passes data to the clipboard.
786 {\it dataFormat} may be one of:
788 \begin{itemize}\itemsep=0pt
789 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
790 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
791 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
792 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
795 The clipboard must have previously been opened for this call to succeed.
797 \section{Miscellaneous functions}\label{miscellany}
799 \membersection{::wxNewId}
801 \func{long}{wxNewId}{\void}
803 Generates an integer identifier unique to this run of the program.
805 \wxheading{Include files}
809 \membersection{::wxRegisterId}
811 \func{void}{wxRegisterId}{\param{long}{ id}}
813 Ensures that ids subsequently generated by {\bf NewId} do not clash with
816 \wxheading{Include files}
820 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
822 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
824 Changes the cursor to the given cursor for all windows in the application.
825 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
826 to its previous state. These two calls can be nested, and a counter
827 ensures that only the outer calls take effect.
829 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
831 \wxheading{Include files}
835 \membersection{::wxBell}
837 \func{void}{wxBell}{\void}
839 Ring the system bell.
841 \wxheading{Include files}
845 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
847 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
849 Creates and returns an object of the given class, if the class has been
850 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
852 \membersection{::wxDDECleanUp}\label{wxddecleanup}
854 \func{void}{wxDDECleanUp}{\void}
856 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
857 called by the application.
859 See also helpref{wxDDEInitialize}{wxddeinitialize}.
861 \wxheading{Include files}
865 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
867 \func{void}{wxDDEInitialize}{\void}
869 Initializes the DDE system. May be called multiple times without harm.
871 This no longer needs to be called by the application: it will be called
872 by wxWindows if necessary.
874 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
875 \helpref{wxDDECleanUp}{wxddecleanup}.
877 \wxheading{Include files}
881 \membersection{::wxDebugMsg}\label{wxdebugmsg}
883 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
885 Display a debugging message; under Windows, this will appear on the
886 debugger command window, and under Unix, it will be written to standard
889 The syntax is identical to {\bf printf}: pass a format string and a
890 variable list of arguments.
892 Note that under Windows, you can see the debugging messages without a
893 debugger if you have the DBWIN debug log application that comes with
896 {\bf Tip:} under Windows, if your application crashes before the
897 message appears in the debugging window, put a wxYield call after
898 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
899 (at least for Watcom C++): preformat your messages and use OutputDebugString
902 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
904 \wxheading{Include files}
908 \membersection{::wxDisplaySize}
910 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
912 Gets the physical size of the display in pixels.
914 \wxheading{Include files}
918 \membersection{::wxEntry}\label{wxentry}
920 This initializes wxWindows in a platform-dependent way. Use this if you
921 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
922 you can initialize wxWindows from an Microsoft Foundation Classes application using
925 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
926 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
928 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
929 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
930 message loop will be entered.
932 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
933 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
935 wxWindows initialization under Windows (for applications constructed as a DLL).
937 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
939 wxWindows initialization under Unix.
943 To clean up wxWindows, call wxApp::OnExit followed by the static function
944 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
947 int CTheApp::ExitInstance()
949 // OnExit isn't called by CleanUp so must be called explicitly.
953 return CWinApp::ExitInstance();
957 \wxheading{Include files}
961 \membersection{::wxError}\label{wxerror}
963 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
965 Displays {\it msg} and continues. This writes to standard error under
966 Unix, and pops up a message box under Windows. Used for internal
967 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
969 \wxheading{Include files}
973 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
975 \func{void}{wxEndBusyCursor}{\void}
977 Changes the cursor back to the original cursor, for all windows in the application.
978 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
980 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
982 \wxheading{Include files}
986 \membersection{::wxExecute}\label{wxexecute}
988 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
990 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
992 Executes another program in Unix or Windows.
994 The first form takes a command string, such as {\tt "emacs file.txt"}.
996 The second form takes an array of values: a command, any number of
997 arguments, terminated by NULL.
999 If {\it sync} is FALSE (the default), flow of control immediately returns.
1000 If TRUE, the current application waits until the other program has terminated.
1002 In the case of synchronous execution, the return value is trhe exit code of
1003 the process (which terminates by the moment the function returns) and will be
1004 $-1$ if the process couldn't be started and typically 0 if the process
1005 terminated successfully.
1007 For asynchronous execution, however, the return value is the process id and
1008 zero value indicates that the command could not be executed.
1010 If callback isn't NULL and if execution is asynchronous (note that callback
1011 parameter can not be non NULL for synchronous execution),
1012 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
1013 the process finishes.
1015 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
1017 \wxheading{Include files}
1021 \membersection{::wxExit}\label{wxexit}
1023 \func{void}{wxExit}{\void}
1025 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
1026 Should only be used in an emergency: normally the top-level frame
1027 should be deleted (after deleting all other frames) to terminate the
1028 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
1030 \wxheading{Include files}
1034 \membersection{::wxFatalError}\label{wxfatalerror}
1036 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
1038 Displays {\it msg} and exits. This writes to standard error under Unix,
1039 and pops up a message box under Windows. Used for fatal internal
1040 wxWindows errors. See also \helpref{wxError}{wxerror}.
1042 \wxheading{Include files}
1046 \membersection{::wxFindMenuItemId}
1048 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
1050 Find a menu item identifier associated with the given frame's menu bar.
1052 \wxheading{Include files}
1056 \membersection{::wxFindWindowByLabel}
1058 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
1060 Find a window by its label. Depending on the type of window, the label may be a window title
1061 or panel item label. If {\it parent} is NULL, the search will start from all top-level
1062 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1063 The search is recursive in both cases.
1065 \wxheading{Include files}
1069 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
1071 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
1073 Find a window by its name (as given in a window constructor or {\bf Create} function call).
1074 If {\it parent} is NULL, the search will start from all top-level
1075 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1076 The search is recursive in both cases.
1078 If no such named window is found, {\bf wxFindWindowByLabel} is called.
1080 \wxheading{Include files}
1084 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
1086 \func{wxWindow *}{wxGetActiveWindow}{\void}
1088 Gets the currently active window (Windows only).
1090 \wxheading{Include files}
1094 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
1096 \func{wxString}{wxGetDisplayName}{\void}
1098 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
1100 \wxheading{Include files}
1104 \membersection{::wxGetHomeDir}
1106 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
1108 Fills the buffer with a string representing the user's home directory (Unix only).
1110 \wxheading{Include files}
1114 \membersection{::wxGetHostName}
1116 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1118 Copies the host name of the machine the program is running on into the
1119 buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
1120 successful. Under Unix, this will return a machine name. Under Windows,
1121 this returns ``windows''.
1123 \wxheading{Include files}
1127 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
1129 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
1131 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
1133 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
1136 See also \helpref{wxTimer}{wxtimer}.
1138 \wxheading{Include files}
1142 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1144 \func{long}{wxGetFreeMemory}{\void}
1146 Returns the amount of free memory in Kbytes under environments which
1147 support it, and -1 if not supported. Currently, returns a positive value
1148 under Windows, and -1 under Unix.
1150 \wxheading{Include files}
1154 \membersection{::wxGetMousePosition}
1156 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
1158 Returns the mouse position in screen coordinates.
1160 \wxheading{Include files}
1164 \membersection{::wxGetOsVersion}
1166 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1168 Gets operating system version information.
1170 \begin{twocollist}\itemsep=0pt
1171 \twocolitemruled{Platform}{Return tyes}
1172 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
1173 \twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
1174 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1175 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1176 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1177 \twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
1178 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
1179 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1180 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1183 \wxheading{Include files}
1187 \membersection{::wxGetResource}\label{wxgetresource}
1189 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1190 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
1192 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1193 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
1195 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1196 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
1198 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1199 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
1201 Gets a resource value from the resource database (for example, WIN.INI, or
1202 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1203 otherwise the specified file is used.
1205 Under X, if an application class (wxApp::GetClassName) has been defined,
1206 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
1207 an applications default file when merging all resource databases.
1209 The reason for passing the result in an argument is that it
1210 can be convenient to define a default value, which gets overridden
1211 if the value exists in the resource file. It saves a separate
1212 test for that resource's existence, and it also allows
1213 the overloading of the function for different types.
1215 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1217 \wxheading{Include files}
1221 \membersection{::wxGetUserId}
1223 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1225 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1226 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1227 Under Windows, this returns ``user''.
1229 \wxheading{Include files}
1233 \membersection{::wxGetUserName}
1235 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1237 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1238 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1239 Under Windows, this returns ``unknown''.
1241 \wxheading{Include files}
1245 \membersection{::wxKill}\label{wxkill}
1247 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1249 Under Unix (the only supported platform), equivalent to the Unix kill function.
1250 Returns 0 on success, -1 on failure.
1252 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1253 It does not raise a signal in the receiving process.
1255 \wxheading{Include files}
1259 \membersection{::wxIsBusy}\label{wxisbusy}
1261 \func{bool}{wxIsBusy}{\void}
1263 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1264 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1266 See also \helpref{wxBusyCursor}{wxbusycursor}.
1268 \wxheading{Include files}
1272 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1274 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1276 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1277 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1279 The resource must be defined in the {\tt .rc} file using the following syntax:
1282 myResource TEXT file.ext
1285 where {\tt file.ext} is a file that the resource compiler can find.
1287 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1288 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1289 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1291 This function is available under Windows only.
1293 \wxheading{Include files}
1297 \membersection{::wxNow}\label{wxnow}
1299 \func{wxString}{wxNow}{\void}
1301 Returns a string representing the current date and time.
1303 \wxheading{Include files}
1307 \membersection{::wxPostDelete}\label{wxpostdelete}
1309 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1311 Tells the system to delete the specified object when
1312 all other events have been processed. In some environments, it is
1313 necessary to use this instead of deleting a frame directly with the
1314 delete operator, because some GUIs will still send events to a deleted window.
1316 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1318 \wxheading{Include files}
1322 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1324 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1326 Under X only, sets the current display name. This is the X host and display name such
1327 as ``colonsay:0.0", and the function indicates which display should be used for creating
1328 windows from this point on. Setting the display within an application allows multiple
1329 displays to be used.
1331 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1333 \wxheading{Include files}
1337 \membersection{::wxShell}\label{wxshell}
1339 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1341 Executes a command in an interactive shell window. If no command is
1342 specified, then just the shell is spawned.
1344 See also \helpref{wxExecute}{wxexecute}.
1346 \wxheading{Include files}
1350 \membersection{::wxSleep}\label{wxsleep}
1352 \func{void}{wxSleep}{\param{int}{ secs}}
1354 Sleeps for the specified number of seconds.
1356 \wxheading{Include files}
1360 \membersection{::wxStripMenuCodes}
1362 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1364 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1366 Strips any menu codes from {\it in} and places the result
1367 in {\it out} (or returns the new string, in the first form).
1369 Menu codes include \& (mark the next character with an underline
1370 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1372 \wxheading{Include files}
1376 \membersection{::wxStartTimer}\label{wxstarttimer}
1378 \func{void}{wxStartTimer}{\void}
1380 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
1382 See also \helpref{wxTimer}{wxtimer}.
1384 \wxheading{Include files}
1388 \membersection{::wxToLower}\label{wxtolower}
1390 \func{char}{wxToLower}{\param{char }{ch}}
1392 Converts the character to lower case. This is implemented as a macro for efficiency.
1394 \wxheading{Include files}
1398 \membersection{::wxToUpper}\label{wxtoupper}
1400 \func{char}{wxToUpper}{\param{char }{ch}}
1402 Converts the character to upper case. This is implemented as a macro for efficiency.
1404 \wxheading{Include files}
1408 \membersection{::wxTrace}\label{wxtrace}
1410 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1412 Takes printf-style variable argument syntax. Output
1413 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1415 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1417 \wxheading{Include files}
1421 \membersection{::wxTraceLevel}\label{wxtracelevel}
1423 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1425 Takes printf-style variable argument syntax. Output
1426 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1427 The first argument should be the level at which this information is appropriate.
1428 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1431 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1433 \wxheading{Include files}
1437 \membersection{::wxUsleep}\label{wxusleep}
1439 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
1441 Sleeps for the specified number of milliseconds. Notice that usage of this
1442 function is encouraged instead of calling usleep(3) directly because the
1443 standard usleep() function is not MT safe.
1445 \wxheading{Include files}
1449 \membersection{::wxWriteResource}\label{wxwriteresource}
1451 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1452 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1454 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1455 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1457 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1458 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1460 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1461 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1463 Writes a resource value into the resource database (for example, WIN.INI, or
1464 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1465 otherwise the specified file is used.
1467 Under X, the resource databases are cached until the internal function
1468 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1469 all updated resource databases are written to their files.
1471 Note that it is considered bad manners to write to the .Xdefaults
1472 file under Unix, although the WIN.INI file is fair game under Windows.
1474 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1476 \wxheading{Include files}
1480 \membersection{::wxYield}\label{wxyield}
1482 \func{bool}{wxYield}{\void}
1484 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1485 time-consuming process writes to a text window. Without an occasional
1486 yield, the text window will not be updated properly, and (since Windows
1487 multitasking is cooperative) other processes will not respond.
1489 Caution should be exercised, however, since yielding may allow the
1490 user to perform actions which are not compatible with the current task.
1491 Disabling menu items or whole menus during processing can avoid unwanted
1494 \wxheading{Include files}
1498 \section{Macros}\label{macros}
1500 These macros are defined in wxWindows.
1502 \membersection{CLASSINFO}\label{classinfo}
1504 \func{wxClassInfo *}{CLASSINFO}{className}
1506 Returns a pointer to the wxClassInfo object associated with this class.
1508 \wxheading{Include files}
1512 \membersection{WXDEBUG\_NEW}\label{debugnew}
1514 \func{}{WXDEBUG\_NEW}{arg}
1516 This is defined in debug mode to be call the redefined new operator
1517 with filename and line number arguments. The definition is:
1520 #define WXDEBUG_NEW new(__FILE__,__LINE__)
1523 In non-debug mode, this is defined as the normal new operator.
1525 \wxheading{Include files}
1529 \membersection{DECLARE\_ABSTRACT\_CLASS}
1531 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
1533 Used inside a class declaration to declare that the class should be
1534 made known to the class hierarchy, but objects of this class cannot be created
1535 dynamically. The same as DECLARE\_CLASS.
1540 class wxCommand: public wxObject
1542 DECLARE_ABSTRACT_CLASS(wxCommand)
1551 \wxheading{Include files}
1555 \membersection{DECLARE\_APP}\label{declareapp}
1557 \func{}{DECLARE\_APP}{className}
1559 This is used in headers to create a forward declaration of the wxGetApp function implemented
1560 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
1568 \wxheading{Include files}
1572 \membersection{DECLARE\_CLASS}
1574 \func{}{DECLARE\_CLASS}{className}
1576 Used inside a class declaration to declare that the class should be
1577 made known to the class hierarchy, but objects of this class cannot be created
1578 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
1580 \wxheading{Include files}
1584 \membersection{DECLARE\_DYNAMIC\_CLASS}
1586 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
1588 Used inside a class declaration to declare that the objects of this class should be dynamically
1589 createable from run-time type information.
1594 class wxFrame: public wxWindow
1596 DECLARE_DYNAMIC_CLASS(wxFrame)
1599 const wxString\& frameTitle;
1605 \wxheading{Include files}
1609 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
1611 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
1613 Used in a C++ implementation file to complete the declaration of
1614 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
1619 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
1621 wxCommand::wxCommand(void)
1627 \wxheading{Include files}
1631 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
1633 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
1635 Used in a C++ implementation file to complete the declaration of
1636 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
1638 \wxheading{Include files}
1642 \membersection{IMPLEMENT\_APP}\label{implementapp}
1644 \func{}{IMPLEMENT\_APP}{className}
1646 This is used in the application class implementation file to make the application class known to
1647 wxWindows for dynamic construction. You use this instead of
1658 IMPLEMENT_APP(MyApp)
1661 See also \helpref{DECLARE\_APP}{declareapp}.
1663 \wxheading{Include files}
1667 \membersection{IMPLEMENT\_CLASS}
1669 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
1671 Used in a C++ implementation file to complete the declaration of
1672 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
1674 \wxheading{Include files}
1678 \membersection{IMPLEMENT\_CLASS2}
1680 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
1682 Used in a C++ implementation file to complete the declaration of a
1683 class that has run-time type information and two base classes. The
1684 same as IMPLEMENT\_ABSTRACT\_CLASS2.
1686 \wxheading{Include files}
1690 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
1692 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
1694 Used in a C++ implementation file to complete the declaration of
1695 a class that has run-time type information, and whose instances
1696 can be created dynamically.
1701 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
1703 wxFrame::wxFrame(void)
1709 \wxheading{Include files}
1713 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
1715 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
1717 Used in a C++ implementation file to complete the declaration of
1718 a class that has run-time type information, and whose instances
1719 can be created dynamically. Use this for classes derived from two
1722 \wxheading{Include files}
1726 \membersection{WXTRACE}\label{trace}
1728 \func{}{WXTRACE}{formatString, ...}
1730 Calls wxTrace with printf-style variable argument syntax. Output
1731 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1733 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1735 \wxheading{Include files}
1739 \membersection{WXTRACELEVEL}\label{tracelevel}
1741 \func{}{WXTRACELEVEL}{level, formatString, ...}
1743 Calls wxTraceLevel with printf-style variable argument syntax. Output
1744 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1745 The first argument should be the level at which this information is appropriate.
1746 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1749 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1751 \wxheading{Include files}
1755 \section{wxWindows resource functions}\label{resourcefuncs}
1757 \overview{wxWindows resource system}{resourceformats}
1759 This section details functions for manipulating wxWindows (.WXR) resource
1760 files and loading user interface elements from resources.
1762 \normalbox{Please note that this use of the word `resource' is different from that used when talking
1763 about initialisation file resource reading and writing, using such functions
1764 as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
1766 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
1768 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
1769 loading from resource data.
1771 {\bf Warning:} this needs updating for wxWindows 2.
1773 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
1775 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
1777 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
1778 \verb$#$defining a name to an integer). Unlikely to be used by an application except
1779 perhaps for implementing resource functionality for interpreted languages.
1781 \membersection{::wxResourceClear}
1783 \func{void}{wxResourceClear}{\void}
1785 Clears the wxWindows resource table.
1787 \membersection{::wxResourceCreateBitmap}
1789 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
1791 Creates a new bitmap from a file, static data, or Windows resource, given a valid
1792 wxWindows bitmap resource identifier. For example, if the .WXR file contains
1796 static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
1797 bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
1798 bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
1801 then this function can be called as follows:
1804 wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
1807 \membersection{::wxResourceCreateIcon}
1809 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
1811 Creates a new icon from a file, static data, or Windows resource, given a valid
1812 wxWindows icon resource identifier. For example, if the .WXR file contains
1816 static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
1817 icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
1818 icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
1821 then this function can be called as follows:
1824 wxIcon *icon = wxResourceCreateIcon("aiai_resource");
1827 \membersection{::wxResourceCreateMenuBar}
1829 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
1831 Creates a new menu bar given a valid wxWindows menubar resource
1832 identifier. For example, if the .WXR file contains the following:
1835 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
1839 ['&Open File', 2, 'Open a file'],\
1840 ['&Save File', 3, 'Save a file'],\
1842 ['E&xit', 4, 'Exit program']\
1845 ['&About', 6, 'About this program']\
1850 then this function can be called as follows:
1853 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
1857 \membersection{::wxResourceGetIdentifier}
1859 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
1861 Used for retrieving the integer value associated with an identifier.
1862 A zero value indicates that the identifier was not found.
1864 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
1866 \membersection{::wxResourceParseData}\label{wxresourcedata}
1868 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
1870 Parses a string containing one or more wxWindows resource objects. If
1871 the resource objects are global static data that are included into the
1872 C++ program, then this function must be called for each variable
1873 containing the resource data, to make it known to wxWindows.
1875 {\it resource} should contain data in the following form:
1878 dialog(name = 'dialog1',
1879 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
1880 title = 'Test dialog box',
1881 x = 312, y = 234, width = 400, height = 300,
1883 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
1884 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
1885 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
1886 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
1887 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
1888 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
1891 This function will typically be used after including a {\tt .wxr} file into
1892 a C++ program as follows:
1895 #include "dialog1.wxr"
1898 Each of the contained resources will declare a new C++ variable, and each
1899 of these variables should be passed to wxResourceParseData.
1901 \membersection{::wxResourceParseFile}
1903 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
1905 Parses a file containing one or more wxWindows resource objects
1906 in C++-compatible syntax. Use this function to dynamically load
1907 wxWindows resource data.
1909 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
1911 \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
1913 Parses a string containing one or more wxWindows resource objects. If
1914 the resource objects are global static data that are included into the
1915 C++ program, then this function must be called for each variable
1916 containing the resource data, to make it known to wxWindows.
1918 {\it resource} should contain data with the following form:
1921 static const wxString\& dialog1 = "dialog(name = 'dialog1',\
1922 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
1923 title = 'Test dialog box',\
1924 x = 312, y = 234, width = 400, height = 300,\
1926 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
1927 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
1928 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
1929 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
1930 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
1931 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
1934 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
1935 load an entire {\tt .wxr file} into a string.
1937 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
1939 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
1940 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
1942 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
1944 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
1945 This is required if other resources will use the bitmap data, since otherwise there
1946 is no connection between names used in resources, and the global bitmap data.
1948 \membersection{::wxResourceRegisterIconData}
1950 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
1952 \section{Log functions}\label{logfunctions}
1954 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
1955 further information.
1957 \wxheading{Include files}
1961 \membersection{::wxLogError}\label{wxlogerror}
1963 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
1965 The function to use for error messages, i.e. the
1966 messages that must be shown to the user. The default processing is to pop up a
1967 message box to inform the user about it.
1969 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
1971 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
1973 Like \helpref{wxLogError}{wxlogerror}, but also
1974 terminates the program with the exit code 3. Using {\it abort()} standard
1975 function also terminates the program with this exit code.
1977 \membersection{::wxLogWarning}\label{wxlogwarning}
1979 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
1981 For warnings - they are also normally shown to the
1982 user, but don't interrupt the program work.
1984 \membersection{::wxLogMessage}\label{wxlogmessage}
1986 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
1988 for all normal, informational messages. They also
1989 appear in a message box by default (but it can be changed). Notice
1990 that the standard behaviour is to not show informational messages if there are
1991 any errors later - the logic being that the later error messages make the
1992 informational messages preceding them meaningless.
1994 \membersection{::wxLogVerbose}\label{wxlogverbose}
1996 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
1998 For verbose output. Normally, it's suppressed, but
1999 might be activated if the user wishes to know more details about the program
2000 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
2002 \membersection{::wxLogStatus}\label{wxlogstatus}
2004 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
2006 For status messages - they will go into the status
2007 bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
2009 \membersection{::wxLogSysError}\label{wxlogsyserror}
2011 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
2013 Mostly used by wxWindows itself, but might be
2014 handy for logging errors after system call (API function) failure. It logs the
2015 specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
2016 on the platform) and the corresponding error
2017 message. The second form of this function takes the error code explitly as the
2020 \membersection{::wxLogDebug}\label{wxlogdebug}
2022 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
2024 The right function for debug output. It only
2025 does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
2026 and expands to nothing in release mode (otherwise).
2028 \membersection{::wxLogTrace}\label{wxlogtrace}
2030 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
2032 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
2034 As {\bf wxLogDebug}, only does something in debug
2035 build. The reason for making it a separate function from it is that usually
2036 there are a lot of trace messages, so it might make sense to separate them
2037 from other debug messages which would be flooded in them. Moreover, the second
2038 version of this function takes a trace mask as the first argument which allows
2039 to further restrict the amount of messages generated. The value of {\it mask} can be:
2041 \begin{itemize}\itemsep=0pt
2042 \item wxTraceMemAlloc: trace memory allocation (new/delete)
2043 \item wxTraceMessages: trace window messages/X callbacks
2044 \item wxTraceResAlloc: trace GDI resource allocation
2045 \item wxTraceRefCount: trace various ref counting operations
2048 \section{Debugging macros and functions}\label{debugmacros}
2050 Useful macros and functins for error checking and defensive programming. ASSERTs are only
2051 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
2054 \wxheading{Include files}
2058 \membersection{::wxOnAssert}\label{wxonassert}
2060 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
2062 This function may be redefined to do something non trivial and is called
2063 whenever one of debugging macros fails (i.e. condition is false in an
2065 % TODO: this should probably be an overridable in wxApp.
2067 \membersection{wxASSERT}\label{wxassert}
2069 \func{}{wxASSERT}{\param{}{condition}}
2071 Assert macro. An error message will be generated if the condition is FALSE.
2073 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
2075 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
2077 Assert macro with message. An error message will be generated if the condition is FALSE.
2079 \membersection{wxFAIL}\label{wxfail}
2081 \func{}{wxFAIL}{\param{}{condition}}
2083 Will always generate an assert error if this code is reached (in debug mode).
2085 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
2087 \func{}{wxFAIL\_MSG}{\param{}{condition}, \param{}{msg}}
2089 Will always generate an assert error with specified message if this code is reached (in debug mode).
2091 \membersection{wxCHECK}\label{wxcheck}
2093 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
2095 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2096 This check is done even in release mode.
2098 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
2100 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
2102 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2103 This check is done even in release mode.