A few spelling typos fixed

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

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index 783bf35bdaa114c3cc0c13b613ba33c6bf496808..fae00d9f2d2318a9c8dd5417cfdbe64eb43b1566 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -2,7 +2,103 @@
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}
 
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}
 

-The functions defined in wxWindows are described here.
+The functions and macros defined in wxWindows are described here.
+
+\section{Version macros}\label{versionfunctions}
+
+The following constants are defined in wxWindows:
+
+\begin{itemize}\itemsep=0pt
+\item {\tt wxMAJOR\_VERSION} is the major version of wxWindows
+\item {\tt wxMINOR\_VERSION} is the minor version of wxWindows
+\item {\tt wxRELASE\_NUMBER} is the release number
+\end{itemize}
+
+For example, the values or these constants for wxWindows 2.1.15 are 2, 1 and
+15.
+
+Additionally, {\tt wxVERSION\_STRING} is a user-readable string containing
+the full wxWindows version and {\tt wxVERSION\_NUMBER} is a combination of the
+three version numbers above: for 2.1.15, it is 2115 and it is 2200 for
+wxWindows 2.2.
+
+\wxheading{Include files}
+
+<wx/version.h> or <wx/defs.h>
+
+\membersection{wxCHECK\_VERSION}\label{wxcheckversion}
+
+\func{bool}{wxCHECK\_VERSION}{\param{}{major, minor, release}}
+
+This is a macro which evaluates to true if the current wxWindows version is at
+least major.minor.release.
+
+For example, to test if the program is compiled with wxWindows 2.2 or higher,
+the following can be done:
+
+\begin{verbatim}
+    wxString s;
+#if wxCHECK_VERSION(2, 2, 0)
+    if ( s.StartsWith("foo") )
+#else // replacement code for old version
+    if ( strncmp(s, "foo", 3) == 0 )
+#endif
+    {
+        ...
+    }
+\end{verbatim}
+
+\section{Thread functions}\label{threadfunctions}
+
+\wxheading{Include files}
+
+<wx/thread.h>
+
+\wxheading{See also}
+
+\helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}, \helpref{Multithreading overview}{wxthreadoverview}
+
+\membersection{::wxMutexGuiEnter}\label{wxmutexguienter}
+
+\func{void}{wxMutexGuiEnter}{\void}
+
+This function must be called when any thread other than the main GUI thread
+wants to get access to the GUI library. This function will block the execution
+of the calling thread until the main thread (or any other thread holding the
+main GUI lock) leaves the GUI library and no other thread will enter the GUI
+library until the calling thread calls \helpref{::wxMutexGuiLeave()}{wxmutexguileave}.
+
+Typically, these functions are used like this:
+
+\begin{verbatim}
+void MyThread::Foo(void)
+{
+    // before doing any GUI calls we must ensure that this thread is the only
+    // one doing it!
+
+    wxMutexGuiEnter();
+
+    // Call GUI here:
+    my_window->DrawSomething();
+
+    wxMutexGuiLeave();
+}
+\end{verbatim}
+
+Note that under GTK, no creation of top-level windows is allowed in any
+thread but the main one.
+
+This function is only defined on platforms which support preemptive
+threads.
+
+\membersection{::wxMutexGuiLeave}\label{wxmutexguileave}
+
+\func{void}{wxMutexGuiLeave}{\void}
+
+See \helpref{::wxMutexGuiEnter()}{wxmutexguienter}.
+
+This function is only defined on platforms which support preemptive
+threads.

 
 \section{File functions}\label{filefunctions}
 
 
 \section{File functions}\label{filefunctions}
 


@@ -12,7 +108,7 @@ The functions defined in wxWindows are described here.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxPathList}{wxpathlist}
+\helpref{wxPathList}{wxpathlist}, \helpref{wxDir}{wxdir}, \helpref{wxFile}{wxfile}

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


@@ -34,6 +130,12 @@ slashes.
 Returns TRUE if the file exists. It also returns TRUE if the file is
 a directory.
 
 Returns TRUE if the file exists. It also returns TRUE if the file is
 a directory.
 

+\membersection{::wxFileModificationTime}\label{wxfilemodificationtime}
+
+\func{time\_t}{wxFileModificationTime}{\param{const wxString\& }{filename}}
+
+Returns time of last modification of given file.
+

 \membersection{::wxFileNameFromPath}
 
 \func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}}
 \membersection{::wxFileNameFromPath}
 
 \func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}}


@@ -81,17 +183,6 @@ See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example.
 
 Returns the Windows directory under Windows; on other platforms returns the empty string.
 
 
 Returns the Windows directory under Windows; on other platforms returns the empty string.
 

-\membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
-
-\func{void}{wxInitAllImageHandlers}{\void}
-
-Adds some common image format handlers, which, depending on wxWindows
-configuration, can be handlers for BMP (loading) (always installed), GIF
-(loading), PCX (loading), PNM (loading and saving as raw
-rgb), PNG (loading and saving), JPEG (loading and saving), file formats.
-
-See also: \helpref{wxImage}{wximage} \helpref{wxImageHandler}{wximagehandler}
-

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


@@ -212,7 +303,7 @@ Under MS Windows, the current drive is also changed if {\it dir} contains a driv
 
 \membersection{::wxSplitPath}\label{wxsplitfunction}
 
 
 \membersection{::wxSplitPath}\label{wxsplitfunction}
 

