wxEvent::Skip() clarification added

[wxWidgets.git] / docs / latex / wx / function.tex

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index 6062e1acb79b9e95737e4f6f44007929908c59b1..1c17ad10741fa4758bbd420332f112cb7d75d360 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -6,7 +6,13 @@ The functions defined in wxWindows are described here.
 
 \section{File functions}\label{filefunctions}
 
 
 \section{File functions}\label{filefunctions}
 

-See also \helpref{wxPathList}{wxpathlist}.
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\wxheading{See also}
+
+\helpref{wxPathList}{wxpathlist}

 
 \membersection{::wxDirExists}
 
 
 \membersection{::wxDirExists}
 


@@ -31,29 +37,28 @@ Returns TRUE if the file exists.
 
 \func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}}
 
 
 \func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}}
 

-Returns a temporary pointer to the filename for a full path.
-Copy this pointer for long-term use.
+\func{char*}{wxFileNameFromPath}{\param{char* }{path}}
+
+Returns the filename for a full path. The second form returns a pointer to
+temporary storage that should not be deallocated.

 
 \membersection{::wxFindFirstFile}\label{wxfindfirstfile}
 
 
 \membersection{::wxFindFirstFile}\label{wxfindfirstfile}
 

-\func{wxString}{wxFindFirstFile}{\param{const wxString\& }{spec}, \param{int}{ flags = 0}}
+\func{wxString}{wxFindFirstFile}{\param{const char*}{spec}, \param{int}{ flags = 0}}

 
 This function does directory searching; returns the first file
 
 This function does directory searching; returns the first file

-that matches the path {\it spec}, or NULL. Use \helpref{wxFindNextFile}{wxfindnextfile} to
+that matches the path {\it spec}, or the empty string. Use \helpref{wxFindNextFile}{wxfindnextfile} to

 get the next matching file.
 
 {\it spec} may contain wildcards.
 
 {\it flags} is reserved for future use.
 
 get the next matching file.
 
 {\it spec} may contain wildcards.
 
 {\it flags} is reserved for future use.
 

-The returned filename is a pointer to static memory so should
-not be freed.
-

 For example:
 
 \begin{verbatim}
   wxString f = wxFindFirstFile("/home/project/*.*");
 For example:
 
 \begin{verbatim}
   wxString f = wxFindFirstFile("/home/project/*.*");

-  while (f)
+  while ( !f.IsEmpty() )

   {
     ...
     f = wxFindNextFile();
   {
     ...
     f = wxFindNextFile();


@@ -66,6 +71,12 @@ For example:
 
 Returns the next file that matches the path passed to \helpref{wxFindFirstFile}{wxfindfirstfile}.
 
 
 Returns the next file that matches the path passed to \helpref{wxFindFirstFile}{wxfindfirstfile}.
 

+\membersection{::wxGetOSDirectory}\label{wxgetosdirectory}
+
+\func{wxString}{wxGetOSDirectory}{\void}
+
+Returns the Windows directory under Windows; on other platforms returns the empty string.
+

 \membersection{::wxIsAbsolutePath}
 
 \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
 \membersection{::wxIsAbsolutePath}
 
 \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}


@@ -77,8 +88,7 @@ or drive name at the beginning.
 
 \func{wxString}{wxPathOnly}{\param{const wxString\& }{path}}
 
 
 \func{wxString}{wxPathOnly}{\param{const wxString\& }{path}}
 

-Returns a temporary pointer to the directory part of the filename. Copy this
-pointer for long-term use.
+Returns the directory part of the filename.

 
 \membersection{::wxUnix2DosFilename}
 
 
 \membersection{::wxUnix2DosFilename}
 


@@ -101,6 +111,12 @@ TRUE if successful.
 
 Copies {\it file1} to {\it file2}, returning TRUE if successful.
 
 
 Copies {\it file1} to {\it file2}, returning TRUE if successful.
 

+\membersection{::wxGetCwd}\label{wxgetcwd}
+
+\func{wxString}{wxGetCwd}{\void}
+
+Returns a string containing the current (or working) directory.
+

 \membersection{::wxGetHostName}\label{wxgethostname}
 
 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int }{sz}}
 \membersection{::wxGetHostName}\label{wxgethostname}
 
 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int }{sz}}


@@ -150,7 +166,9 @@ Returns TRUE if successful, FALSE otherwise.
 
 \membersection{::wxGetWorkingDirectory}
 
 
 \membersection{::wxGetWorkingDirectory}
 

-\func{wxString}{wxGetWorkingDirectory}{\param{const wxString\& }{buf=NULL}, \param{int }{sz=1000}}
+\func{wxString}{wxGetWorkingDirectory}{\param{char*}{buf=NULL}, \param{int }{sz=1000}}
+
+This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.

 
 Copies the current working directory into the buffer if supplied, or
 copies the working directory into new storage (which you must delete yourself)
 
 Copies the current working directory into the buffer if supplied, or
 copies the working directory into new storage (which you must delete yourself)


@@ -160,7 +178,7 @@ if the buffer is NULL.
 
 \membersection{::wxGetTempFileName}
 
 
 \membersection{::wxGetTempFileName}
 

-\func{wxString}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{const wxString\& }{buf=NULL}}
+\func{char*}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char* }{buf=NULL}}

 
 Makes a temporary filename based on {\it prefix}, opens and closes the file,
 and places the name in {\it buf}. If {\it buf} is NULL, new store
 
 Makes a temporary filename based on {\it prefix}, opens and closes the file,
 and places the name in {\it buf}. If {\it buf} is NULL, new store


