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
}{wxFindNextFile
}{\void}
72 Returns the next file that matches the path passed to
\helpref{wxFindFirstFile
}{wxfindfirstfile
}.
74 See
\helpref{wxFindFirstFile
}{wxfindfirstfile
} for an example.
76 \membersection{::wxGetOSDirectory
}\label{wxgetosdirectory
}
78 \func{wxString
}{wxGetOSDirectory
}{\void}
80 Returns the Windows directory under Windows; on other platforms returns the empty string.
82 \membersection{::wxIsAbsolutePath
}
84 \func{bool
}{wxIsAbsolutePath
}{\param{const wxString\&
}{filename
}}
86 Returns TRUE if the argument is an absolute filename, i.e. with a slash
87 or drive name at the beginning.
89 \membersection{::wxPathOnly
}
91 \func{wxString
}{wxPathOnly
}{\param{const wxString\&
}{path
}}
93 Returns the directory part of the filename.
95 \membersection{::wxUnix2DosFilename
}
97 \func{void
}{wxUnix2DosFilename
}{\param{const wxString\&
}{s
}}
99 Converts a Unix to a DOS filename by replacing forward
100 slashes with backslashes.
102 \membersection{::wxConcatFiles
}
104 \func{bool
}{wxConcatFiles
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
},
105 \param{const wxString\&
}{file3
}}
107 Concatenates
{\it file1
} and
{\it file2
} to
{\it file3
}, returning
110 \membersection{::wxCopyFile
}
112 \func{bool
}{wxCopyFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
114 Copies
{\it file1
} to
{\it file2
}, returning TRUE if successful.
116 \membersection{::wxGetCwd
}\label{wxgetcwd
}
118 \func{wxString
}{wxGetCwd
}{\void}
120 Returns a string containing the current (or working) directory.
122 \membersection{::wxGetWorkingDirectory
}
124 \func{wxString
}{wxGetWorkingDirectory
}{\param{char*
}{buf=NULL
},
\param{int
}{sz=
1000}}
126 This function is obsolete: use
\helpref{wxGetCwd
}{wxgetcwd
} instead.
128 Copies the current working directory into the buffer if supplied, or
129 copies the working directory into new storage (which you must delete yourself)
130 if the buffer is NULL.
132 {\it sz
} is the size of the buffer if supplied.
134 \membersection{::wxGetTempFileName
}
136 \func{char*
}{wxGetTempFileName
}{\param{const wxString\&
}{prefix
},
\param{char*
}{buf=NULL
}}
138 Makes a temporary filename based on
{\it prefix
}, opens and closes the file,
139 and places the name in
{\it buf
}. If
{\it buf
} is NULL, new store
140 is allocated for the temporary filename using
{\it new
}.
142 Under Windows, the filename will include the drive and name of the
143 directory allocated for temporary files (usually the contents of the
144 TEMP variable). Under Unix, the
{\tt /tmp
} directory is used.
146 It is the application's responsibility to create and delete the file.
148 \membersection{::wxIsWild
}\label{wxiswild
}
150 \func{bool
}{wxIsWild
}{\param{const wxString\&
}{pattern
}}
152 Returns TRUE if the pattern contains wildcards. See
\helpref{wxMatchWild
}{wxmatchwild
}.
154 \membersection{::wxMatchWild
}\label{wxmatchwild
}
156 \func{bool
}{wxMatchWild
}{\param{const wxString\&
}{pattern
},
\param{const wxString\&
}{text
},
\param{bool
}{ dot
\_special}}
158 Returns TRUE if the
{\it pattern
}\/ matches the
{\it text
}\/; if
{\it
159 dot
\_special}\/ is TRUE, filenames beginning with a dot are not matched
160 with wildcard characters. See
\helpref{wxIsWild
}{wxiswild
}.
162 \membersection{::wxMkdir
}
164 \func{bool
}{wxMkdir
}{\param{const wxString\&
}{dir
},
\param{int
}{perm =
0777}}
166 Makes the directory
{\it dir
}, returning TRUE if successful.
168 {\it perm
} is the access mask for the directory for the systems on which it is
169 supported (Unix) and doesn't have effect for the other ones.
171 \membersection{::wxRemoveFile
}
173 \func{bool
}{wxRemoveFile
}{\param{const wxString\&
}{file
}}
175 Removes
{\it file
}, returning TRUE if successful.
177 \membersection{::wxRenameFile
}
179 \func{bool
}{wxRenameFile
}{\param{const wxString\&
}{file1
},
\param{const wxString\&
}{file2
}}
181 Renames
{\it file1
} to
{\it file2
}, returning TRUE if successful.
183 \membersection{::wxRmdir
}
185 \func{bool
}{wxRmdir
}{\param{const wxString\&
}{dir
},
\param{int
}{ flags=
0}}
187 Removes the directory
{\it dir
}, returning TRUE if successful. Does not work under VMS.
189 The
{\it flags
} parameter is reserved for future use.
191 \membersection{::wxSetWorkingDirectory
}
193 \func{bool
}{wxSetWorkingDirectory
}{\param{const wxString\&
}{dir
}}
195 Sets the current working directory, returning TRUE if the operation succeeded.
196 Under MS Windows, the current drive is also changed if
{\it dir
} contains a drive specification.
198 \membersection{::wxSplitPath
}\label{wxsplitfunction
}
200 \func{void
}{wxSplitPath
}{\param{const char *
}{ fullname
},
\param{const wxString *
}{ path
},
\param{const wxString *
}{ name
},
\param{const wxString *
}{ ext
}}
202 This function splits a full file name into components: the path (including possible disk/drive
203 specification under Windows), the base name and the extension. Any of the output parameters
204 (
{\it path
},
{\it name
} or
{\it ext
}) may be NULL if you are not interested in the value of
205 a particular component.
207 wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
208 Windows, however it will not consider backslashes as path separators under Unix (where backslash
209 is a valid character in a filename).
211 On entry,
{\it fullname
} should be non NULL (it may be empty though).
213 On return,
{\it path
} contains the file path (without the trailing separator),
{\it name
}
214 contains the file name and
{\it ext
} contains the file extension without leading dot. All
215 three of them may be empty if the corresponding component is. The old contents of the
216 strings pointed to by these parameters will be overwritten in any case (if the pointers
219 \membersection{::wxTransferFileToStream
}\label{wxtransferfiletostream
}
221 \func{bool
}{wxTransferFileToStream
}{\param{const wxString\&
}{filename
},
\param{ostream\&
}{stream
}}
223 Copies the given file to
{\it stream
}. Useful when converting an old application to
224 use streams (within the
document/view framework, for example).
226 Use of this function requires the file wx
\_doc.h to be included.
228 \membersection{::wxTransferStreamToFile
}\label{wxtransferstreamtofile
}
230 \func{bool
}{wxTransferStreamToFile
}{\param{istream\&
}{stream
} \param{const wxString\&
}{filename
}}
232 Copies the given stream to the file
{\it filename
}. Useful when converting an old application to
233 use streams (within the
document/view framework, for example).
235 Use of this function requires the file wx
\_doc.h to be included.
237 \section{Network functions
}\label{networkfunctions
}
239 \membersection{::wxGetFullHostName
}\label{wxgetfullhostname
}
241 \func{wxString
}{wxGetFullHostName
}{\void}
243 Returns the FQDN (fully qualified domain host name) or an empty string on
246 See also:
\helpref{wxGetHostName
}{wxgethostname
}
248 \wxheading{Include files
}
252 \membersection{::wxGetEmailAddress
}\label{wxgetemailaddress
}
254 \func{bool
}{wxGetEmailAddress
}{\param{const wxString\&
}{buf
},
\param{int
}{sz
}}
256 Copies the user's email address into the supplied buffer, by
257 concatenating the values returned by
\helpref{wxGetFullHostName
}{wxgetfullhostname
}\rtfsp
258 and
\helpref{wxGetUserId
}{wxgetuserid
}.
260 Returns TRUE if successful, FALSE otherwise.
262 \wxheading{Include files
}
266 \membersection{::wxGetHostName
}\label{wxgethostname
}
268 \func{wxString
}{wxGetHostName
}{\void}
269 \func{bool
}{wxGetHostName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
271 Copies the current host machine's name into the supplied buffer. Please note
272 that the returned name is
{\it not
} fully qualified, i.e. it does not include
275 Under Windows or NT, this function first looks in the environment
276 variable SYSTEM
\_NAME; if this is not found, the entry
{\bf HostName
}\rtfsp
277 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
279 The first variant of this function returns the hostname if successful or an
280 empty string otherwise. The second (deprecated) function returns TRUE
281 if successful, FALSE otherwise.
283 See also:
\helpref{wxGetFullHostName
}{wxgetfullhostname
}
285 \wxheading{Include files
}
289 \section{User identification
}\label{useridfunctions
}
291 \membersection{::wxGetUserId
}\label{wxgetuserid
}
293 \func{wxString
}{wxGetUserId
}{\void}
294 \func{bool
}{wxGetUserId
}{\param{char *
}{buf
},
\param{int
}{sz
}}
296 This function returns the "user id" also known as "login name" under Unix i.e.
297 something like "jsmith". It uniquely identifies the current user (on this system).
299 Under Windows or NT, this function first looks in the environment
300 variables USER and LOGNAME; if neither of these is found, the entry
{\bf UserId
}\rtfsp
301 in the
{\bf wxWindows
} section of the WIN.INI file is tried.
303 The first variant of this function returns the login name if successful or an
304 empty string otherwise. The second (deprecated) function returns TRUE
305 if successful, FALSE otherwise.
307 See also:
\helpref{wxGetUserName
}{wxgetusername
}
309 \wxheading{Include files
}
313 \membersection{::wxGetUserName
}\label{wxgetusername
}
315 \func{wxString
}{wxGetUserName
}{\void}
316 \func{bool
}{wxGetUserName
}{\param{char *
}{buf
},
\param{int
}{sz
}}
318 This function returns the full user name (something like "Mr. John Smith").
320 Under Windows or NT, this function looks for the entry
{\bf UserName
}\rtfsp
321 in the
{\bf wxWindows
} section of the WIN.INI file. If PenWindows
322 is running, the entry
{\bf Current
} in the section
{\bf User
} of
323 the PENWIN.INI file is used.
325 The first variant of this function returns the user name if successful or an
326 empty string otherwise. The second (deprecated) function returns TRUE
327 if successful, FALSE otherwise.
329 See also:
\helpref{wxGetUserId
}{wxgetuserid
}
331 \wxheading{Include files
}
335 \section{String functions
}
337 \membersection{::copystring
}
339 \func{char*
}{copystring
}{\param{const char*
}{s
}}
341 Makes a copy of the string
{\it s
} using the C++ new operator, so it can be
342 deleted with the
{\it delete
} operator.
344 \membersection{::wxStringMatch
}
346 \func{bool
}{wxStringMatch
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
},\\
347 \param{bool
}{ subString = TRUE
},
\param{bool
}{ exact = FALSE
}}
349 Returns TRUE if the substring
{\it s1
} is found within
{\it s2
},
350 ignoring case if
{\it exact
} is FALSE. If
{\it subString
} is FALSE,
351 no substring matching is done.
353 \membersection{::wxStringEq
}\label{wxstringeq
}
355 \func{bool
}{wxStringEq
}{\param{const wxString\&
}{s1
},
\param{const wxString\&
}{s2
}}
360 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) ==
0))
363 \membersection{::IsEmpty
}\label{isempty
}
365 \func{bool
}{IsEmpty
}{\param{const char *
}{ p
}}
367 Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL
368 pointer to this function and it will return TRUE for it.
370 \membersection{::Stricmp
}\label{stricmp
}
372 \func{int
}{Stricmp
}{\param{const char *
}{p1
},
\param{const char *
}{p2
}}
374 Returns a negative value,
0, or positive value if
{\it p1
} is less than, equal
375 to or greater than
{\it p2
}. The comparison is case-insensitive.
377 This function complements the standard C function
{\it strcmp()
} which performs
378 case-sensitive comparison.
380 \membersection{::Strlen
}\label{strlen
}
382 \func{size
\_t}{Strlen
}{\param{const char *
}{ p
}}
384 This is a safe version of standard function
{\it strlen()
}: it does exactly the
385 same thing (i.e. returns the length of the string) except that it returns
0 if
386 {\it p
} is the NULL pointer.
388 \membersection{::wxGetTranslation
}\label{wxgettranslation
}
390 \func{const char *
}{wxGetTranslation
}{\param{const char *
}{str
}}
392 This function returns the translation of string
{\it str
} in the current
393 \helpref{locale
}{wxlocale
}. If the string is not found in any of the loaded
394 message catalogs (see
\helpref{i18n overview
}{internationalization
}), the
395 original string is returned. In debug build, an error message is logged - this
396 should help to find the strings which were not yet translated. As this function
397 is used very often, an alternative syntax is provided: the
\_() macro is
398 defined as wxGetTranslation().
400 \section{Dialog functions
}\label{dialogfunctions
}
402 Below are a number of convenience functions for getting input from the
403 user or displaying messages. Note that in these functions the last three
404 parameters are optional. However, it is recommended to pass a parent frame
405 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
406 the front when the dialog box is popped up.
408 \membersection{::wxFileSelector
}\label{wxfileselector
}
410 \func{wxString
}{wxFileSelector
}{\param{const wxString\&
}{message
},
\param{const wxString\&
}{default
\_path = ""
},\\
411 \param{const wxString\&
}{default
\_filename = ""
},
\param{const wxString\&
}{default
\_extension = ""
},\\
412 \param{const wxString\&
}{wildcard = ``*.*''
},
\param{int
}{flags =
0},
\param{wxWindow *
}{parent = ""
},\\
413 \param{int
}{ x = -
1},
\param{int
}{ y = -
1}}
415 Pops up a file selector box. In Windows, this is the common file selector
416 dialog. In X, this is a file selector box with somewhat less functionality.
417 The path and filename are distinct elements of a full file pathname.
418 If path is empty, the current directory will be used. If filename is empty,
419 no default filename will be supplied. The wildcard determines what files
420 are displayed in the file selector, and file extension supplies a type
421 extension for the required filename. Flags may be a combination of wxOPEN,
422 wxSAVE, wxOVERWRITE
\_PROMPT, wxHIDE
\_READONLY, or
0. They are only significant
423 at present in Windows.
425 Both the X and Windows versions implement a wildcard filter. Typing a
426 filename containing wildcards
(*, ?) in the filename text item, and
427 clicking on Ok, will result in only those files matching the pattern being
428 displayed. In the X version, supplying no default name will result in the
429 wildcard filter being inserted in the filename text item; the filter is
430 ignored if a default name is supplied.
432 Under Windows (only), the wildcard may be a specification for multiple
433 types of file with a description for each, such as:
436 "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
439 The application must check for an empty return value (the user pressed
440 Cancel). For example:
443 const wxString& s = wxFileSelector("Choose a file to open");
450 \wxheading{Include files}
454 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
456 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
457 \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
458 \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
460 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
461 \rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
462 or press Cancel to return the empty string.
464 If {\it centre} is TRUE, the message text (which may include new line characters)
465 is centred; if FALSE, the message is left-justified.
467 \wxheading{Include files}
471 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
473 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
474 \param{int }{nsel}, \param{int *}{selection},
475 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
476 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
478 Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
479 listbox. The user may choose one or more item(s) and press OK or Cancel.
481 The number of initially selected choices, and array of the selected indices,
482 are passed in; this array will contain the user selections on exit, with
483 the function returning the number of selections. {\it selection} must be
484 as big as the number of choices, in case all are selected.
486 If Cancel is pressed, -1 is returned.
488 {\it choices} is an array of {\it n} strings for the listbox.
490 If {\it centre} is TRUE, the message text (which may include new line characters)
491 is centred; if FALSE, the message is left-justified.
493 \wxheading{Include files}
497 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
499 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
500 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
501 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
503 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
504 listbox. The user may choose an item and press OK to return a string or
505 Cancel to return the empty string.
507 {\it choices} is an array of {\it n} strings for the listbox.
509 If {\it centre} is TRUE, the message text (which may include new line characters)
510 is centred; if FALSE, the message is left-justified.
512 \wxheading{Include files}
516 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
518 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
519 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
520 \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
522 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
523 If the user pressed cancel, -1 is returned.
525 \wxheading{Include files}
529 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
531 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
532 \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
533 \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
535 As {\bf wxGetSingleChoice} but takes an array of client data pointers
536 corresponding to the strings, and returns one of these pointers.
538 \wxheading{Include files}
542 \membersection{::wxMessageBox}\label{wxmessagebox}
544 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
545 \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
547 General purpose message dialog. {\it style} may be a bit list of the
548 following identifiers:
550 \begin{twocollist}\itemsep=0pt
551 \twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
553 \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
555 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
556 \twocolitem{wxCENTRE}{Centres the text.}
557 \twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
558 \twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
559 \twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
560 \twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
563 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
569 int answer = wxMessageBox("Quit program?", "Confirm",
570 wxYES_NO | wxCANCEL, main_frame);
576 {\it message} may contain newline characters, in which case the
577 message will be split into separate lines, to cater for large messages.
579 Under Windows, the native MessageBox function is used unless wxCENTRE
580 is specified in the style, in which case a generic function is used.
581 This is because the native MessageBox function cannot centre text.
582 The symbols are not shown when the generic function is used.
584 \wxheading{Include files}
588 \section{GDI functions}\label{gdifunctions}
590 The following are relevant to the GDI (Graphics Device Interface).
592 \wxheading{Include files}
596 \membersection{::wxColourDisplay}
598 \func{bool}{wxColourDisplay}{\void}
600 Returns TRUE if the display is colour, FALSE otherwise.
602 \membersection{::wxDisplayDepth}
604 \func{int}{wxDisplayDepth}{\void}
606 Returns the depth of the display (a value of 1 denotes a monochrome display).
608 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
610 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
611 \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
613 Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
614 makes it into a placeable metafile by prepending a header containing the given
615 bounding box. The bounding box may be obtained from a device context after drawing
616 into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
618 In addition to adding the placeable metafile header, this function adds
619 the equivalent of the following code to the start of the metafile data:
622 SetMapMode(dc, MM_ANISOTROPIC);
623 SetWindowOrg(dc, minX, minY);
624 SetWindowExt(dc, maxX - minX, maxY - minY);
627 This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
629 Placeable metafiles may be imported by many Windows applications, and can be
630 used in RTF (Rich Text Format) files.
632 {\it scale} allows the specification of scale for the metafile.
634 This function is only available under Windows.
636 \membersection{::wxSetCursor}\label{wxsetcursor}
638 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
640 Globally sets the cursor; only has an effect in MS Windows.
641 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
643 \section{Printer settings}\label{printersettings}
645 The following functions are used to control PostScript printing. Under
646 Windows, PostScript output can only be sent to a file.
648 \wxheading{Include files}
652 \membersection{::wxGetPrinterCommand}
654 \func{wxString}{wxGetPrinterCommand}{\void}
656 Gets the printer command used to print a file. The default is {\tt lpr}.
658 \membersection{::wxGetPrinterFile}
660 \func{wxString}{wxGetPrinterFile}{\void}
662 Gets the PostScript output filename.
664 \membersection{::wxGetPrinterMode}
666 \func{int}{wxGetPrinterMode}{\void}
668 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
669 The default is PS\_PREVIEW.
671 \membersection{::wxGetPrinterOptions}
673 \func{wxString}{wxGetPrinterOptions}{\void}
675 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
677 \membersection{::wxGetPrinterOrientation}
679 \func{int}{wxGetPrinterOrientation}{\void}
681 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
683 \membersection{::wxGetPrinterPreviewCommand}
685 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
687 Gets the command used to view a PostScript file. The default depends on the platform.
689 \membersection{::wxGetPrinterScaling}
691 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
693 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
695 \membersection{::wxGetPrinterTranslation}
697 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
699 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
701 \membersection{::wxSetPrinterCommand}
703 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
705 Sets the printer command used to print a file. The default is {\tt lpr}.
707 \membersection{::wxSetPrinterFile}
709 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
711 Sets the PostScript output filename.
713 \membersection{::wxSetPrinterMode}
715 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
717 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
718 The default is PS\_PREVIEW.
720 \membersection{::wxSetPrinterOptions}
722 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
724 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
726 \membersection{::wxSetPrinterOrientation}
728 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
730 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
732 \membersection{::wxSetPrinterPreviewCommand}
734 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
736 Sets the command used to view a PostScript file. The default depends on the platform.
738 \membersection{::wxSetPrinterScaling}
740 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
742 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
744 \membersection{::wxSetPrinterTranslation}
746 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
748 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
750 \section{Clipboard functions}\label{clipsboard}
752 These clipboard functions are implemented for Windows only.
754 \wxheading{Include files}
758 \membersection{::wxClipboardOpen}
760 \func{bool}{wxClipboardOpen}{\void}
762 Returns TRUE if this application has already opened the clipboard.
764 \membersection{::wxCloseClipboard}
766 \func{bool}{wxCloseClipboard}{\void}
768 Closes the clipboard to allow other applications to use it.
770 \membersection{::wxEmptyClipboard}
772 \func{bool}{wxEmptyClipboard}{\void}
774 Empties the clipboard.
776 \membersection{::wxEnumClipboardFormats}
778 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
780 Enumerates the formats found in a list of available formats that belong
781 to the clipboard. Each call to this function specifies a known
782 available format; the function returns the format that appears next in
785 {\it dataFormat} specifies a known format. If this parameter is zero,
786 the function returns the first format in the list.
788 The return value specifies the next known clipboard data format if the
789 function is successful. It is zero if the {\it dataFormat} parameter specifies
790 the last format in the list of available formats, or if the clipboard
793 Before it enumerates the formats function, an application must open the clipboard by using the
794 wxOpenClipboard function.
796 \membersection{::wxGetClipboardData}
798 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
800 Gets data from the clipboard.
802 {\it dataFormat} may be one of:
804 \begin{itemize}\itemsep=0pt
805 \item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
806 \item wxCF\_BITMAP: returns a new wxBitmap.
809 The clipboard must have previously been opened for this call to succeed.
811 \membersection{::wxGetClipboardFormatName}
813 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
815 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
816 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
818 \membersection{::wxIsClipboardFormatAvailable}
820 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
822 Returns TRUE if the given data format is available on the clipboard.
824 \membersection{::wxOpenClipboard}
826 \func{bool}{wxOpenClipboard}{\void}
828 Opens the clipboard for passing data to it or getting data from it.
830 \membersection{::wxRegisterClipboardFormat}
832 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
834 Registers the clipboard data format name and returns an identifier.
836 \membersection{::wxSetClipboardData}
838 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
840 Passes data to the clipboard.
842 {\it dataFormat} may be one of:
844 \begin{itemize}\itemsep=0pt
845 \item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
846 \item wxCF\_BITMAP: {\it data} is a wxBitmap.
847 \item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
848 \item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
851 The clipboard must have previously been opened for this call to succeed.
853 \section{Miscellaneous functions}\label{miscellany}
855 \membersection{::wxNewId}
857 \func{long}{wxNewId}{\void}
859 Generates an integer identifier unique to this run of the program.
861 \wxheading{Include files}
865 \membersection{::wxRegisterId}
867 \func{void}{wxRegisterId}{\param{long}{ id}}
869 Ensures that ids subsequently generated by {\bf NewId} do not clash with
872 \wxheading{Include files}
876 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
878 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
880 Changes the cursor to the given cursor for all windows in the application.
881 Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
882 to its previous state. These two calls can be nested, and a counter
883 ensures that only the outer calls take effect.
885 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
887 \wxheading{Include files}
891 \membersection{::wxBell}
893 \func{void}{wxBell}{\void}
895 Ring the system bell.
897 \wxheading{Include files}
901 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
903 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
905 Creates and returns an object of the given class, if the class has been
906 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
908 \membersection{::wxDDECleanUp}\label{wxddecleanup}
910 \func{void}{wxDDECleanUp}{\void}
912 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
913 called by the application.
915 See also helpref{wxDDEInitialize}{wxddeinitialize}.
917 \wxheading{Include files}
921 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
923 \func{void}{wxDDEInitialize}{\void}
925 Initializes the DDE system. May be called multiple times without harm.
927 This no longer needs to be called by the application: it will be called
928 by wxWindows if necessary.
930 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
931 \helpref{wxDDECleanUp}{wxddecleanup}.
933 \wxheading{Include files}
937 \membersection{::wxDebugMsg}\label{wxdebugmsg}
939 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
941 Display a debugging message; under Windows, this will appear on the
942 debugger command window, and under Unix, it will be written to standard
945 The syntax is identical to {\bf printf}: pass a format string and a
946 variable list of arguments.
948 Note that under Windows, you can see the debugging messages without a
949 debugger if you have the DBWIN debug log application that comes with
952 {\bf Tip:} under Windows, if your application crashes before the
953 message appears in the debugging window, put a wxYield call after
954 each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
955 (at least for Watcom C++): preformat your messages and use OutputDebugString
958 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
960 \wxheading{Include files}
964 \membersection{::wxDisplaySize}
966 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
968 Gets the physical size of the display in pixels.
970 \wxheading{Include files}
974 \membersection{::wxEntry}\label{wxentry}
976 This initializes wxWindows in a platform-dependent way. Use this if you
977 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
978 you can initialize wxWindows from an Microsoft Foundation Classes application using
981 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
982 \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
984 wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
985 function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
986 message loop will be entered.
988 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
989 \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
991 wxWindows initialization under Windows (for applications constructed as a DLL).
993 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
995 wxWindows initialization under Unix.
999 To clean up wxWindows, call wxApp::OnExit followed by the static function
1000 wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
1003 int CTheApp::ExitInstance()
1005 // OnExit isn't called by CleanUp so must be called explicitly.
1009 return CWinApp::ExitInstance();
1013 \wxheading{Include files}
1017 \membersection{::wxError}\label{wxerror}
1019 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
1021 Displays {\it msg} and continues. This writes to standard error under
1022 Unix, and pops up a message box under Windows. Used for internal
1023 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
1025 \wxheading{Include files}
1029 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
1031 \func{void}{wxEndBusyCursor}{\void}
1033 Changes the cursor back to the original cursor, for all windows in the application.
1034 Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
1036 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
1038 \wxheading{Include files}
1042 \membersection{::wxExecute}\label{wxexecute}
1044 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1046 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
1048 Executes another program in Unix or Windows.
1050 The first form takes a command string, such as {\tt "emacs file.txt"}.
1052 The second form takes an array of values: a command, any number of
1053 arguments, terminated by NULL.
1055 If {\it sync} is FALSE (the default), flow of control immediately returns.
1056 If TRUE, the current application waits until the other program has terminated.
1058 In the case of synchronous execution, the return value is the exit code of
1059 the process (which terminates by the moment the function returns) and will be
1060 $-1$ if the process couldn't be started and typically 0 if the process
1061 terminated successfully.
1063 For asynchronous execution, however, the return value is the process id and
1064 zero value indicates that the command could not be executed.
1066 If callback isn't NULL and if execution is asynchronous (note that callback
1067 parameter can not be non NULL for synchronous execution),
1068 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
1069 the process finishes.
1071 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
1073 \wxheading{Include files}
1077 \membersection{::wxExit}\label{wxexit}
1079 \func{void}{wxExit}{\void}
1081 Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
1082 Should only be used in an emergency: normally the top-level frame
1083 should be deleted (after deleting all other frames) to terminate the
1084 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
1086 \wxheading{Include files}
1090 \membersection{::wxFatalError}\label{wxfatalerror}
1092 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
1094 Displays {\it msg} and exits. This writes to standard error under Unix,
1095 and pops up a message box under Windows. Used for fatal internal
1096 wxWindows errors. See also \helpref{wxError}{wxerror}.
1098 \wxheading{Include files}
1102 \membersection{::wxFindMenuItemId}
1104 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
1106 Find a menu item identifier associated with the given frame's menu bar.
1108 \wxheading{Include files}
1112 \membersection{::wxFindWindowByLabel}
1114 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
1116 Find a window by its label. Depending on the type of window, the label may be a window title
1117 or panel item label. If {\it parent} is NULL, the search will start from all top-level
1118 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1119 The search is recursive in both cases.
1121 \wxheading{Include files}
1125 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
1127 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
1129 Find a window by its name (as given in a window constructor or {\bf Create} function call).
1130 If {\it parent} is NULL, the search will start from all top-level
1131 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
1132 The search is recursive in both cases.
1134 If no such named window is found, {\bf wxFindWindowByLabel} is called.
1136 \wxheading{Include files}
1140 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
1142 \func{wxWindow *}{wxGetActiveWindow}{\void}
1144 Gets the currently active window (Windows only).
1146 \wxheading{Include files}
1150 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
1152 \func{wxString}{wxGetDisplayName}{\void}
1154 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
1156 \wxheading{Include files}
1160 \membersection{::wxGetHomeDir}
1162 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
1164 Fills the buffer with a string representing the user's home directory (Unix only).
1166 \wxheading{Include files}
1170 \membersection{::wxGetHostName}
1172 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1174 Copies the host name of the machine the program is running on into the
1175 buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
1176 successful. Under Unix, this will return a machine name. Under Windows,
1177 this returns ``windows''.
1179 \wxheading{Include files}
1183 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
1185 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
1187 Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
1189 If {\it resetTimer} is TRUE (the default), the timer is reset to zero
1192 See also \helpref{wxTimer}{wxtimer}.
1194 \wxheading{Include files}
1198 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
1200 \func{long}{wxGetFreeMemory}{\void}
1202 Returns the amount of free memory in Kbytes under environments which
1203 support it, and -1 if not supported. Currently, returns a positive value
1204 under Windows, and -1 under Unix.
1206 \wxheading{Include files}
1210 \membersection{::wxGetMousePosition}
1212 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
1214 Returns the mouse position in screen coordinates.
1216 \wxheading{Include files}
1220 \membersection{::wxGetOsVersion}
1222 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
1224 Gets operating system version information.
1226 \begin{twocollist}\itemsep=0pt
1227 \twocolitemruled{Platform}{Return tyes}
1228 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
1229 \twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
1230 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
1231 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
1232 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
1233 \twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
1234 \twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
1235 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
1236 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
1239 \wxheading{Include files}
1243 \membersection{::wxGetResource}\label{wxgetresource}
1245 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1246 \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
1248 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1249 \param{float *}{value}, \param{const wxString\& }{file = NULL}}
1251 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1252 \param{long *}{value}, \param{const wxString\& }{file = NULL}}
1254 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1255 \param{int *}{value}, \param{const wxString\& }{file = NULL}}
1257 Gets a resource value from the resource database (for example, WIN.INI, or
1258 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1259 otherwise the specified file is used.
1261 Under X, if an application class (wxApp::GetClassName) has been defined,
1262 it is appended to the string /usr/lib/X11/app-defaults/ to try to find
1263 an applications default file when merging all resource databases.
1265 The reason for passing the result in an argument is that it
1266 can be convenient to define a default value, which gets overridden
1267 if the value exists in the resource file. It saves a separate
1268 test for that resource's existence, and it also allows
1269 the overloading of the function for different types.
1271 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
1273 \wxheading{Include files}
1277 \membersection{::wxGetUserId}
1279 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1281 Copies the user's login identity (such as ``jacs'') into the buffer {\it
1282 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1283 Under Windows, this returns ``user''.
1285 \wxheading{Include files}
1289 \membersection{::wxGetUserName}
1291 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
1293 Copies the user's name (such as ``Julian Smart'') into the buffer {\it
1294 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
1295 Under Windows, this returns ``unknown''.
1297 \wxheading{Include files}
1301 \membersection{::wxKill}\label{wxkill}
1303 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
1305 Under Unix (the only supported platform), equivalent to the Unix kill function.
1306 Returns 0 on success, -1 on failure.
1308 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
1309 It does not raise a signal in the receiving process.
1311 \wxheading{Include files}
1315 \membersection{::wxIsBusy}\label{wxisbusy}
1317 \func{bool}{wxIsBusy}{\void}
1319 Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
1320 \helpref{wxEndBusyCursor}{wxendbusycursor} calls.
1322 See also \helpref{wxBusyCursor}{wxbusycursor}.
1324 \wxheading{Include files}
1328 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
1330 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
1332 Loads a user-defined Windows resource as a string. If the resource is found, the function creates
1333 a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
1335 The resource must be defined in the {\tt .rc} file using the following syntax:
1338 myResource TEXT file.ext
1341 where {\tt file.ext} is a file that the resource compiler can find.
1343 One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
1344 cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
1345 using \helpref{wxResourceParseString}{wxresourceparsestring}.
1347 This function is available under Windows only.
1349 \wxheading{Include files}
1353 \membersection{::wxNow}\label{wxnow}
1355 \func{wxString}{wxNow}{\void}
1357 Returns a string representing the current date and time.
1359 \wxheading{Include files}
1363 \membersection{::wxPostDelete}\label{wxpostdelete}
1365 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
1367 Tells the system to delete the specified object when
1368 all other events have been processed. In some environments, it is
1369 necessary to use this instead of deleting a frame directly with the
1370 delete operator, because some GUIs will still send events to a deleted window.
1372 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
1374 \wxheading{Include files}
1378 \membersection{::wxSafeYield}{wxsafeyield}
1380 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
1382 This function is similar to wxYield, except that it disables the user input to
1383 all program windows before calling wxYield and re-enables it again
1384 afterwards. If {\it win} is not NULL, this window will remain enabled,
1385 allowing the implementation of some limited user interaction.
1387 Returns the result of the call to \helpref{::wxYield}{wxyield}.
1389 \wxheading{Include files}
1393 \membersection{::wxEnableTopLevelWindows}{wxenabletoplevelwindows}
1395 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
1397 This function enables or disables all top level windows. It is used by
1398 \helpref{::wxSafeYield}{wxsafeyield}.
1400 \wxheading{Include files}
1405 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
1407 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
1409 Under X only, sets the current display name. This is the X host and display name such
1410 as ``colonsay:0.0", and the function indicates which display should be used for creating
1411 windows from this point on. Setting the display within an application allows multiple
1412 displays to be used.
1414 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
1416 \wxheading{Include files}
1420 \membersection{::wxShell}\label{wxshell}
1422 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
1424 Executes a command in an interactive shell window. If no command is
1425 specified, then just the shell is spawned.
1427 See also \helpref{wxExecute}{wxexecute}.
1429 \wxheading{Include files}
1433 \membersection{::wxSleep}\label{wxsleep}
1435 \func{void}{wxSleep}{\param{int}{ secs}}
1437 Sleeps for the specified number of seconds.
1439 \wxheading{Include files}
1443 \membersection{::wxStripMenuCodes}
1445 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
1447 \func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
1449 Strips any menu codes from {\it in} and places the result
1450 in {\it out} (or returns the new string, in the first form).
1452 Menu codes include \& (mark the next character with an underline
1453 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
1455 \wxheading{Include files}
1459 \membersection{::wxStartTimer}\label{wxstarttimer}
1461 \func{void}{wxStartTimer}{\void}
1463 Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
1465 See also \helpref{wxTimer}{wxtimer}.
1467 \wxheading{Include files}
1471 \membersection{::wxToLower}\label{wxtolower}
1473 \func{char}{wxToLower}{\param{char }{ch}}
1475 Converts the character to lower case. This is implemented as a macro for efficiency.
1477 \wxheading{Include files}
1481 \membersection{::wxToUpper}\label{wxtoupper}
1483 \func{char}{wxToUpper}{\param{char }{ch}}
1485 Converts the character to upper case. This is implemented as a macro for efficiency.
1487 \wxheading{Include files}
1491 \membersection{::wxTrace}\label{wxtrace}
1493 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
1495 Takes printf-style variable argument syntax. Output
1496 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1498 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1500 \wxheading{Include files}
1504 \membersection{::wxTraceLevel}\label{wxtracelevel}
1506 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
1508 Takes printf-style variable argument syntax. Output
1509 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1510 The first argument should be the level at which this information is appropriate.
1511 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1514 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1516 \wxheading{Include files}
1520 \membersection{::wxUsleep}\label{wxusleep}
1522 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
1524 Sleeps for the specified number of milliseconds. Notice that usage of this
1525 function is encouraged instead of calling usleep(3) directly because the
1526 standard usleep() function is not MT safe.
1528 \wxheading{Include files}
1532 \membersection{::wxWriteResource}\label{wxwriteresource}
1534 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1535 \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
1537 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1538 \param{float }{value}, \param{const wxString\& }{file = NULL}}
1540 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1541 \param{long }{value}, \param{const wxString\& }{file = NULL}}
1543 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
1544 \param{int }{value}, \param{const wxString\& }{file = NULL}}
1546 Writes a resource value into the resource database (for example, WIN.INI, or
1547 .Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
1548 otherwise the specified file is used.
1550 Under X, the resource databases are cached until the internal function
1551 \rtfsp{\bf wxFlushResources} is called automatically on exit, when
1552 all updated resource databases are written to their files.
1554 Note that it is considered bad manners to write to the .Xdefaults
1555 file under Unix, although the WIN.INI file is fair game under Windows.
1557 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
1559 \wxheading{Include files}
1563 \membersection{::wxYield}\label{wxyield}
1565 \func{bool}{wxYield}{\void}
1567 Yields control to pending messages in the windowing system. This can be useful, for example, when a
1568 time-consuming process writes to a text window. Without an occasional
1569 yield, the text window will not be updated properly, and (since Windows
1570 multitasking is cooperative) other processes will not respond.
1572 Caution should be exercised, however, since yielding may allow the
1573 user to perform actions which are not compatible with the current task.
1574 Disabling menu items or whole menus during processing can avoid unwanted
1575 reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
1578 \wxheading{Include files}
1582 \section{Macros}\label{macros}
1584 These macros are defined in wxWindows.
1586 \membersection{CLASSINFO}\label{classinfo}
1588 \func{wxClassInfo *}{CLASSINFO}{className}
1590 Returns a pointer to the wxClassInfo object associated with this class.
1592 \wxheading{Include files}
1596 \membersection{WXDEBUG\_NEW}\label{debugnew}
1598 \func{}{WXDEBUG\_NEW}{arg}
1600 This is defined in debug mode to be call the redefined new operator
1601 with filename and line number arguments. The definition is:
1604 #define WXDEBUG_NEW new(__FILE__,__LINE__)
1607 In non-debug mode, this is defined as the normal new operator.
1609 \wxheading{Include files}
1613 \membersection{DECLARE\_ABSTRACT\_CLASS}
1615 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
1617 Used inside a class declaration to declare that the class should be
1618 made known to the class hierarchy, but objects of this class cannot be created
1619 dynamically. The same as DECLARE\_CLASS.
1624 class wxCommand: public wxObject
1626 DECLARE_ABSTRACT_CLASS(wxCommand)
1635 \wxheading{Include files}
1639 \membersection{DECLARE\_APP}\label{declareapp}
1641 \func{}{DECLARE\_APP}{className}
1643 This is used in headers to create a forward declaration of the wxGetApp function implemented
1644 by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
1652 \wxheading{Include files}
1656 \membersection{DECLARE\_CLASS}
1658 \func{}{DECLARE\_CLASS}{className}
1660 Used inside a class declaration to declare that the class should be
1661 made known to the class hierarchy, but objects of this class cannot be created
1662 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
1664 \wxheading{Include files}
1668 \membersection{DECLARE\_DYNAMIC\_CLASS}
1670 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
1672 Used inside a class declaration to declare that the objects of this class should be dynamically
1673 createable from run-time type information.
1678 class wxFrame: public wxWindow
1680 DECLARE_DYNAMIC_CLASS(wxFrame)
1683 const wxString\& frameTitle;
1689 \wxheading{Include files}
1693 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
1695 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
1697 Used in a C++ implementation file to complete the declaration of
1698 a class that has run-time type information. The same as IMPLEMENT\_CLASS.
1703 IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
1705 wxCommand::wxCommand(void)
1711 \wxheading{Include files}
1715 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
1717 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
1719 Used in a C++ implementation file to complete the declaration of
1720 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
1722 \wxheading{Include files}
1726 \membersection{IMPLEMENT\_APP}\label{implementapp}
1728 \func{}{IMPLEMENT\_APP}{className}
1730 This is used in the application class implementation file to make the application class known to
1731 wxWindows for dynamic construction. You use this instead of
1742 IMPLEMENT_APP(MyApp)
1745 See also \helpref{DECLARE\_APP}{declareapp}.
1747 \wxheading{Include files}
1751 \membersection{IMPLEMENT\_CLASS}
1753 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
1755 Used in a C++ implementation file to complete the declaration of
1756 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
1758 \wxheading{Include files}
1762 \membersection{IMPLEMENT\_CLASS2}
1764 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
1766 Used in a C++ implementation file to complete the declaration of a
1767 class that has run-time type information and two base classes. The
1768 same as IMPLEMENT\_ABSTRACT\_CLASS2.
1770 \wxheading{Include files}
1774 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
1776 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
1778 Used in a C++ implementation file to complete the declaration of
1779 a class that has run-time type information, and whose instances
1780 can be created dynamically.
1785 IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
1787 wxFrame::wxFrame(void)
1793 \wxheading{Include files}
1797 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
1799 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
1801 Used in a C++ implementation file to complete the declaration of
1802 a class that has run-time type information, and whose instances
1803 can be created dynamically. Use this for classes derived from two
1806 \wxheading{Include files}
1810 \membersection{WXTRACE}\label{trace}
1812 \func{}{WXTRACE}{formatString, ...}
1814 Calls wxTrace with printf-style variable argument syntax. Output
1815 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1817 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1819 \wxheading{Include files}
1823 \membersection{WXTRACELEVEL}\label{tracelevel}
1825 \func{}{WXTRACELEVEL}{level, formatString, ...}
1827 Calls wxTraceLevel with printf-style variable argument syntax. Output
1828 is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
1829 The first argument should be the level at which this information is appropriate.
1830 It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
1833 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
1835 \wxheading{Include files}
1839 \section{wxWindows resource functions}\label{resourcefuncs}
1841 \overview{wxWindows resource system}{resourceformats}
1843 This section details functions for manipulating wxWindows (.WXR) resource
1844 files and loading user interface elements from resources.
1846 \normalbox{Please note that this use of the word `resource' is different from that used when talking
1847 about initialisation file resource reading and writing, using such functions
1848 as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
1850 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
1852 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
1853 loading from resource data.
1855 {\bf Warning:} this needs updating for wxWindows 2.
1857 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
1859 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
1861 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
1862 \verb$#$defining a name to an integer). Unlikely to be used by an application except
1863 perhaps for implementing resource functionality for interpreted languages.
1865 \membersection{::wxResourceClear}
1867 \func{void}{wxResourceClear}{\void}
1869 Clears the wxWindows resource table.
1871 \membersection{::wxResourceCreateBitmap}
1873 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
1875 Creates a new bitmap from a file, static data, or Windows resource, given a valid
1876 wxWindows bitmap resource identifier. For example, if the .WXR file contains
1880 static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
1881 bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
1882 bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
1885 then this function can be called as follows:
1888 wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
1891 \membersection{::wxResourceCreateIcon}
1893 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
1895 Creates a new icon from a file, static data, or Windows resource, given a valid
1896 wxWindows icon resource identifier. For example, if the .WXR file contains
1900 static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
1901 icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
1902 icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
1905 then this function can be called as follows:
1908 wxIcon *icon = wxResourceCreateIcon("aiai_resource");
1911 \membersection{::wxResourceCreateMenuBar}
1913 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
1915 Creates a new menu bar given a valid wxWindows menubar resource
1916 identifier. For example, if the .WXR file contains the following:
1919 static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
1923 ['&Open File', 2, 'Open a file'],\
1924 ['&Save File', 3, 'Save a file'],\
1926 ['E&xit', 4, 'Exit program']\
1929 ['&About', 6, 'About this program']\
1934 then this function can be called as follows:
1937 wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
1941 \membersection{::wxResourceGetIdentifier}
1943 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
1945 Used for retrieving the integer value associated with an identifier.
1946 A zero value indicates that the identifier was not found.
1948 See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
1950 \membersection{::wxResourceParseData}\label{wxresourcedata}
1952 \func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
1954 Parses a string containing one or more wxWindows resource objects. If
1955 the resource objects are global static data that are included into the
1956 C++ program, then this function must be called for each variable
1957 containing the resource data, to make it known to wxWindows.
1959 {\it resource} should contain data in the following form:
1962 dialog(name = 'dialog1',
1963 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
1964 title = 'Test dialog box',
1965 x = 312, y = 234, width = 400, height = 300,
1967 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
1968 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
1969 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
1970 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
1971 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
1972 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
1975 This function will typically be used after including a {\tt .wxr} file into
1976 a C++ program as follows:
1979 #include "dialog1.wxr"
1982 Each of the contained resources will declare a new C++ variable, and each
1983 of these variables should be passed to wxResourceParseData.
1985 \membersection{::wxResourceParseFile}
1987 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
1989 Parses a file containing one or more wxWindows resource objects
1990 in C++-compatible syntax. Use this function to dynamically load
1991 wxWindows resource data.
1993 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
1995 \func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
1997 Parses a string containing one or more wxWindows resource objects. If
1998 the resource objects are global static data that are included into the
1999 C++ program, then this function must be called for each variable
2000 containing the resource data, to make it known to wxWindows.
2002 {\it resource} should contain data with the following form:
2005 static const wxString\& dialog1 = "dialog(name = 'dialog1',\
2006 style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
2007 title = 'Test dialog box',\
2008 x = 312, y = 234, width = 400, height = 300,\
2010 control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
2011 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
2012 control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
2013 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
2014 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
2015 [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
2018 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
2019 load an entire {\tt .wxr file} into a string.
2021 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
2023 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
2024 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
2026 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
2028 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
2029 This is required if other resources will use the bitmap data, since otherwise there
2030 is no connection between names used in resources, and the global bitmap data.
2032 \membersection{::wxResourceRegisterIconData}
2034 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
2036 \section{Log functions}\label{logfunctions}
2038 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
2039 further information.
2041 \wxheading{Include files}
2045 \membersection{::wxLogError}\label{wxlogerror}
2047 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
2049 The function to use for error messages, i.e. the
2050 messages that must be shown to the user. The default processing is to pop up a
2051 message box to inform the user about it.
2053 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
2055 \func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
2057 Like \helpref{wxLogError}{wxlogerror}, but also
2058 terminates the program with the exit code 3. Using {\it abort()} standard
2059 function also terminates the program with this exit code.
2061 \membersection{::wxLogWarning}\label{wxlogwarning}
2063 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
2065 For warnings - they are also normally shown to the
2066 user, but don't interrupt the program work.
2068 \membersection{::wxLogMessage}\label{wxlogmessage}
2070 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
2072 for all normal, informational messages. They also
2073 appear in a message box by default (but it can be changed). Notice
2074 that the standard behaviour is to not show informational messages if there are
2075 any errors later - the logic being that the later error messages make the
2076 informational messages preceding them meaningless.
2078 \membersection{::wxLogVerbose}\label{wxlogverbose}
2080 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
2082 For verbose output. Normally, it's suppressed, but
2083 might be activated if the user wishes to know more details about the program
2084 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
2086 \membersection{::wxLogStatus}\label{wxlogstatus}
2088 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
2090 For status messages - they will go into the status
2091 bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
2093 \membersection{::wxLogSysError}\label{wxlogsyserror}
2095 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
2097 Mostly used by wxWindows itself, but might be
2098 handy for logging errors after system call (API function) failure. It logs the
2099 specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
2100 on the platform) and the corresponding error
2101 message. The second form of this function takes the error code explitly as the
2104 \membersection{::wxLogDebug}\label{wxlogdebug}
2106 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
2108 The right function for debug output. It only
2109 does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
2110 and expands to nothing in release mode (otherwise).
2112 \membersection{::wxLogTrace}\label{wxlogtrace}
2114 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
2116 \func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
2118 As {\bf wxLogDebug}, only does something in debug
2119 build. The reason for making it a separate function from it is that usually
2120 there are a lot of trace messages, so it might make sense to separate them
2121 from other debug messages which would be flooded in them. Moreover, the second
2122 version of this function takes a trace mask as the first argument which allows
2123 to further restrict the amount of messages generated. The value of {\it mask} can be:
2125 \begin{itemize}\itemsep=0pt
2126 \item wxTraceMemAlloc: trace memory allocation (new/delete)
2127 \item wxTraceMessages: trace window messages/X callbacks
2128 \item wxTraceResAlloc: trace GDI resource allocation
2129 \item wxTraceRefCount: trace various ref counting operations
2132 \section{Debugging macros and functions}\label{debugmacros}
2134 Useful macros and functins for error checking and defensive programming. ASSERTs are only
2135 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
2138 \wxheading{Include files}
2142 \membersection{::wxOnAssert}\label{wxonassert}
2144 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
2146 This function may be redefined to do something non trivial and is called
2147 whenever one of debugging macros fails (i.e. condition is false in an
2149 % TODO: this should probably be an overridable in wxApp.
2151 \membersection{wxASSERT}\label{wxassert}
2153 \func{}{wxASSERT}{\param{}{condition}}
2155 Assert macro. An error message will be generated if the condition is FALSE in
2156 debug mode, but nothing will be done in the release build.
2158 Please note that the condition in wxASSERT() should have no side effects
2159 because it will not be executed in release mode at all.
2161 See also: \helpref{wxASSERT\_MSG}{wxassertmsg}
2163 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
2165 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
2167 Assert macro with message. An error message will be generated if the condition is FALSE.
2169 See also: \helpref{wxASSERT}{wxassert}
2171 \membersection{wxFAIL}\label{wxfail}
2173 \func{}{wxFAIL}{\void}
2175 Will always generate an assert error if this code is reached (in debug mode).
2177 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
2179 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
2181 \func{}{wxFAIL\_MSG}{\param{}{msg}}
2183 Will always generate an assert error with specified message if this code is reached (in debug mode).
2185 This macro is useful for marking unreachable" code areas, for example
2186 it may be used in the "default:" branch of a switch statement if all possible
2187 cases are processed above.
2189 See also: \helpref{wxFAIL}{wxfail}
2191 \membersection{wxCHECK}\label{wxcheck}
2193 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
2195 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2196 This check is done even in release mode.
2198 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
2200 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
2202 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
2203 This check is done even in release mode.
2205 This macro may be only used in non void functions, see also
2206 \helpref{wxCHECK\_RET}{wxcheckret}.
2208 \membersection{wxCHECK\_RET}\label{wxcheckret}
2210 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
2212 Checks that the condition is true, and returns if not (FAILs with given error
2213 message in debug mode). This check is done even in release mode.
2215 This macro should be used in void functions instead of
2216 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
2218 \membersection{wxCHECK2}\label{wxcheck2}
2220 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
2222 Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
2223 {\it operation} if it is not. This is a generalisation of
2224 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
2225 returning from the function must be done when the {\it condition} is false.
2227 This check is done even in release mode.
2229 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
2231 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
2233 This is the same as \helpref{wxCHECK2}{wxcheck2}, but
2234 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
2235 instead of wxFAIL() if the {\it condition} is false.