-\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{const wxString *}{ path}, \param{const wxString *}{ name}, \param{const wxString *}{ ext}}
+\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{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
 
 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


@@ -223,7 +314,7 @@ wxSplitPath() will correctly handle filenames with both DOS and Unix path separa
 Windows, however it will not consider backslashes as path separators under Unix (where backslash
 is a valid character in a filename).
 
 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 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
 
 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


@@ -258,7 +349,9 @@ Use of this function requires the file wx\_doc.h to be included.
 Returns the FQDN (fully qualified domain host name) or an empty string on
 error.
 
 Returns the FQDN (fully qualified domain host name) or an empty string on
 error.
 

-See also: \helpref{wxGetHostName}{wxgethostname}
+\wxheading{See also}
+
+\helpref{wxGetHostName}{wxgethostname}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -281,6 +374,7 @@ Returns TRUE if successful, FALSE otherwise.
 \membersection{::wxGetHostName}\label{wxgethostname}
 
 \func{wxString}{wxGetHostName}{\void}
 \membersection{::wxGetHostName}\label{wxgethostname}
 
 \func{wxString}{wxGetHostName}{\void}

+

 \func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
 
 Copies the current host machine's name into the supplied buffer. Please note
 \func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
 
 Copies the current host machine's name into the supplied buffer. Please note


@@ -295,7 +389,9 @@ The first variant of this function returns the hostname if successful or an
 empty string otherwise. The second (deprecated) function returns TRUE
 if successful, FALSE otherwise.
 
 empty string otherwise. The second (deprecated) function returns TRUE
 if successful, FALSE otherwise.
 

-See also: \helpref{wxGetFullHostName}{wxgetfullhostname}
+\wxheading{See also}
+
+\helpref{wxGetFullHostName}{wxgetfullhostname}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -306,6 +402,7 @@ See also: \helpref{wxGetFullHostName}{wxgetfullhostname}
 \membersection{::wxGetUserId}\label{wxgetuserid}
 
 \func{wxString}{wxGetUserId}{\void}
 \membersection{::wxGetUserId}\label{wxgetuserid}
 
 \func{wxString}{wxGetUserId}{\void}

+

 \func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
 
 This function returns the "user id" also known as "login name" under Unix i.e.
 \func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
 
 This function returns the "user id" also known as "login name" under Unix i.e.


@@ -319,7 +416,9 @@ The first variant of this function returns the login name if successful or an
 empty string otherwise. The second (deprecated) function returns TRUE
 if successful, FALSE otherwise.
 
 empty string otherwise. The second (deprecated) function returns TRUE
 if successful, FALSE otherwise.
 

-See also: \helpref{wxGetUserName}{wxgetusername}
+\wxheading{See also}
+
+\helpref{wxGetUserName}{wxgetusername}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -328,6 +427,7 @@ See also: \helpref{wxGetUserName}{wxgetusername}
 \membersection{::wxGetUserName}\label{wxgetusername}
 
 \func{wxString}{wxGetUserName}{\void}
 \membersection{::wxGetUserName}\label{wxgetusername}
 
 \func{wxString}{wxGetUserName}{\void}

+

 \func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}}
 
 This function returns the full user name (something like "Mr. John Smith").
 \func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}}
 
 This function returns the full user name (something like "Mr. John Smith").


@@ -341,7 +441,9 @@ The first variant of this function returns the user name if successful or an
 empty string otherwise. The second (deprecated) function returns TRUE
 if successful, FALSE otherwise.
 
 empty string otherwise. The second (deprecated) function returns TRUE
 if successful, FALSE otherwise.
 

-See also: \helpref{wxGetUserId}{wxgetuserid}
+\wxheading{See also}
+
+\helpref{wxGetUserId}{wxgetuserid}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -397,7 +499,7 @@ case-sensitive comparison.
 \func{size\_t}{Strlen}{\param{const char *}{ p}}
 
 This is a safe version of standard function {\it strlen()}: it does exactly the
 \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
+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}
 {\it p} is the NULL pointer.
 
 \membersection{::wxGetTranslation}\label{wxgettranslation}


@@ -406,7 +508,7 @@ same thing (i.e. returns the length of the string) except that it returns 0 if
 
 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
 
 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
+message catalogs (see \helpref{internationalization 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
 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


@@ -424,20 +526,20 @@ buffer is never overflowed.
 Returns the number of characters copied to the buffer or -1 if there is not
 enough space.
 
 Returns the number of characters copied to the buffer or -1 if there is not
 enough space.
 

-\wxheading{See also:}
-\helpref{wxVsnprintf}{wxvsnprintf},
-\helpref{wxString::Printf}{wxstringprintf}
+\wxheading{See also}
+
+\helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}

 
 

-\membersection{::wxVsnprintf}\label{wxsnprintf}
+\membersection{::wxVsnprintf}\label{wxvsnprintf}

 
 \func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argptr}}
 
 The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list}
 argument instead of arbitrary number of parameters.
 
 
 \func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argptr}}
 
 The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list}
 argument instead of arbitrary number of parameters.
 

-\wxheading{See also:}
-\helpref{wxSnprintf}{wxsnprintf},
-\helpref{wxString::PrintfV}{wxstringprintfv}
+\wxheading{See also}
+
+\helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv}

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


@@ -459,7 +561,7 @@ used with \helpref{wxShowTip}{wxshowtip}.
 \docparam{currentTip}{The index of the first tip to show - normally this index
 is remembered between the 2 program runs.}
 
 \docparam{currentTip}{The index of the first tip to show - normally this index
 is remembered between the 2 program runs.}
 

-\wxheading{See also:}
+\wxheading{See also}

 
 \helpref{Tips overview}{tipsoverview}
 
 
 \helpref{Tips overview}{tipsoverview}
 


@@ -475,13 +577,13 @@ is remembered between the 2 program runs.}
  \param{int}{ x = -1}, \param{int}{ y = -1}}
 
 Pops up a file selector box. In Windows, this is the common file selector
  \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.
+dialog. In X, this is a file selector box with the same functionality.

 The path and filename are distinct elements of a full file pathname.
 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,
 The path and filename are distinct elements of a full file pathname.
 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,

-wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, or 0.
+wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0.

 
 Both the Unix and Windows versions implement a wildcard filter. Typing a
 filename containing wildcards (*, ?) in the filename text item, and
 
 Both the Unix and Windows versions implement a wildcard filter. Typing a
 filename containing wildcards (*, ?) in the filename text item, and


@@ -510,6 +612,63 @@ if (s)
 
 <wx/filedlg.h>
 
 
 <wx/filedlg.h>
 