@@ -219,6 +237,45 @@ The {\it flags} parameter is reserved for future use.
 Sets the current working directory, returning TRUE if the operation succeeded.
 Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification.
 
 Sets the current working directory, returning TRUE if the operation succeeded.
 Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification.
 

+\membersection{::wxSplitPath}\label{wxsplitfunction}
+
+\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{const wxString *}{ path}, \param{const wxString *}{ name}, \param{const wxString *}{ ext}}
+
+This function splits a full file name into components: the path (including possible disk/drive
+specification under Windows), the base name and the extension. Any of the output parameters
+({\it path}, {\it name} or {\it ext}) may be NULL if you are not interested in the value of
+a particular component.
+
+wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
+Windows, however it will not consider backslashes as path separators under Unix (where backslash
+is a valid character in a filename).
+
+On entry, {\it fullname} should be non NULL (it may be empty though).
+
+On return, {\it path} contains the file path (without the trailing separator), {\it name}
+contains the file name and {\it ext} contains the file extension without leading dot. All
+three of them may be empty if the corresponding component is. The old contents of the
+strings pointed to by these parameters will be overwritten in any case (if the pointers
+are not NULL).
+
+\membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
+
+\func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
+
+Copies the given file to {\it stream}. Useful when converting an old application to
+use streams (within the document/view framework, for example).
+
+Use of this function requires the file wx\_doc.h to be included.
+
+\membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
+
+\func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
+
+Copies the given stream to the file {\it filename}. Useful when converting an old application to
+use streams (within the document/view framework, for example).
+
+Use of this function requires the file wx\_doc.h to be included.
+

 \section{String functions}
 
 \membersection{::copystring}
 \section{String functions}
 
 \membersection{::copystring}


@@ -247,23 +304,42 @@ A macro defined as:
 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
 \end{verbatim}
 
 #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
 \end{verbatim}
 

-\membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
+\membersection{::IsEmpty}\label{isempty}

 
 

-\func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
+\func{bool}{IsEmpty}{\param{const char *}{ p}}

 
 

-Copies the given file to {\it stream}. Useful when converting an old application to
-use streams (within the document/view framework, for example).
+Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL
+pointer to this function and it will return TRUE for it.

 
 

-Use of this function requires the file wx\_doc.h to be included.
+\membersection{::Stricmp}\label{stricmp}

 
 

-\membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
+\func{int}{Stricmp}{\param{const char *}{p1}, \param{const char *}{p2}}

 
 

-\func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
+Returns a negative value, 0, or positive value if {\it p1} is less than, equal
+to or greater than {\it p2}. The comparison is case-insensitive.

 
 

-Copies the given stream to the file {\it filename}. Useful when converting an old application to
-use streams (within the document/view framework, for example).
+This function complements the standard C function {\it strcmp()} which performs
+case-sensitive comparison.

 
 

-Use of this function requires the file wx\_doc.h to be included.
+\membersection{::Strlen}\label{strlen}
+
+\func{size\_t}{Strlen}{\param{const char *}{ p}}
+
+This is a safe version of standard function {\it strlen()}: it does exactly the
+same thing (i.e. returns the length of the string) except that it returns 0 if
+{\it p} is the NULL pointer.
+
+\membersection{::wxGetTranslation}\label{wxgettranslation}
+
+\func{const char *}{wxGetTranslation}{\param{const char * }{str}}
+
+This function returns the translation of string {\it str} in the current 
+\helpref{locale}{wxlocale}. If the string is not found in any of the loaded
+message catalogs (see \helpref{i18n overview}{internationalization}), the
+original string is returned. In debug build, an error message is logged - this
+should help to find the strings which were not yet translated. As this function
+is used very often, an alternative syntax is provided: the \_() macro is
+defined as wxGetTranslation().

 
 \section{Dialog functions}\label{dialogfunctions}
 
 
 \section{Dialog functions}\label{dialogfunctions}
 


@@ -275,15 +351,15 @@ the front when the dialog box is popped up.
 
 \membersection{::wxFileSelector}\label{wxfileselector}
 
 
 \membersection{::wxFileSelector}\label{wxfileselector}
 

-\func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = NULL},\\
-  \param{const wxString\& }{default\_filename = NULL}, \param{const wxString\& }{default\_extension = NULL},\\
-  \param{const wxString\& }{wildcard = ``*.*''}, \param{int }{flags = 0}, \param{wxWindow *}{parent = NULL},\\
+\func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\
+  \param{const wxString\& }{default\_filename = ""}, \param{const wxString\& }{default\_extension = ""},\\
+  \param{const wxString\& }{wildcard = ``*.*''}, \param{int }{flags = 0}, \param{wxWindow *}{parent = ""},\\

   \param{int}{ x = -1}, \param{int}{ y = -1}}
 
 Pops up a file selector box. In Windows, this is the common file selector
 dialog. In X, this is a file selector box with somewhat less functionality.
 The path and filename are distinct elements of a full file pathname.
   \param{int}{ x = -1}, \param{int}{ y = -1}}
 
 Pops up a file selector box. In Windows, this is the common file selector
 dialog. In X, this is a file selector box with somewhat less functionality.
 The path and filename are distinct elements of a full file pathname.