+\membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
+
+\func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
+
+Shows the colour selection dialog and returns the colour selected by user or
+invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour
+is valid) if the dialog was cancelled.
+
+\wxheading{Parameters}
+
+\docparam{parent}{The parent window for the colour selection dialog}
+
+\docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
+
+\wxheading{Include files}
+
+<wx/colordlg.h>
+
+\membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
+
+\func{size\_t}{wxGetMultipleChoices}{\\
+ \param{wxArrayInt\& }{selections},\\
+ \param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{const wxArrayString\& }{aChoices},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE},\\
+ \param{int }{width=150}, \param{int }{height=200}}
+
+\func{size\_t}{wxGetMultipleChoices}{\\
+ \param{wxArrayInt\& }{selections},\\
+ \param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE},\\
+ \param{int }{width=150}, \param{int }{height=200}}
+
+Pops up a dialog box containing a message, OK/Cancel buttons and a
+multiple-selection listbox. The user may choose an arbitrary (including 0)
+number of items in the listbox whose indices will be returned in 
+{\it selection} array. The initial contents of this array will be used to
+select the items when the dialog is shown.
+
+You may pass the list of strings to choose from either using {\it choices} 
+which is an array of {\it n} strings for the listbox or by using a single
+{\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
+
+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{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
 
 \func{long}{wxGetNumberFromUser}{
 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
 
 \func{long}{wxGetNumberFromUser}{


@@ -537,13 +696,26 @@ Dialog is centered on its {\it parent} unless an explicit position is given in
 
 <wx/textdlg.h>
 
 
 <wx/textdlg.h>
 

+\membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
+
+\func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
+ \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL}}
+
+Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
+in the dialog is not shown on screen but replaced with stars. This is intended
+to be used for entering passwords as the function name implies.
+
+\wxheading{Include files}
+
+<wx/textdlg.h>
+

 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
 
 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
  \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
  \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
 
 \membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
 
 \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
  \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
  \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
 

-Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
+Pop up a dialog box with title set to {\it caption}, {\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 the empty string.
 
 \rtfsp{\it default\_value}.  The user may type in text and press OK to return this text,
 or press Cancel to return the empty string.
 


@@ -582,18 +754,34 @@ is centred; if FALSE, the message is left-justified.
 
 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
 
 
 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
 

-\func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
- \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
- \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
+\func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{const wxArrayString\& }{aChoices},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE},\\
+ \param{int }{width=150}, \param{int }{height=200}}

 
 

-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 the empty string.
+\func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE},\\
+ \param{int }{width=150}, \param{int }{height=200}}

 
 

-{\it choices} is an array of {\it n} strings for the listbox.
+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 the empty string. Use 
+\helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
+valid choice and if you want to be able to detect pressing Cancel reliably.

 
 

-If {\it centre} is TRUE, the message text (which may include new line characters)
-is centred; if FALSE, the message is left-justified.
+You may pass the list of strings to choose from either using {\it choices} 
+which is an array of {\it n} strings for the listbox or by using a single
+{\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
+
+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}
 
 
 \wxheading{Include files}
 


@@ -601,12 +789,20 @@ is centred; if FALSE, the message is left-justified.
 
 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
 
 
 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
 

-\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{const wxArrayString\& }{aChoices},\\
+ \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
+
+\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{int}{ n}, \param{const wxString\& }{choices[]},\\

  \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
  \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
 
  \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
  \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
 

-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}
 
 
 \wxheading{Include files}
 


@@ -614,12 +810,26 @@ If the user pressed cancel, -1 is returned.
 
 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
 
 
 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
 

-\func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
- \param{const wxString\& }{client\_data[]}, \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1},\\
- \param{int}{ y = -1}, \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
+\func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{const wxArrayString\& }{aChoices},\\
+ \param{const wxString\& }{client\_data[]},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
+
+\func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+ \param{const wxString\& }{client\_data[]},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}

 
 As {\bf wxGetSingleChoice} but takes an array of client data pointers
 
 As {\bf wxGetSingleChoice} but takes an array of client data pointers

-corresponding to the strings, and returns one of these pointers.
+corresponding to the strings, and returns one of these pointers or NULL if
+Cancel was pressed. The {\it client\_data} array must have the same number of
+elements as {\it choices} or {\it aChoices}!

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -640,10 +850,10 @@ wxCANCEL.}
 wxYES\_NO or wxOK.}
 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
 \twocolitem{wxCENTRE}{Centres the text.}
 wxYES\_NO or wxOK.}
 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
 \twocolitem{wxCENTRE}{Centres the text.}

-\twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
-\twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
-\twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
-\twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
+\twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
+\twocolitem{wxICON\_HAND}{Displays a hand symbol.}
+\twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
+\twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}

 \end{twocollist}
 
 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
 \end{twocollist}
 
 The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.


@@ -688,7 +898,7 @@ It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprov
 otherwise. This is used as the initial value for "Show tips at startup"
 checkbox which is shown in the tips dialog.}
 
 otherwise. This is used as the initial value for "Show tips at startup"
 checkbox which is shown in the tips dialog.}
 

-\wxheading{See also:}
+\wxheading{See also}

 
 \helpref{Tips overview}{tipsoverview}
 
 
 \helpref{Tips overview}{tipsoverview}
 


@@ -716,6 +926,22 @@ Returns TRUE if the display is colour, FALSE otherwise.
 
 Returns the depth of the display (a value of 1 denotes a monochrome display).
 
 
 Returns the depth of the display (a value of 1 denotes a monochrome display).
 

+\membersection{::wxDisplaySize}
+
+\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
+
+\func{wxSize}{wxGetDisplaySize}{\void}
+
+Returns the display size in pixels.
+
+\membersection{::wxDisplaySizeMM}
+
+\func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
+
+\func{wxSize}{wxGetDisplaySizeMM}{\void}
+
+Returns the display size in millimeters.
+

 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
 
 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
 \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
 
 \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},


@@ -862,7 +1088,9 @@ Sets the translation (from the top left corner) for PostScript output. The defau
 
 \section{Clipboard functions}\label{clipsboard}
 
 
 \section{Clipboard functions}\label{clipsboard}
 

-These clipboard functions are implemented for Windows only.
+These clipboard functions are implemented for Windows only. The use of these functions
+is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard} 
+class instead.

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -965,6 +1193,21 @@ The clipboard must have previously been opened for this call to succeed.
 
 \section{Miscellaneous functions}\label{miscellany}
 
 
 \section{Miscellaneous functions}\label{miscellany}
 

+\membersection{::wxDROP\_ICON}\label{wxdropicon} 
+
+\func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
+
+This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
+name. Under MSW, the cursor is loaded from the resource file and the icon is
+loaded from XPM file under other platforms.
+
+This macro should be used with 
+\helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
+
+\wxheading{Include files}
+
+<wx/dnd.h>
+

 \membersection{::wxNewId}
 
 \func{long}{wxNewId}{\void}
 \membersection{::wxNewId}
 
 \func{long}{wxNewId}{\void}