-If path is NULL, the current directory will be used. If filename is NULL,
+If path is empty, the current directory will be used. If filename is empty,

 no default filename will be supplied. The wildcard determines what files
 are displayed in the file selector, and file extension supplies a type
 extension for the required filename. Flags may be a combination of wxOPEN,
 no default filename will be supplied. The wildcard determines what files
 are displayed in the file selector, and file extension supplies a type
 extension for the required filename. Flags may be a combination of wxOPEN,


@@ -304,19 +380,20 @@ types of file with a description for each, such as:
  "BMP files (*.bmp) | *.bmp | GIF files (*.gif) | *.gif"
 \end{verbatim}
 
  "BMP files (*.bmp) | *.bmp | GIF files (*.gif) | *.gif"
 \end{verbatim}
 

-The application must check for a NULL return value (the user pressed
+The application must check for an empty return value (the user pressed

 Cancel). For example:
 
 \begin{verbatim}
 Cancel). For example:
 
 \begin{verbatim}

-const wxString\& s = wxFileSelector("Choose a file to open");
+const wxString& s = wxFileSelector("Choose a file to open");

 if (s)
 {
   ...
 }
 \end{verbatim}
 
 if (s)
 {
   ...
 }
 \end{verbatim}
 

-Remember that the returned pointer is temporary and should be copied
-if other wxWindows calls will be made before the value is to be used.
+\wxheading{Include files}
+
+<wx/filedlg.h>

 
 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
 
 
 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
 


@@ -326,11 +403,15 @@ if other wxWindows calls will be made before the value is to be used.
 
 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
 \rtfsp{\it default\_value}.  The user may type in text and press OK to return this text,
 
 Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
 \rtfsp{\it default\_value}.  The user may type in text and press OK to return this text,

-or press Cancel to return NULL.
+or press Cancel to return the empty string.

 
 If {\it centre} is TRUE, the message text (which may include new line characters)
 is centred; if FALSE, the message is left-justified.
 
 
 If {\it centre} is TRUE, the message text (which may include new line characters)
 is centred; if FALSE, the message is left-justified.
 

+\wxheading{Include files}
+
+<wx/textdlg.h>
+

 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
 
 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
 \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
 
 \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\


@@ -353,6 +434,10 @@ If Cancel is pressed, -1 is returned.
 If {\it centre} is TRUE, the message text (which may include new line characters)
 is centred; if FALSE, the message is left-justified.
 
 If {\it centre} is TRUE, the message text (which may include new line characters)
 is centred; if FALSE, the message is left-justified.
 

+\wxheading{Include files}
+
+<wx/choicdlg.h>
+

 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
 
 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
 
 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\


@@ -361,13 +446,17 @@ is centred; if FALSE, the message is left-justified.
 
 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
 listbox. The user may choose an item and press OK to return a string or
 
 Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
 listbox. The user may choose an item and press OK to return a string or

-Cancel to return NULL.
+Cancel to return the empty string.

 
 {\it choices} is an array of {\it n} strings for the listbox.
 
 If {\it centre} is TRUE, the message text (which may include new line characters)
 is centred; if FALSE, the message is left-justified.
 
 
 {\it choices} is an array of {\it n} strings for the listbox.
 
 If {\it centre} is TRUE, the message text (which may include new line characters)
 is centred; if FALSE, the message is left-justified.
 

+\wxheading{Include files}
+
+<wx/choicdlg.h>
+

 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
 
 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
 
 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\


@@ -377,6 +466,10 @@ is centred; if FALSE, the message is left-justified.
 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
 If the user pressed cancel, -1 is returned.
 
 As {\bf wxGetSingleChoice} but returns the index representing the selected string.
 If the user pressed cancel, -1 is returned.
 

+\wxheading{Include files}
+
+<wx/choicdlg.h>
+

 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
 
 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
 
 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\


@@ -386,6 +479,10 @@ If the user pressed cancel, -1 is returned.
 As {\bf wxGetSingleChoice} but takes an array of client data pointers
 corresponding to the strings, and returns one of these pointers.
 
 As {\bf wxGetSingleChoice} but takes an array of client data pointers
 corresponding to the strings, and returns one of these pointers.
 

+\wxheading{Include files}
+
+<wx/choicdlg.h>
+

 \membersection{::wxMessageBox}\label{wxmessagebox}
 
 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
 \membersection{::wxMessageBox}\label{wxmessagebox}
 
 \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\


@@ -428,10 +525,18 @@ is specified in the style, in which case a generic function is used.
 This is because the native MessageBox function cannot centre text.
 The symbols are not shown when the generic function is used.
 
 This is because the native MessageBox function cannot centre text.
 The symbols are not shown when the generic function is used.
 

+\wxheading{Include files}
+
+<wx/msgdlg.h>
+

 \section{GDI functions}\label{gdifunctions}
 
 The following are relevant to the GDI (Graphics Device Interface).
 
 \section{GDI functions}\label{gdifunctions}
 
 The following are relevant to the GDI (Graphics Device Interface).
 

+\wxheading{Include files}
+
+<wx/gdicmn.h>
+

 \membersection{::wxColourDisplay}
 
 \func{bool}{wxColourDisplay}{\void}
 \membersection{::wxColourDisplay}
 
 \func{bool}{wxColourDisplay}{\void}


@@ -463,7 +568,7 @@ the equivalent of the following code to the start of the metafile data:
  SetWindowExt(dc, maxX - minX, maxY - minY);
 \end{verbatim}
 
  SetWindowExt(dc, maxX - minX, maxY - minY);
 \end{verbatim}
 

-This simulates the MM\_TEXT mapping mode, which wxWindows assumes.
+This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.

 
 Placeable metafiles may be imported by many Windows applications, and can be
 used in RTF (Rich Text Format) files.
 
 Placeable metafiles may be imported by many Windows applications, and can be
 used in RTF (Rich Text Format) files.


@@ -484,6 +589,10 @@ See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowset
 The following functions are used to control PostScript printing. Under
 Windows, PostScript output can only be sent to a file.
 
 The following functions are used to control PostScript printing. Under
 Windows, PostScript output can only be sent to a file.
 

+\wxheading{Include files}
+
+<wx/dcps.h>
+

 \membersection{::wxGetPrinterCommand}
 
 \func{wxString}{wxGetPrinterCommand}{\void}
 \membersection{::wxGetPrinterCommand}
 
 \func{wxString}{wxGetPrinterCommand}{\void}


@@ -586,6 +695,10 @@ Sets the translation (from the top left corner) for PostScript output. The defau
 
 These clipboard functions are implemented for Windows only.
 
 
 These clipboard functions are implemented for Windows only.
 

+\wxheading{Include files}
+
+<wx/clipbrd.h>
+

 \membersection{::wxClipboardOpen}
 
 \func{bool}{wxClipboardOpen}{\void}
 \membersection{::wxClipboardOpen}
 
 \func{bool}{wxClipboardOpen}{\void}


@@ -683,19 +796,27 @@ The clipboard must have previously been opened for this call to succeed.
 
 \section{Miscellaneous functions}\label{miscellany}
 
 
 \section{Miscellaneous functions}\label{miscellany}
 

-\membersection{::NewId}
+\membersection{::wxNewId}

 
 

-\func{long}{NewId}{\void}
+\func{long}{wxNewId}{\void}

 
 Generates an integer identifier unique to this run of the program.
 
 
 Generates an integer identifier unique to this run of the program.
 

-\membersection{::RegisterId}
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxRegisterId}

 
 

-\func{void}{RegisterId}{\param{long}{ id}}
+\func{void}{wxRegisterId}{\param{long}{ id}}

 
 Ensures that ids subsequently generated by {\bf NewId} do not clash with
 the given {\bf id}.
 
 
 Ensures that ids subsequently generated by {\bf NewId} do not clash with
 the given {\bf id}.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
 
 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
 \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
 
 \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}


@@ -707,20 +828,19 @@ ensures that only the outer calls take effect.
 
 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
 
 
 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxBell}
 
 \func{void}{wxBell}{\void}
 
 Ring the system bell.
 
 \membersection{::wxBell}
 
 \func{void}{wxBell}{\void}
 
 Ring the system bell.
 

-\membersection{::wxCleanUp}\label{wxcleanup}
-
-\func{void}{wxCleanUp}{\void}
+\wxheading{Include files}

 
 

-Normally, wxWindows will call this cleanup function for you. However, if
-you call \helpref{wxEntry}{wxentry} in order to initialize wxWindows
-manually, then you should also call wxCleanUp before terminating wxWindows,
-if wxWindows does not get a chance to do it.
+<wx/utils.h>

 
 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
 
 
 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
 


@@ -738,6 +858,10 @@ called by the application.
 
 See also helpref{wxDDEInitialize}{wxddeinitialize}.
 
 
 See also helpref{wxDDEInitialize}{wxddeinitialize}.
 

+\wxheading{Include files}
+
+<wx/dde.h>
+

 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
 
 \func{void}{wxDDEInitialize}{\void}
 \membersection{::wxDDEInitialize}\label{wxddeinitialize}
 
 \func{void}{wxDDEInitialize}{\void}


@@ -750,6 +874,10 @@ by wxWindows if necessary.
 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection}, 
 \helpref{wxDDECleanUp}{wxddecleanup}.
 
 See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection}, 
 \helpref{wxDDECleanUp}{wxddecleanup}.
 

+\wxheading{Include files}
+
+<wx/dde.h>
+

 \membersection{::wxDebugMsg}\label{wxdebugmsg}
 
 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
 \membersection{::wxDebugMsg}\label{wxdebugmsg}
 
 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}


@@ -773,18 +901,26 @@ instead.
 
 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
 
 
 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxDisplaySize}
 
 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
 
 Gets the physical size of the display in pixels.
 
 \membersection{::wxDisplaySize}
 
 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
 
 Gets the physical size of the display in pixels.
 

+\wxheading{Include files}
+
+<wx/gdicmn.h>
+

 \membersection{::wxEntry}\label{wxentry}
 
 This initializes wxWindows in a platform-dependent way. Use this if you
 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
 you can initialize wxWindows from an Microsoft Foundation Classes application using
 \membersection{::wxEntry}\label{wxentry}
 
 This initializes wxWindows in a platform-dependent way. Use this if you
 are not using the default wxWindows entry code (e.g. main or WinMain). For example,
 you can initialize wxWindows from an Microsoft Foundation Classes application using

-this function. See also \helpref{wxCleanUp}{wxcleanup}.
+this function.

 
 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
  \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
 
 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
  \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}


@@ -802,6 +938,26 @@ wxWindows initialization under Windows (for applications constructed as a DLL).
 
 wxWindows initialization under Unix.
 
 
 wxWindows initialization under Unix.
 