@@ -1025,7 +1268,7 @@ registered with the dynamic class system using DECLARE... and IMPLEMENT... macro
 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
 called by the application.
 
 Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
 called by the application.
 

-See also helpref{wxDDEInitialize}{wxddeinitialize}.
+See also \helpref{wxDDEInitialize}{wxddeinitialize}.

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -1051,7 +1294,7 @@ See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient},
 
 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
 
 
 \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
 

-{\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogoverview} instead!}
+{\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogdebug} instead!}

 
 Display a debugging message; under Windows, this will appear on the
 debugger command window, and under Unix, it will be written to standard
 
 Display a debugging message; under Windows, this will appear on the
 debugger command window, and under Unix, it will be written to standard


@@ -1086,7 +1329,7 @@ Gets the physical size of the display in pixels.
 
 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
 
 
 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
 

-This function enables or disables all top level windows. It is used by
+This function enables or disables all top level windows. It is used by 

 \helpref{::wxSafeYield}{wxsafeyield}.
 
 \wxheading{Include files}
 \helpref{::wxSafeYield}{wxsafeyield}.
 
 \wxheading{Include files}


@@ -1167,6 +1410,10 @@ wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
 
 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
 
 
 \func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
 

+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
+
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}}
+

 Executes another program in Unix or Windows.
 
 The first form takes a command string, such as {\tt "emacs file.txt"}.
 Executes another program in Unix or Windows.
 
 The first form takes a command string, such as {\tt "emacs file.txt"}.


@@ -1174,6 +1421,9 @@ The first form takes a command string, such as {\tt "emacs file.txt"}.
 The second form takes an array of values: a command, any number of
 arguments, terminated by NULL.
 
 The second form takes an array of values: a command, any number of
 arguments, terminated by NULL.
 

+The semantics of the third and fourth versions is different from the first two
+and is described in more details below.
+

 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.
 


@@ -1182,18 +1432,24 @@ 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. Also, while waiting for the process to
 terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller
 $-1$ if the process couldn't be started and typically 0 if the process
 terminated successfully. Also, while waiting for the process to
 terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller

-should ensure that this can cause no recursion, in the simples case by 
+should ensure that this can cause no recursion, in the simplest case by 

 calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
 
 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 (note that callback
 calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
 
 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 (note that callback

-parameter can not be non NULL for synchronous execution), 
+parameter can not be non-NULL for synchronous execution), 

 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
 the process finishes.
 
 \helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
 the process finishes.
 

-See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
+Finally, you may use the third overloaded version of this function to execute
+a process (always synchronously) and capture its output in the array 
+{\it output}. The fourth version adds the possibility to additionally capture
+the messages from standard error output in the {\it errors} array.
+
+See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}, 
+\helpref{Exec sample}{sampleexec}.

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -1234,7 +1490,7 @@ Find a menu item identifier associated with the given frame's menu bar.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\membersection{::wxFindWindowByLabel}
+\membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}

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


@@ -1262,6 +1518,20 @@ If no such named window is found, {\bf wxFindWindowByLabel} is called.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+\membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
+
+\func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
+
+Find the deepest window at the given mouse position in screen coordinates,
+returning the window if found, or NULL if not.
+
+\membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
+
+\func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
+
+Find the deepest window at the mouse pointer position, returning the window
+and current pointer position in screen coordinates.
+

 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
 
 \func{wxWindow *}{wxGetActiveWindow}{\void}
 \membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
 
 \func{wxWindow *}{wxGetActiveWindow}{\void}


@@ -1282,85 +1552,82 @@ Under X only, returns the current display name. See also \helpref{wxSetDisplayNa
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\membersection{::wxGetHomeDir}
+\membersection{::wxGetHomeDir}\label{wxgethomedir}

 
 

-\func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
+\func{wxString}{wxGetHomeDir}{\void}

 
 

-Fills the buffer with a string representing the user's home directory (Unix only).
+Return the (current) user's home directory.

 
 

-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxGetHostName}
-
-\func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
+\wxheading{See also}

 
 

-Copies the host name of the machine the program is running on into the
-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''.
+\helpref{wxGetUserHome}{wxgetuserhome}

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

-\membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
-
-\func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
-
-Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
+\membersection{::wxGetFreeMemory}\label{wxgetfreememory}

 
 

-If {\it resetTimer} is TRUE (the default), the timer is reset to zero
-by this call.
+\func{long}{wxGetFreeMemory}{\void}

 
 

-See also \helpref{wxTimer}{wxtimer}.
+Returns the amount of free memory in bytes under environments which
+support it, and -1 if not supported. Currently, it is supported only
+under Windows, Linux and Solaris.

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 

-<wx/timer.h>
+<wx/utils.h>

 
 

-\membersection{::wxGetFreeMemory}\label{wxgetfreememory}
+\membersection{::wxGetMousePosition}\label{wxgetmouseposition}

 
 

-\func{long}{wxGetFreeMemory}{\void}
+\func{wxPoint}{wxGetMousePosition}{\void}

 
 

-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.
+Returns the mouse position in screen coordinates.

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

-\membersection{::wxGetMousePosition}
+\membersection{::wxGetOsDescription}\label{wxgetosdescription}

 
 

-\func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
+\func{wxString}{wxGetOsDescription}{\void}

 
 

-Returns the mouse position in screen coordinates.
+Returns the string containing the description of the current platform in a
+user-readable form. For example, this function may return strings like  
+{\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
+
+\wxheading{See also}
+
+\helpref{::wxGetOsVersion}{wxgetosversion}

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

-\membersection{::wxGetOsVersion}
+\membersection{::wxGetOsVersion}\label{wxgetosversion}

 
 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
 
 Gets operating system version information.
 
 \begin{twocollist}\itemsep=0pt
 
 \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
 
 Gets operating system version information.
 
 \begin{twocollist}\itemsep=0pt

-\twocolitemruled{Platform}{Return tyes}
+\twocolitemruled{Platform}{Return types}

 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}
 \twocolitem{Macintosh}{Return value is wxMACINTOSH.}