+\wxheading{Remarks}
+
+To clean up wxWindows, call wxApp::OnExit followed by the static function
+wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
+
+\begin{verbatim}
+int CTheApp::ExitInstance()
+{
+  // OnExit isn't called by CleanUp so must be called explicitly.
+  wxTheApp->OnExit();
+  wxApp::CleanUp();
+
+  return CWinApp::ExitInstance();
+}
+\end{verbatim}
+
+\wxheading{Include files}
+
+<wx/app.h>
+

 \membersection{::wxError}\label{wxerror}
 
 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
 \membersection{::wxError}\label{wxerror}
 
 \func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}


@@ -810,6 +966,10 @@ Displays {\it msg} and continues. This writes to standard error under
 Unix, and pops up a message box under Windows. Used for internal
 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
 
 Unix, and pops up a message box under Windows. Used for internal
 wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
 
 \func{void}{wxEndBusyCursor}{\void}
 \membersection{::wxEndBusyCursor}\label{wxendbusycursor}
 
 \func{void}{wxEndBusyCursor}{\void}


@@ -819,6 +979,10 @@ Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
 
 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
 
 
 See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxExecute}\label{wxexecute}
 
 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
 \membersection{::wxExecute}\label{wxexecute}
 
 \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}


@@ -835,16 +999,25 @@ arguments, terminated by NULL.
 If {\it sync} is FALSE (the default), flow of control immediately returns.
 If TRUE, the current application waits until the other program has terminated.
 
 If {\it sync} is FALSE (the default), flow of control immediately returns.
 If TRUE, the current application waits until the other program has terminated.
 

-If execution is asynchronous, the return value is the process id,
-otherwise it is a status value.  A zero value indicates that the command could not
-be executed.
+In the case of synchronous execution, the return value is trhe exit code of
+the process (which terminates by the moment the function returns) and will be
+$-1$ if the process couldn't be started and typically 0 if the process
+terminated successfully.
+
+For asynchronous execution, however, the return value is the process id and
+zero value indicates that the command could not be executed.

 
 

-If callback isn't NULL and if execution is asynchronous, 
+If callback isn't NULL and if execution is asynchronous (note that callback
+parameter can not be non NULL for synchronous execution), 

 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
 the process finishes.
 
 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
 
 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
 the process finishes.
 
 See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxExit}\label{wxexit}
 
 \func{void}{wxExit}{\void}
 \membersection{::wxExit}\label{wxexit}
 
 \func{void}{wxExit}{\void}


@@ -854,6 +1027,10 @@ Should only be used in an emergency: normally the top-level frame
 should be deleted (after deleting all other frames) to terminate the
 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
 
 should be deleted (after deleting all other frames) to terminate the
 application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
 

+\wxheading{Include files}
+
+<wx/app.h>
+

 \membersection{::wxFatalError}\label{wxfatalerror}
 
 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
 \membersection{::wxFatalError}\label{wxfatalerror}
 
 \func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}


@@ -862,12 +1039,20 @@ Displays {\it msg} and exits. This writes to standard error under Unix,
 and pops up a message box under Windows. Used for fatal internal
 wxWindows errors. See also \helpref{wxError}{wxerror}.
 
 and pops up a message box under Windows. Used for fatal internal
 wxWindows errors. See also \helpref{wxError}{wxerror}.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxFindMenuItemId}
 
 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
 
 Find a menu item identifier associated with the given frame's menu bar.
 
 \membersection{::wxFindMenuItemId}
 
 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
 
 Find a menu item identifier associated with the given frame's menu bar.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxFindWindowByLabel}
 
 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
 \membersection{::wxFindWindowByLabel}
 
 \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}


@@ -877,6 +1062,10 @@ or panel item label. If {\it parent} is NULL, the search will start from all top
 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
 The search is recursive in both cases.
 
 frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
 The search is recursive in both cases.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
 
 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
 \membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
 
 \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}


@@ -888,24 +1077,40 @@ The search is recursive in both cases.
 
 If no such named window is found, {\bf wxFindWindowByLabel} is called.
 
 
 If no such named window is found, {\bf wxFindWindowByLabel} is called.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
 
 \func{wxWindow *}{wxGetActiveWindow}{\void}
 
 Gets the currently active window (Windows only).
 
 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
 
 \func{wxWindow *}{wxGetActiveWindow}{\void}
 
 Gets the currently active window (Windows only).
 

+\wxheading{Include files}
+
+<wx/windows.h>
+

 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
 
 \func{wxString}{wxGetDisplayName}{\void}
 
 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
 
 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
 
 \func{wxString}{wxGetDisplayName}{\void}
 
 Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxGetHomeDir}
 
 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
 
 Fills the buffer with a string representing the user's home directory (Unix only).
 
 \membersection{::wxGetHomeDir}
 
 \func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
 
 Fills the buffer with a string representing the user's home directory (Unix only).
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxGetHostName}
 
 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
 \membersection{::wxGetHostName}
 
 \func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}


@@ -915,6 +1120,10 @@ buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
 successful. Under Unix, this will return a machine name. Under Windows,
 this returns ``windows''.
 
 successful. Under Unix, this will return a machine name. Under Windows,
 this returns ``windows''.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
 
 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
 
 \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}


@@ -926,6 +1135,10 @@ by this call.
 
 See also \helpref{wxTimer}{wxtimer}.
 
 
 See also \helpref{wxTimer}{wxtimer}.
 

+\wxheading{Include files}
+
+<wx/timer.h>
+

 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
 
 \func{long}{wxGetFreeMemory}{\void}
 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
 
 \func{long}{wxGetFreeMemory}{\void}