-\twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
+\twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }

 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
 \twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
 \twocolitem{OS/2}{Return value is wxOS2\_PM.}
 \twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}

-\twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
-\twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
+\twocolitem{Windows NT/2000}{Return value is wxWINDOWS\_NT, version is returned in {\it major} and {\it minor}}
+\twocolitem{Windows 98}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 1 or greater.}
+\twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 0.}

 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
 \end{twocollist}
 
 \twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
 \twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
 \end{twocollist}
 

+\wxheading{See also}
+
+\helpref{::wxGetOsDescription}{wxgetosdescription}
+

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


@@ -1411,6 +1678,18 @@ Under Windows, this returns ``user''.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+\membersection{::wxGetUserHome}\label{wxgetuserhome}
+
+\func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
+
+Returns the home directory for the given user. If the username is empty
+(default value), this function behaves like 
+\helpref{wxGetHomeDir}{wxgethomedir}.
+
+\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}}


@@ -1423,6 +1702,18 @@ Under Windows, this returns ``unknown''.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+\membersection{::wxHandleFatalExceptions}\label{wxhandlefatalexceptions}
+
+\func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = TRUE}}
+
+If {\it doIt} is TRUE, the fatal exceptions (also known as general protection
+faults under Windows or segmentation violations in the Unix world) will be
+caught and passed to \helpref{wxApp::OnFatalException}{wxapponfatalexception}.
+By default, i.e. before this function is called, they will be handled in the
+normal way which usually just means that the application will be terminated.
+Calling wxHandleFatalExceptions() with {\it doIt} equal to FALSE will restore
+this default behaviour.
+

 \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}}


@@ -1437,6 +1728,17 @@ It does not raise a signal in the receiving process.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+\membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
+
+\func{void}{wxInitAllImageHandlers}{\void}
+
+Initializes all available image handlers. For a list of available handlers,
+see \helpref{wxImage}{wximage}.
+
+\wxheading{See also}
+
+\helpref{wxImage}{wximage}, \helpref{wxImageHandler}{wximagehandler}
+

 \membersection{::wxIsBusy}\label{wxisbusy}
 
 \func{bool}{wxIsBusy}{\void}
 \membersection{::wxIsBusy}\label{wxisbusy}
 
 \func{bool}{wxIsBusy}{\void}


@@ -1513,7 +1815,12 @@ sometime later - usually during the next even loop iteration.
 
 Note that a copy of the {\it event} is made by the function, so the original
 copy can be deleted as soon as function returns. This function can also be used
 
 Note that a copy of the {\it event} is made by the function, so the original
 copy can be deleted as soon as function returns. This function can also be used

-to send events between different threads safely.
+to send events between different threads safely. As this function makes a
+copy of the event, the event needs to have a fully implemented Clone() method,
+which may not be the case for all event in wxWindows.
+
+See also \helpref{AddPendingEvent}{wxevthandleraddpendingevent} (which this function
+uses internally).

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -1556,7 +1863,7 @@ See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
 Executes a command in an interactive shell window. If no command is
 specified, then just the shell is spawned.
 
 Executes a command in an interactive shell window. If no command is
 specified, then just the shell is spawned.
 

-See also \helpref{wxExecute}{wxexecute}.
+See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -1588,18 +1895,6 @@ as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\membersection{::wxStartTimer}\label{wxstarttimer}
-
-\func{void}{wxStartTimer}{\void}
-
-Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
-
-See also \helpref{wxTimer}{wxtimer}.
-
-\wxheading{Include files}
-
-<wx/timer.h>
-

 \membersection{::wxToLower}\label{wxtolower}
 
 \func{char}{wxToLower}{\param{char }{ch}}
 \membersection{::wxToLower}\label{wxtolower}
 
 \func{char}{wxToLower}{\param{char }{ch}}


@@ -1698,8 +1993,8 @@ See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfig
 
 Yields control to pending messages in the windowing system. This can be useful, for example, when a
 time-consuming process writes to a text window. Without an occasional
 
 Yields control to pending messages in the windowing system. This can be useful, for example, when a
 time-consuming process writes to a text window. Without an occasional

-yield, the text window will not be updated properly, and (since Windows
-multitasking is cooperative) other processes will not respond.
+yield, the text window will not be updated properly, and on systems with
+cooperative multitasking, such as Windows 3.1 other processes will not respond.

 
 Caution should be exercised, however, since yielding may allow the
 user to perform actions which are not compatible with the current task.
 
 Caution should be exercised, however, since yielding may allow the
 user to perform actions which are not compatible with the current task.


@@ -1707,10 +2002,31 @@ Disabling menu items or whole menus during processing can avoid unwanted
 reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
 function.
 
 reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
 function.
 

+Note that wxYield will not flush the message logs. This is intentional as
+calling wxYield is usually done to quickly update the screen and popping up a
+message box dialog may be undesirable. If you do wish to flush the log
+messages immediately (otherwise it will be done during the next idle loop
+iteration), call \helpref{wxLog::FlushActive}{wxlogflushactive}.
+

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

+\membersection{::wxWakeUpIdle}\label{wxwakeupidle}
+
+\func{void}{wxWakeUpIdle}{\void}
+
+This functions wakes up the (internal and platform dependent) idle system, i.e. it
+will force the system to send an idle event even if the system currently {\it is}
+ idle and thus would not send any idle event until after some other event would get
+sent. This is also useful for sending events between two threads and is used by
+the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and 
+\helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
+
+\wxheading{Include files}
+
+<wx/app.h>
+

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


@@ -1834,7 +2150,7 @@ dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
 
 Used inside a class declaration to declare that the objects of this class should be dynamically
 \func{}{DECLARE\_DYNAMIC\_CLASS}{className}
 
 Used inside a class declaration to declare that the objects of this class should be dynamically

-createable from run-time type information.
+creatable from run-time type information.

 
 Example:
 
 
 Example:
 