@@ -934,12 +1147,20 @@ Returns the amount of free memory in Kbytes under environments which
 support it, and -1 if not supported. Currently, returns a positive value
 under Windows, and -1 under Unix.
 
 support it, and -1 if not supported. Currently, returns a positive value
 under Windows, and -1 under Unix.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxGetMousePosition}
 
 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
 
 Returns the mouse position in screen coordinates.
 
 \membersection{::wxGetMousePosition}
 
 \func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
 
 Returns the mouse position in screen coordinates.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxGetOsVersion}
 
 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
 \membersection{::wxGetOsVersion}
 
 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}


@@ -959,6 +1180,10 @@ Gets operating system version information.
 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
 \end{twocollist}
 
 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
 \end{twocollist}
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxGetResource}\label{wxgetresource}
 
 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
 \membersection{::wxGetResource}\label{wxgetresource}
 
 \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},


@@ -989,6 +1214,10 @@ the overloading of the function for different types.
 
 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
 
 
 See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxGetUserId}
 
 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
 \membersection{::wxGetUserId}
 
 \func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}


@@ -997,6 +1226,10 @@ Copies the user's login identity (such as ``jacs'') into the buffer {\it
 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
 Under Windows, this returns ``user''.
 
 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
 Under Windows, this returns ``user''.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxGetUserName}
 
 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
 \membersection{::wxGetUserName}
 
 \func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}


@@ -1005,6 +1238,10 @@ Copies the user's name (such as ``Julian Smart'') into the buffer {\it
 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
 Under Windows, this returns ``unknown''.
 
 buf}, of maximum size {\it bufSize}, returning TRUE if successful.
 Under Windows, this returns ``unknown''.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxKill}\label{wxkill}
 
 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
 \membersection{::wxKill}\label{wxkill}
 
 \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}


@@ -1015,12 +1252,9 @@ Returns 0 on success, -1 on failure.
 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
 It does not raise a signal in the receiving process.
 
 Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
 It does not raise a signal in the receiving process.
 

-\membersection{::wxInitClipboard}\label{wxinitclipboard}
-
-\func{void}{wxInitClipboard}{\void}
+\wxheading{Include files}

 
 

-Initializes the generic clipboard system by creating an instance of
-the class \helpref{wxClipboard}{wxclipboard}.
+<wx/utils.h>

 
 \membersection{::wxIsBusy}\label{wxisbusy}
 
 
 \membersection{::wxIsBusy}\label{wxisbusy}
 


@@ -1031,6 +1265,10 @@ Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\r
 
 See also \helpref{wxBusyCursor}{wxbusycursor}.
 
 
 See also \helpref{wxBusyCursor}{wxbusycursor}.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
 
 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
 
 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}


@@ -1052,23 +1290,35 @@ using \helpref{wxResourceParseString}{wxresourceparsestring}.
 
 This function is available under Windows only.
 
 
 This function is available under Windows only.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxNow}\label{wxnow}
 
 \func{wxString}{wxNow}{\void}
 
 Returns a string representing the current date and time.
 
 \membersection{::wxNow}\label{wxnow}
 
 \func{wxString}{wxNow}{\void}
 
 Returns a string representing the current date and time.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxPostDelete}\label{wxpostdelete}
 
 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
 
 \membersection{::wxPostDelete}\label{wxpostdelete}
 
 \func{void}{wxPostDelete}{\param{wxObject *}{object}}
 

-Under X, tells the system to delete the specified object when
+Tells the system to delete the specified object when

 all other events have been processed. In some environments, it is
 necessary to use this instead of deleting a frame directly with the
 all other events have been processed. In some environments, it is
 necessary to use this instead of deleting a frame directly with the

-delete operator, because X will still send events to the window.
+delete operator, because some GUIs will still send events to a deleted window.

 
 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
 
 
 Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
 
 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
 \membersection{::wxSetDisplayName}\label{wxsetdisplayname}
 
 \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}


@@ -1080,6 +1330,10 @@ displays to be used.
 
 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
 
 
 See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxShell}\label{wxshell}
 
 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
 \membersection{::wxShell}\label{wxshell}
 
 \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}


@@ -1089,12 +1343,20 @@ specified, then just the shell is spawned.
 
 See also \helpref{wxExecute}{wxexecute}.
 
 
 See also \helpref{wxExecute}{wxexecute}.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxSleep}\label{wxsleep}
 
 \func{void}{wxSleep}{\param{int}{ secs}}
 
 Sleeps for the specified number of seconds.
 
 \membersection{::wxSleep}\label{wxsleep}
 
 \func{void}{wxSleep}{\param{int}{ secs}}
 
 Sleeps for the specified number of seconds.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxStripMenuCodes}
 
 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
 \membersection{::wxStripMenuCodes}
 
 \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}


@@ -1107,6 +1369,10 @@ in {\it out} (or returns the new string, in the first form).
 Menu codes include \& (mark the next character with an underline
 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
 
 Menu codes include \& (mark the next character with an underline
 as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxStartTimer}\label{wxstarttimer}
 
 \func{void}{wxStartTimer}{\void}
 \membersection{::wxStartTimer}\label{wxstarttimer}
 
 \func{void}{wxStartTimer}{\void}


@@ -1115,18 +1381,30 @@ Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get th
 
 See also \helpref{wxTimer}{wxtimer}.
 
 
 See also \helpref{wxTimer}{wxtimer}.
 

+\wxheading{Include files}
+
+<wx/timer.h>
+

 \membersection{::wxToLower}\label{wxtolower}
 
 \func{char}{wxToLower}{\param{char }{ch}}
 
 Converts the character to lower case. This is implemented as a macro for efficiency.
 
 \membersection{::wxToLower}\label{wxtolower}
 
 \func{char}{wxToLower}{\param{char }{ch}}
 
 Converts the character to lower case. This is implemented as a macro for efficiency.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxToUpper}\label{wxtoupper}
 
 \func{char}{wxToUpper}{\param{char }{ch}}
 
 Converts the character to upper case. This is implemented as a macro for efficiency.
 
 \membersection{::wxToUpper}\label{wxtoupper}
 
 \func{char}{wxToUpper}{\param{char }{ch}}
 
 Converts the character to upper case. This is implemented as a macro for efficiency.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxTrace}\label{wxtrace}
 
 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
 \membersection{::wxTrace}\label{wxtrace}
 
 \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}


@@ -1136,6 +1414,10 @@ is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugco
 
 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
 
 
 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
 

+\wxheading{Include files}
+
+<wx/memory.h>
+

 \membersection{::wxTraceLevel}\label{wxtracelevel}
 
 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
 \membersection{::wxTraceLevel}\label{wxtracelevel}
 
 \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}


@@ -1148,6 +1430,22 @@ this value.
 
 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
 
 
 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
 

+\wxheading{Include files}
+
+<wx/memory.h>
+
+\membersection{::wxUsleep}\label{wxusleep}
+
+\func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
+
+Sleeps for the specified number of milliseconds. Notice that usage of this
+function is encouraged instead of calling usleep(3) directly because the
+standard usleep() function is not MT safe.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxWriteResource}\label{wxwriteresource}
 
 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
 \membersection{::wxWriteResource}\label{wxwriteresource}
 
 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},


@@ -1175,7 +1473,11 @@ file under Unix, although the WIN.INI file is fair game under Windows.
 
 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
 
 
 See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
 

-\membersection{::wxYield}
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxYield}\label{wxyield}

 
 \func{bool}{wxYield}{\void}
 
 
 \func{bool}{wxYield}{\void}
 


@@ -1189,6 +1491,10 @@ user to perform actions which are not compatible with the current task.
 Disabling menu items or whole menus during processing can avoid unwanted
 reentrance of code.
 
 Disabling menu items or whole menus during processing can avoid unwanted
 reentrance of code.
 

+\wxheading{Include files}
+
+<wx/utils.h>
+

 \section{Macros}\label{macros}
 
 These macros are defined in wxWindows.
 \section{Macros}\label{macros}
 
 These macros are defined in wxWindows.


@@ -1199,6 +1505,10 @@ These macros are defined in wxWindows.
 
 Returns a pointer to the wxClassInfo object associated with this class.
 
 
 Returns a pointer to the wxClassInfo object associated with this class.
 

+\wxheading{Include files}
+
+<wx/object.h>
+

 \membersection{WXDEBUG\_NEW}\label{debugnew}
 
 \func{}{WXDEBUG\_NEW}{arg}
 \membersection{WXDEBUG\_NEW}\label{debugnew}
 
 \func{}{WXDEBUG\_NEW}{arg}


@@ -1212,6 +1522,10 @@ with filename and line number arguments. The definition is:
 
 In non-debug mode, this is defined as the normal new operator.
 
 
 In non-debug mode, this is defined as the normal new operator.
 

+\wxheading{Include files}
+
+<wx/object.h>
+

 \membersection{DECLARE\_ABSTRACT\_CLASS}
 
 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}
 \membersection{DECLARE\_ABSTRACT\_CLASS}
 
 \func{}{DECLARE\_ABSTRACT\_CLASS}{className}


@@ -1234,6 +1548,10 @@ class wxCommand: public wxObject
 };
 \end{verbatim}
 
 };
 \end{verbatim}
 

+\wxheading{Include files}
+
+<wx/object.h>
+

 \membersection{DECLARE\_APP}\label{declareapp}
 
 \func{}{DECLARE\_APP}{className}
 \membersection{DECLARE\_APP}\label{declareapp}
 
 \func{}{DECLARE\_APP}{className}


@@ -1247,6 +1565,10 @@ Example:
   DECLARE_APP(MyApp)
 \end{verbatim}
 
   DECLARE_APP(MyApp)
 \end{verbatim}
 

+\wxheading{Include files}
+
+<wx/app.h>
+

 \membersection{DECLARE\_CLASS}
 
 \func{}{DECLARE\_CLASS}{className}
 \membersection{DECLARE\_CLASS}
 
 \func{}{DECLARE\_CLASS}{className}


@@ -1255,6 +1577,10 @@ Used inside a class declaration to declare that the class should be
 made known to the class hierarchy, but objects of this class cannot be created
 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
 
 made known to the class hierarchy, but objects of this class cannot be created
 dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
 

+\wxheading{Include files}
+
+<wx/object.h>
+

 \membersection{DECLARE\_DYNAMIC\_CLASS}
 
 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
 \membersection{DECLARE\_DYNAMIC\_CLASS}
 
 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}


@@ -1276,6 +1602,10 @@ class wxFrame: public wxWindow
 };
 \end{verbatim}
 
 };
 \end{verbatim}
 