@@ -1977,7 +2293,7 @@ base classes.
 
 This macro loads a bitmap from either application resources (on the platforms
 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
 
 This macro loads a bitmap from either application resources (on the platforms
 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to

-avoid using {\tt #ifdef}s when creating bitmaps.
+avoid using {\tt \#ifdef}s when creating bitmaps.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -1988,6 +2304,18 @@ avoid using {\tt #ifdef}s when creating bitmaps.
 
 <wx/gdicmn.h>
 
 
 <wx/gdicmn.h>
 

+\membersection{wxConstCast}\label{wxconstcast}
+
+\func{}{wxConstCast}{ptr, classname}
+
+This macro expands into {\tt const\_cast<classname *>(ptr)} if the compiler
+supports {\it const\_cast} or into an old, C-style cast, otherwise.
+
+\wxheading{See also}
+
+\helpref{wxDynamicCast}{wxdynamiccast}\\
+\helpref{wxStaticCast}{wxstaticcast}
+

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


@@ -2011,7 +2339,7 @@ In non-debug mode, this is defined as the normal new operator.
 
 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
 the pointer is of this type (the check is done during the run-time) or NULL
 
 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
 the pointer is of this type (the check is done during the run-time) or NULL

-otherwise. Usage of this macro is prefered over obsoleted wxObject::IsKindOf()
+otherwise. Usage of this macro is preferred over obsoleted wxObject::IsKindOf()

 function.
 
 The {\it ptr} argument may be NULL, in which case NULL will be returned.
 function.
 
 The {\it ptr} argument may be NULL, in which case NULL will be returned.


@@ -2027,13 +2355,15 @@ Example:
     }
     else
     {
     }
     else
     {

-        // no window has the focus or it's not a text control
+        // no window has the focus or it is not a text control

     }
 \end{verbatim}
 
 \wxheading{See also}
 
     }
 \end{verbatim}
 
 \wxheading{See also}
 

-\helpref{RTTI overview}{runtimeclassoverview}
+\helpref{RTTI overview}{runtimeclassoverview}\\
+\helpref{wxConstCast}{wxconstcast}\\
+\helpref{wxStatiicCast}{wxstaticcast}

 
 \membersection{wxICON}\label{wxiconmacro}
 
 
 \membersection{wxICON}\label{wxiconmacro}
 


@@ -2041,7 +2371,7 @@ Example:
 
 This macro loads an icon from either application resources (on the platforms
 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
 
 This macro loads an icon from either application resources (on the platforms
 for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to

-avoid using {\tt #ifdef}s when creating icons.
+avoid using {\tt \#ifdef}s when creating icons.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -2052,6 +2382,17 @@ avoid using {\tt #ifdef}s when creating icons.
 
 <wx/gdicmn.h>
 
 
 <wx/gdicmn.h>
 

+\membersection{wxStaticCast}\label{wxstaticcast}
+
+\func{}{wxStaticCast}{ptr, classname}
+
+This macro checks that the cast is valid in debug mode (an assert failure will
+result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the
+result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
+
+\helpref{wxDynamicCast}{wxdynamiccast}\\
+\helpref{wxConstCast}{wxconstcast}
+

 \membersection{WXTRACE}\label{trace}
 
 \wxheading{Include files}
 \membersection{WXTRACE}\label{trace}
 
 \wxheading{Include files}


@@ -2094,15 +2435,13 @@ files and loading user interface elements from resources.
 
 \normalbox{Please note that this use of the word `resource' is different from that used when talking
 about initialisation file resource reading and writing, using such functions
 
 \normalbox{Please note that this use of the word `resource' is different from that used when talking
 about initialisation file resource reading and writing, using such functions

-as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
+as wxWriteResource and wxGetResource. It is just an unfortunate clash of terminology.}

 
 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
 
 See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
 loading from resource data.
 
 
 \helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
 
 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}}


@@ -2126,15 +2465,15 @@ wxWindows bitmap resource identifier. For example, if the .WXR file contains
 the following:
 
 \begin{verbatim}
 the following:
 
 \begin{verbatim}

-static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
-  bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
-  bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
+static const wxString\& project_resource = "bitmap(name = 'project_resource',\
+  bitmap = ['project', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
+  bitmap = ['project.xpm', wxBITMAP_TYPE_XPM, 'X']).";

 \end{verbatim}
 
 then this function can be called as follows:
 
 \begin{verbatim}
 \end{verbatim}
 
 then this function can be called as follows:
 
 \begin{verbatim}

-  wxBitmap *bitmap  = wxResourceCreateBitmap("aiai_resource");
+  wxBitmap *bitmap  = wxResourceCreateBitmap("project_resource");

 \end{verbatim}
 
 \membersection{::wxResourceCreateIcon}
 \end{verbatim}
 
 \membersection{::wxResourceCreateIcon}


@@ -2146,15 +2485,15 @@ wxWindows icon resource identifier. For example, if the .WXR file contains
 the following:
 
 \begin{verbatim}
 the following:
 
 \begin{verbatim}

-static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
-  icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
-  icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
+static const wxString\& project_resource = "icon(name = 'project_resource',\
+  icon = ['project', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
+  icon = ['project', wxBITMAP_TYPE_XBM_DATA, 'X']).";

 \end{verbatim}
 
 then this function can be called as follows:
 
 \begin{verbatim}
 \end{verbatim}
 
 then this function can be called as follows:
 
 \begin{verbatim}

-  wxIcon *icon = wxResourceCreateIcon("aiai_resource");
+  wxIcon *icon = wxResourceCreateIcon("project_resource");

 \end{verbatim}
 
 \membersection{::wxResourceCreateMenuBar}
 \end{verbatim}
 
 \membersection{::wxResourceCreateMenuBar}


@@ -2213,9 +2552,9 @@ dialog(name = 'dialog1',
   title = 'Test dialog box',
   x = 312, y = 234, width = 400, height = 300,
   modal = 0,
   title = 'Test dialog box',
   x = 312, y = 234, width = 400, height = 300,
   modal = 0,

-  control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
+  control = [1000, wxStaticBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,

       [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
       [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],

-  control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
+  control = [1001, wxTextCtrl, '', 'wxTE_MULTILINE', 'text3',

       156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
       [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
       [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
       156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
       [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
       [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).


@@ -2241,7 +2580,7 @@ wxWindows resource data.
 
 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
 
 
 \membersection{::wxResourceParseString}\label{wxresourceparsestring}
 

-\func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
+\func{bool}{wxResourceParseString}{\param{char*}{ s}, \param{wxResourceTable *}{table = NULL}}

 
 Parses a string containing one or more wxWindows resource objects. If
 the resource objects are global static data that are included into the
 
 Parses a string containing one or more wxWindows resource objects. If
 the resource objects are global static data that are included into the


@@ -2251,17 +2590,17 @@ containing the resource data, to make it known to wxWindows.
 {\it resource} should contain data with the following form:
 
 \begin{verbatim}
 {\it resource} should contain data with the following form:
 
 \begin{verbatim}

-static const wxString\& dialog1 = "dialog(name = 'dialog1',\
-  style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
-  title = 'Test dialog box',\
-  x = 312, y = 234, width = 400, height = 300,\
-  modal = 0,\
-  control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
-      [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
-  control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
-      156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
-      [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
-      [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
+dialog(name = 'dialog1',
+  style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
+  title = 'Test dialog box',
+  x = 312, y = 234, width = 400, height = 300,
+  modal = 0,
+  control = [1000, wxStaticBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
+      [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
+  control = [1001, wxTextCtrl, '', 'wxTE_MULTILINE', 'text3',
+      156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
+      [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
+      [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).

 \end{verbatim}
 
 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
 \end{verbatim}
 
 This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to


@@ -2269,10 +2608,10 @@ load an entire {\tt .wxr file} into a string.
 
 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
 
 
 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
 

-\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
+\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char* }{xbm\_data}, \param{int }{width},

 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
 
 \param{int }{height}, \param{wxResourceTable *}{table = NULL}}
 

-\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
+\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char** }{xpm\_data}}

 
 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system. 
 This is required if other resources will use the bitmap data, since otherwise there
 
 Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system. 
 This is required if other resources will use the bitmap data, since otherwise there


@@ -2285,7 +2624,9 @@ Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
 \section{Log functions}\label{logfunctions}
 
 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
 \section{Log functions}\label{logfunctions}
 
 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for

-further information.
+further information. The functions use (implicitly) the currently active log
+target, so their descriptions here may not apply if the log target is not the
+standard one (installed by wxWindows in the beginning of the program).

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -2295,9 +2636,9 @@ further information.
 
 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
 
 
 \func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
 

-The function to use for error messages, i.e. the
-messages that must be shown to the user. The default processing is to pop up a
-message box to inform the user about it.
+The function to use for error messages, i.e. the messages that must be shown
+to the user. The default processing is to pop up a message box to inform the
+user about it.

 
 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
 
 
 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
 


@@ -2311,76 +2652,217 @@ function also terminates the program with this exit code.
 
 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
 
 
 \func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
 

-For warnings - they are also normally shown to the
-user, but don't interrupt the program work.
+For warnings - they are also normally shown to the user, but don't interrupt
+the program work.

 
 \membersection{::wxLogMessage}\label{wxlogmessage}
 
 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
 
 
 \membersection{::wxLogMessage}\label{wxlogmessage}
 
 \func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
 

-for all normal, informational messages. They also
-appear in a message box by default (but it can be changed). Notice
-that the standard behaviour is to not show informational messages if there are
-any errors later - the logic being that the later error messages make the
-informational messages preceding them meaningless.
+for all normal, informational messages. They also appear in a message box by
+default (but it can be changed). Notice that the standard behaviour is to not
+show informational messages if there are any errors later - the logic being
+that the later error messages make the informational messages preceding them
+meaningless.

 
 \membersection{::wxLogVerbose}\label{wxlogverbose}
 
 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
 
 
 \membersection{::wxLogVerbose}\label{wxlogverbose}
 
 \func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
 

-For verbose output. Normally, it's suppressed, but
+For verbose output. Normally, it is suppressed, but

 might be activated if the user wishes to know more details about the program
 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
 
 \membersection{::wxLogStatus}\label{wxlogstatus}
 
 might be activated if the user wishes to know more details about the program
 progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
 
 \membersection{::wxLogStatus}\label{wxlogstatus}
 

+\func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char*}{ formatString}, \param{...}{}}
+

 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
 
 \func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
 

-For status messages - they will go into the status
-bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
+Messages logged by this function will appear in the statusbar of the {\it
+frame} or of the top level application window by default (i.e. when using
+the second version of the function).
+
+If the target frame doesn't have a statusbar, the message will be lost.

 
 \membersection{::wxLogSysError}\label{wxlogsyserror}
 
 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
 
 
 \membersection{::wxLogSysError}\label{wxlogsyserror}
 
 \func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
 

-Mostly used by wxWindows itself, but might be
-handy for logging errors after system call (API function) failure. It logs the
-specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
-on the platform) and the corresponding error
-message. The second form of this function takes the error code explitly as the
-first argument.
+Mostly used by wxWindows itself, but might be handy for logging errors after
+system call (API function) failure. It logs the specified message text as well
+as the last system error code ({\it errno} or {\it ::GetLastError()} depending
+on the platform) and the corresponding error message. The second form
+of this function takes the error code explicitly as the first argument.
+
+\wxheading{See also}
+
+\helpref{wxSysErrorCode}{wxsyserrorcode},
+\helpref{wxSysErrorMsg}{wxsyserrormsg}

 
 \membersection{::wxLogDebug}\label{wxlogdebug}
 
 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
 
 
 \membersection{::wxLogDebug}\label{wxlogdebug}
 
 \func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
 

-The right function for debug output. It only
-does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
-and expands to nothing in release mode (otherwise).
+The right function for debug output. It only does anything at all in the debug
+mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expands to
+nothing in release mode (otherwise).

 
 \membersection{::wxLogTrace}\label{wxlogtrace}
 
 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
 
 
 \membersection{::wxLogTrace}\label{wxlogtrace}
 
 \func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
 

-\func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}

 
 

-As {\bf wxLogDebug}, only does something in debug
-build. The reason for making it a separate function from it is that usually
-there are a lot of trace messages, so it might make sense to separate them
-from other debug messages which would be flooded in them. Moreover, the second
-version of this function takes a trace mask as the first argument which allows
-to further restrict the amount of messages generated. The value of {\it mask} can be:
+As {\bf wxLogDebug}, trace functions only do something in debug build and
+expand to nothing in the release one. The reason for making
+it a separate function from it is that usually there are a lot of trace
+messages, so it might make sense to separate them from other debug messages.
+
+The trace messages also usually can be separated into different categories and
+the second and third versions of this function only log the message if the 
+{\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
+allows to selectively trace only some operations and not others by changing
+the value of the trace mask (possible during the run-time).
+
+For the second function (taking a string mask), the message is logged only if
+the mask has been previously enabled by the call to 
+\helpref{AddTraceMask}{wxlogaddtracemask}. The predefined string trace masks
+used by wxWindows are:
+
+\begin{itemize}\itemsep=0pt
+\item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
+\item wxTRACE\_Messages: trace window messages/X callbacks
+\item wxTRACE\_ResAlloc: trace GDI resource allocation
+\item wxTRACE\_RefCount: trace various ref counting operations
+\item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
+\end{itemize}
+
+The third version of the function only logs the message if all the bit
+corresponding to the {\it mask} are set in the wxLog trace mask which can be
+set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less
+flexible than the previous one because it doesn't allow defining the user
+trace masks easily - this is why it is deprecated in favour of using string
+trace masks.

 
 \begin{itemize}\itemsep=0pt
 \item wxTraceMemAlloc: trace memory allocation (new/delete)
 \item wxTraceMessages: trace window messages/X callbacks
 \item wxTraceResAlloc: trace GDI resource allocation
 \item wxTraceRefCount: trace various ref counting operations
 
 \begin{itemize}\itemsep=0pt
 \item wxTraceMemAlloc: trace memory allocation (new/delete)
 \item wxTraceMessages: trace window messages/X callbacks
 \item wxTraceResAlloc: trace GDI resource allocation
 \item wxTraceRefCount: trace various ref counting operations

+\item wxTraceOleCalls: trace OLE method calls (Win32 only)

 \end{itemize}
 
 \end{itemize}
 

+\membersection{::wxSysErrorCode}\label{wxsyserrorcode}
+
+\func{unsigned long}{wxSysErrorCode}{\void}
+
+Returns the error code from the last system call. This function uses
+{\tt errno} on Unix platforms and {\tt GetLastError} under Win32.
+
+\wxheading{See also}
+
+\helpref{wxSysErrorMsg}{wxsyserrormsg},
+\helpref{wxLogSysError}{wxlogsyserror}
+
+\membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
+
+\func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
+
+Returns the error message corresponding to the given system error code. If 
+{\it errCode} is $0$ (default), the last error code (as returned by 
+\helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
+
+\wxheading{See also}
+
+\helpref{wxSysErrorCode}{wxsyserrorcode},
+\helpref{wxLogSysError}{wxlogsyserror}
+
+\section{Time functions}\label{timefunctions}
+
+The functions in this section deal with getting the current time and
+starting/stopping the global timers. Please note that the timer functions are
+deprecated because they work with one global timer only and 
+\helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
+should be used instead. For retrieving the current time, you may also use 
+\helpref{wxDateTime::Now}{wxdatetimenow} or 
+\helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
+
+\membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
+
+\func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
+
+Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
+
+If {\it resetTimer} is TRUE (the default), the timer is reset to zero
+by this call.
+
+See also \helpref{wxTimer}{wxtimer}.
+
+\wxheading{Include files}
+
+<wx/timer.h>
+
+\membersection{::wxGetLocalTime}\label{wxgetlocaltime}
+
+\func{long}{wxGetLocalTime}{\void}
+
+Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
+
+\wxheading{See also}
+
+\helpref{wxDateTime::Now}{wxdatetimenow}
+
+\wxheading{Include files}
+
+<wx/timer.h>
+
+\membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
+
+\func{wxLongLone}{wxGetLocalTimeMillis}{\void}
+
+Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
+
+\wxheading{See also}
+
+\helpref{wxDateTime::Now}{wxdatetimenow},\\
+\helpref{wxLongLone}{wxlonglong}
+
+\wxheading{Include files}
+
+<wx/timer.h>
+
+\membersection{::wxGetUTCTime}\label{wxgetutctime}
+
+\func{long}{wxGetUTCTime}{\void}
+
+Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
+
+\wxheading{See also}
+
+\helpref{wxDateTime::Now}{wxdatetimenow}
+
+\wxheading{Include files}
+
+<wx/timer.h>
+
+\membersection{::wxStartTimer}\label{wxstarttimer}
+
+\func{void}{wxStartTimer}{\void}
+
+Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
+
+See also \helpref{wxTimer}{wxtimer}.
+
+\wxheading{Include files}
+
+<wx/timer.h>
+

 \section{Debugging macros and functions}\label{debugmacros}
 
 \section{Debugging macros and functions}\label{debugmacros}
 

-Useful macros and functins for error checking and defensive programming. ASSERTs are only
+Useful macros and functions for error checking and defensive programming. ASSERTs are only

 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
 builds.
 
 compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
 builds.
 


@@ -2483,3 +2965,56 @@ This is the same as \helpref{wxCHECK2}{wxcheck2}, but
 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
 instead of wxFAIL() if the {\it condition} is false.
 
 \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called
 instead of wxFAIL() if the {\it condition} is false.
 

+\section{Environment access functions}\label{environfunctions}
+
+The functions in this section allow to access (get) or change value of
+environment variables in a portable way. They are currently implemented under
+Win32 and POSIX-like systems (Unix).
+
+% TODO add some stuff about env var inheriting but not propagating upwards (VZ)
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{wxGetenv}\label{wxgetenvmacro}
+
+\func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}
+
+This is a macro defined as {\tt getenv()} or its wide char version in Unicode
+mode.
+
+Note that under Win32 it may not return correct value for the variables set
+with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
+instead.
+
+\membersection{wxGetEnv}\label{wxgetenv}
+
+\func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}
+
+Returns the current value of the environment variable {\it var} in {\it value}.
+{\it value} may be {\tt NULL} if you just want to know if the variable exists
+and are not interested in its value.
+
+Returns {\tt TRUE} if the variable exists, {\tt FALSE} otherwise.
+
+\membersection{wxSetEnv}\label{wxsetenv}
+
+\func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxChar *}{value}}
+
+Sets the value of the environment variable {\it var} (adding it if necessary)
+to {\it value}.
+
+Returns {\tt TRUE} on success.
+
+\membersection{wxUnsetEnv}\label{wxunsetenv}
+
+\func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}
+
+Removes the variable {\it var} from the environment. 
+\helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
+function.
+
+Returns {\tt TRUE} on success.
+
+