+\wxheading{Include files}
+
+<wx/object.h>
+

 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
 
 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
 \membersection{IMPLEMENT\_ABSTRACT\_CLASS}
 
 \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}


@@ -1294,6 +1624,10 @@ wxCommand::wxCommand(void)
 }
 \end{verbatim}
 
 }
 \end{verbatim}
 

+\wxheading{Include files}
+
+<wx/object.h>
+

 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
 
 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
 \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
 
 \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}


@@ -1301,6 +1635,10 @@ wxCommand::wxCommand(void)
 Used in a C++ implementation file to complete the declaration of
 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
 
 Used in a C++ implementation file to complete the declaration of
 a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
 

+\wxheading{Include files}
+
+<wx/object.h>
+

 \membersection{IMPLEMENT\_APP}\label{implementapp}
 
 \func{}{IMPLEMENT\_APP}{className}
 \membersection{IMPLEMENT\_APP}\label{implementapp}
 
 \func{}{IMPLEMENT\_APP}{className}


@@ -1322,6 +1660,10 @@ New form:
 
 See also \helpref{DECLARE\_APP}{declareapp}.
 
 
 See also \helpref{DECLARE\_APP}{declareapp}.
 

+\wxheading{Include files}
+
+<wx/app.h>
+

 \membersection{IMPLEMENT\_CLASS}
 
 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}
 \membersection{IMPLEMENT\_CLASS}
 
 \func{}{IMPLEMENT\_CLASS}{className, baseClassName}


@@ -1329,6 +1671,10 @@ See also \helpref{DECLARE\_APP}{declareapp}.
 Used in a C++ implementation file to complete the declaration of
 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
 
 Used in a C++ implementation file to complete the declaration of
 a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
 

+\wxheading{Include files}
+
+<wx/object.h>
+

 \membersection{IMPLEMENT\_CLASS2}
 
 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
 \membersection{IMPLEMENT\_CLASS2}
 
 \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}


@@ -1337,6 +1683,10 @@ Used in a C++ implementation file to complete the declaration of a
 class that has run-time type information and two base classes. The
 same as IMPLEMENT\_ABSTRACT\_CLASS2.
 
 class that has run-time type information and two base classes. The
 same as IMPLEMENT\_ABSTRACT\_CLASS2.
 

+\wxheading{Include files}
+
+<wx/object.h>
+

 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
 
 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
 \membersection{IMPLEMENT\_DYNAMIC\_CLASS}
 
 \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}


@@ -1356,6 +1706,10 @@ wxFrame::wxFrame(void)
 }
 \end{verbatim}
 
 }
 \end{verbatim}
 

+\wxheading{Include files}
+
+<wx/object.h>
+

 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
 
 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
 \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
 
 \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}


@@ -1365,6 +1719,10 @@ a class that has run-time type information, and whose instances
 can be created dynamically. Use this for classes derived from two
 base classes.
 
 can be created dynamically. Use this for classes derived from two
 base classes.
 

+\wxheading{Include files}
+
+<wx/object.h>
+

 \membersection{WXTRACE}\label{trace}
 
 \func{}{WXTRACE}{formatString, ...}
 \membersection{WXTRACE}\label{trace}
 
 \func{}{WXTRACE}{formatString, ...}


@@ -1374,6 +1732,10 @@ is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugco
 
 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
 
 
 This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
 

+\wxheading{Include files}
+
+<wx/memory.h>
+

 \membersection{WXTRACELEVEL}\label{tracelevel}
 
 \func{}{WXTRACELEVEL}{level, formatString, ...}
 \membersection{WXTRACELEVEL}\label{tracelevel}
 
 \func{}{WXTRACELEVEL}{level, formatString, ...}


@@ -1386,6 +1748,10 @@ this value.
 
 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
 
 
 This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
 

+\wxheading{Include files}
+
+<wx/memory.h>
+

 \section{wxWindows resource functions}\label{resourcefuncs}
 
 \overview{wxWindows resource system}{resourceformats}
 \section{wxWindows resource functions}\label{resourcefuncs}
 
 \overview{wxWindows resource system}{resourceformats}


@@ -1402,6 +1768,8 @@ as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminol
 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
 loading from resource data.
 
 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
 loading from resource data.
 

+{\bf Warning:} this needs updating for wxWindows 2.
+

 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
 
 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
 \membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
 
 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}


@@ -1586,6 +1954,10 @@ Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
 further information.
 
 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
 further information.
 

+\wxheading{Include files}
+
+<wx/log.h>
+

 \membersection{::wxLogError}\label{wxlogerror}
 
 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
 \membersection{::wxLogError}\label{wxlogerror}
 
 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}


@@ -1679,13 +2051,18 @@ Useful macros and functins for error checking and defensive programming. ASSERTs
 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
 builds.
 
 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
 builds.
 

+\wxheading{Include files}
+
+<wx/debug.h>
+

 \membersection{::wxOnAssert}\label{wxonassert}
 
 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
 
 This function may be redefined to do something non trivial and is called
 whenever one of debugging macros fails (i.e. condition is false in an
 \membersection{::wxOnAssert}\label{wxonassert}
 
 \func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
 
 This function may be redefined to do something non trivial and is called
 whenever one of debugging macros fails (i.e. condition is false in an

-assertion). TODO: this should probably be an overridable in wxApp.
+assertion).
+% TODO: this should probably be an overridable in wxApp.

 
 \membersection{wxASSERT}\label{wxassert}
 
 
 \membersection{wxASSERT}\label{wxassert}