wx.SL_INVERSE works for the big 3 now.

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

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index 0318e25402b1bd6adcf0009ffcd5b14cb3760b05..ad28eda84b015bf7ff6a5a33de081c068b0ea120 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -2,11 +2,11 @@
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}
 
 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
 \setfooter{\thepage}{}{}{}{}{\thepage}
 

-The functions and macros defined in wxWindows are described here: you can
+The functions and macros defined in wxWidgets are described here: you can

 either look up a function using the alphabetical listing of them or find it in
 the corresponding topic.
 
 either look up a function using the alphabetical listing of them or find it in
 the corresponding topic.
 

-\section{Alphabetical functions and macros list}
+\section{Alphabetical functions and macros list}\label{functionsalphabetically}

 
 \helpref{CLASSINFO}{classinfo}\\
 \helpref{copystring}{copystring}\\
 
 \helpref{CLASSINFO}{classinfo}\\
 \helpref{copystring}{copystring}\\


@@ -21,6 +21,7 @@ the corresponding topic.
 \helpref{IMPLEMENT\_CLASS}{implementclass}\\
 \helpref{IMPLEMENT\_DYNAMIC\_CLASS2}{implementdynamicclass2}\\
 \helpref{IMPLEMENT\_DYNAMIC\_CLASS}{implementdynamicclass}\\
 \helpref{IMPLEMENT\_CLASS}{implementclass}\\
 \helpref{IMPLEMENT\_DYNAMIC\_CLASS2}{implementdynamicclass2}\\
 \helpref{IMPLEMENT\_DYNAMIC\_CLASS}{implementdynamicclass}\\

+\helpref{wxCONCAT}{wxconcat}\\

 \helpref{WXDEBUG\_NEW}{debugnew}\\
 \helpref{WXTRACELEVEL}{tracelevel}\\
 \helpref{WXTRACE}{trace}\\
 \helpref{WXDEBUG\_NEW}{debugnew}\\
 \helpref{WXTRACELEVEL}{tracelevel}\\
 \helpref{WXTRACE}{trace}\\


@@ -30,6 +31,7 @@ the corresponding topic.
 \helpref{wxBITMAP}{wxbitmapmacro}\\
 \helpref{wxBeginBusyCursor}{wxbeginbusycursor}\\
 \helpref{wxBell}{wxbell}\\
 \helpref{wxBITMAP}{wxbitmapmacro}\\
 \helpref{wxBeginBusyCursor}{wxbeginbusycursor}\\
 \helpref{wxBell}{wxbell}\\

+\helpref{wxCHANGE\_UMASK}{wxchangeumask}\\

 \helpref{wxCHECK}{wxcheck}\\
 \helpref{wxCHECK2\_MSG}{wxcheck2msg}\\
 \helpref{wxCHECK2}{wxcheck2}\\
 \helpref{wxCHECK}{wxcheck}\\
 \helpref{wxCHECK2\_MSG}{wxcheck2msg}\\
 \helpref{wxCHECK2}{wxcheck2}\\


@@ -37,6 +39,7 @@ the corresponding topic.
 \helpref{wxCHECK\_MSG}{wxcheckmsg}\\
 \helpref{wxCHECK\_RET}{wxcheckret}\\
 \helpref{wxCHECK\_VERSION}{wxcheckversion}\\
 \helpref{wxCHECK\_MSG}{wxcheckmsg}\\
 \helpref{wxCHECK\_RET}{wxcheckret}\\
 \helpref{wxCHECK\_VERSION}{wxcheckversion}\\

+\helpref{wxCHECK\_VERSION\_FULL}{wxcheckversionfull}\\

 \helpref{wxCHECK\_W32API\_VERSION}{wxcheckw32apiversion}\\
 \helpref{wxClientDisplayRect}{wxclientdisplayrect}\\
 \helpref{wxClipboardOpen}{functionwxclipboardopen}\\
 \helpref{wxCHECK\_W32API\_VERSION}{wxcheckw32apiversion}\\
 \helpref{wxClientDisplayRect}{wxclientdisplayrect}\\
 \helpref{wxClipboardOpen}{functionwxclipboardopen}\\


@@ -93,20 +96,25 @@ the corresponding topic.
 \helpref{wxFinite}{wxfinite}\\
 \helpref{wxGetActiveWindow}{wxgetactivewindow}\\
 \helpref{wxGetApp}{wxgetapp}\\
 \helpref{wxFinite}{wxfinite}\\
 \helpref{wxGetActiveWindow}{wxgetactivewindow}\\
 \helpref{wxGetApp}{wxgetapp}\\

+\helpref{wxGetBatteryState}{wxgetbatterystate}\\

 \helpref{wxGetClipboardData}{wxgetclipboarddata}\\
 \helpref{wxGetClipboardFormatName}{wxgetclipboardformatname}\\
 \helpref{wxGetColourFromUser}{wxgetcolourfromuser}\\
 \helpref{wxGetCwd}{wxgetcwd}\\
 \helpref{wxGetDiskSpace}{wxgetdiskspace}\\
 \helpref{wxGetDisplayName}{wxgetdisplayname}\\
 \helpref{wxGetClipboardData}{wxgetclipboarddata}\\
 \helpref{wxGetClipboardFormatName}{wxgetclipboardformatname}\\
 \helpref{wxGetColourFromUser}{wxgetcolourfromuser}\\
 \helpref{wxGetCwd}{wxgetcwd}\\
 \helpref{wxGetDiskSpace}{wxgetdiskspace}\\
 \helpref{wxGetDisplayName}{wxgetdisplayname}\\

+\helpref{wxGetDisplaySize}{wxdisplaysize}\\
+\helpref{wxGetDisplaySizeMM}{wxdisplaysizemm}\\

 \helpref{wxGetElapsedTime}{wxgetelapsedtime}\\
 \helpref{wxGetEmailAddress}{wxgetemailaddress}\\
 \helpref{wxGetEnv}{wxgetenv}\\
 \helpref{wxGetElapsedTime}{wxgetelapsedtime}\\
 \helpref{wxGetEmailAddress}{wxgetemailaddress}\\
 \helpref{wxGetEnv}{wxgetenv}\\

+\helpref{wxGetFileType}{wxgetfiletype}\\

 \helpref{wxGetFontFromUser}{wxgetfontfromuser}\\
 \helpref{wxGetFreeMemory}{wxgetfreememory}\\
 \helpref{wxGetFullHostName}{wxgetfullhostname}\\
 \helpref{wxGetHomeDir}{wxgethomedir}\\
 \helpref{wxGetHostName}{wxgethostname}\\
 \helpref{wxGetFontFromUser}{wxgetfontfromuser}\\
 \helpref{wxGetFreeMemory}{wxgetfreememory}\\
 \helpref{wxGetFullHostName}{wxgetfullhostname}\\
 \helpref{wxGetHomeDir}{wxgethomedir}\\
 \helpref{wxGetHostName}{wxgethostname}\\

+\helpref{wxGetKeyState}{wxgetkeystate}\\

 \helpref{wxGetLocalTimeMillis}{wxgetlocaltimemillis}\\
 \helpref{wxGetLocalTime}{wxgetlocaltime}\\
 \helpref{wxGetMousePosition}{wxgetmouseposition}\\
 \helpref{wxGetLocalTimeMillis}{wxgetlocaltimemillis}\\
 \helpref{wxGetLocalTime}{wxgetlocaltime}\\
 \helpref{wxGetMousePosition}{wxgetmouseposition}\\


@@ -117,6 +125,7 @@ the corresponding topic.
 \helpref{wxGetOsDescription}{wxgetosdescription}\\
 \helpref{wxGetOsVersion}{wxgetosversion}\\
 \helpref{wxGetPasswordFromUser}{wxgetpasswordfromuser}\\
 \helpref{wxGetOsDescription}{wxgetosdescription}\\
 \helpref{wxGetOsVersion}{wxgetosversion}\\
 \helpref{wxGetPasswordFromUser}{wxgetpasswordfromuser}\\

+\helpref{wxGetPowerType}{wxgetpowertype}\\

 \helpref{wxGetPrinterCommand}{wxgetprintercommand}\\
 \helpref{wxGetPrinterFile}{wxgetprinterfile}\\
 \helpref{wxGetPrinterMode}{wxgetprintermode}\\
 \helpref{wxGetPrinterCommand}{wxgetprintercommand}\\
 \helpref{wxGetPrinterFile}{wxgetprinterfile}\\
 \helpref{wxGetPrinterMode}{wxgetprintermode}\\


@@ -172,6 +181,8 @@ the corresponding topic.
 \helpref{wxMakeMetafilePlaceable}{wxmakemetafileplaceable}\\
 \helpref{wxMatchWild}{wxmatchwild}\\
 \helpref{wxMessageBox}{wxmessagebox}\\
 \helpref{wxMakeMetafilePlaceable}{wxmakemetafileplaceable}\\
 \helpref{wxMatchWild}{wxmatchwild}\\
 \helpref{wxMessageBox}{wxmessagebox}\\

+\helpref{wxMilliSleep}{wxmillisleep}\\
+\helpref{wxMicroSleep}{wxmicrosleep}\\

 \helpref{wxMkdir}{wxmkdir}\\
 \helpref{wxMutexGuiEnter}{wxmutexguienter}\\
 \helpref{wxMutexGuiLeave}{wxmutexguileave}\\
 \helpref{wxMkdir}{wxmkdir}\\
 \helpref{wxMutexGuiEnter}{wxmutexguienter}\\
 \helpref{wxMutexGuiLeave}{wxmutexguileave}\\


@@ -179,6 +190,7 @@ the corresponding topic.
 \helpref{wxNow}{wxnow}\\
 \helpref{wxOnAssert}{wxonassert}\\
 \helpref{wxOpenClipboard}{wxopenclipboard}\\
 \helpref{wxNow}{wxnow}\\
 \helpref{wxOnAssert}{wxonassert}\\
 \helpref{wxOpenClipboard}{wxopenclipboard}\\

+\helpref{wxParseCommonDialogsFilter}{wxparsecommondialogsfilter}\\

 \helpref{wxPathOnly}{wxpathonly}\\
 \helpref{wxPostDelete}{wxpostdelete}\\
 \helpref{wxPostEvent}{wxpostevent}\\
 \helpref{wxPathOnly}{wxpathonly}\\
 \helpref{wxPostDelete}{wxpostdelete}\\
 \helpref{wxPostEvent}{wxpostevent}\\


@@ -219,54 +231,74 @@ the corresponding topic.
 \helpref{wxSysErrorCode}{wxsyserrorcode}\\
 \helpref{wxSysErrorMsg}{wxsyserrormsg}\\
 \helpref{wxT}{wxt}\\
 \helpref{wxSysErrorCode}{wxsyserrorcode}\\
 \helpref{wxSysErrorMsg}{wxsyserrormsg}\\
 \helpref{wxT}{wxt}\\

-\helpref{wxToLower}{wxtolower}\\
-\helpref{wxToUpper}{wxtoupper}\\

 \helpref{wxTraceLevel}{wxtracelevel}\\
 \helpref{wxTrace}{wxtrace}\\
 \helpref{wxTransferFileToStream}{wxtransferfiletostream}\\
 \helpref{wxTransferStreamToFile}{wxtransferstreamtofile}\\
 \helpref{wxTrap}{wxtrap}\\
 \helpref{wxTraceLevel}{wxtracelevel}\\
 \helpref{wxTrace}{wxtrace}\\
 \helpref{wxTransferFileToStream}{wxtransferfiletostream}\\
 \helpref{wxTransferStreamToFile}{wxtransferstreamtofile}\\
 \helpref{wxTrap}{wxtrap}\\

+\helpref{wxULL}{wxull}\\

 \helpref{wxUninitialize}{wxuninitialize}\\
 \helpref{wxUnix2DosFilename}{wxunix2dosfilename}\\
 \helpref{wxUnsetEnv}{wxunsetenv}\\
 \helpref{wxUsleep}{wxusleep}\\
 \helpref{wxUninitialize}{wxuninitialize}\\
 \helpref{wxUnix2DosFilename}{wxunix2dosfilename}\\
 \helpref{wxUnsetEnv}{wxunsetenv}\\
 \helpref{wxUsleep}{wxusleep}\\

+\helpref{wxVaCopy}{wxvacopy}\\

 \helpref{wxVsnprintf}{wxvsnprintf}\\
 \helpref{wxWakeUpIdle}{wxwakeupidle}\\
 \helpref{wxWriteResource}{wxwriteresource}\\
 \helpref{wxYield}{wxyield}\\
 \helpref{wxVsnprintf}{wxvsnprintf}\\
 \helpref{wxWakeUpIdle}{wxwakeupidle}\\
 \helpref{wxWriteResource}{wxwriteresource}\\
 \helpref{wxYield}{wxyield}\\

+\helpref{wx\_const\_cast}{wxconstcastraw}\\
+\helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw}\\
+\helpref{wx\_static\_cast}{wxstaticcastraw}\\

 \helpref{\_}{underscore}\\
 \helpref{\_T}{underscoret}
 
 \helpref{\_}{underscore}\\
 \helpref{\_T}{underscoret}
 

+
+

 \section{Version macros}\label{versionfunctions}
 
 \section{Version macros}\label{versionfunctions}
 

-The following constants are defined in wxWindows:
+The following constants are defined in wxWidgets:

 
 \begin{itemize}\itemsep=0pt
 
 \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 wxMAJOR\_VERSION} is the major version of wxWidgets
+\item {\tt wxMINOR\_VERSION} is the minor version of wxWidgets

 \item {\tt wxRELEASE\_NUMBER} is the release number
 \item {\tt wxRELEASE\_NUMBER} is the release number

+\item {\tt wxSUBRELEASE\_NUMBER} is the subrelease number which is $0$ for all
+official releases

 \end{itemize}
 
 \end{itemize}
 

-For example, the values or these constants for wxWindows 2.1.15 are 2, 1 and
+For example, the values or these constants for wxWidgets 2.1.15 are 2, 1 and

 15.
 
 Additionally, {\tt wxVERSION\_STRING} is a user-readable string containing
 15.
 
 Additionally, {\tt wxVERSION\_STRING} is a user-readable string containing

-the full wxWindows version and {\tt wxVERSION\_NUMBER} is a combination of the
+the full wxWidgets 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
 three version numbers above: for 2.1.15, it is 2115 and it is 2200 for

-wxWindows 2.2.
+wxWidgets 2.2.
+
+The subrelease number is only used for the sources in between official releases
+and so normally is not useful.

 
 \wxheading{Include files}
 
 <wx/version.h> or <wx/defs.h>
 
 
 \wxheading{Include files}
 
 <wx/version.h> or <wx/defs.h>
 

+
+\membersection{wxCHECK\_GCC\_VERSION}\label{wxcheckgccversion}
+
+\func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor, release}}
+
+Returns $1$ if the compiler being used to compile the code is GNU C++
+compiler (g++) version major.minor.release or greater. Otherwise, and also if
+the compiler is not GNU C++ at all, returns $0$.
+
+

 \membersection{wxCHECK\_VERSION}\label{wxcheckversion}
 
 \func{bool}{wxCHECK\_VERSION}{\param{}{major, minor, release}}
 
 \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
+This is a macro which evaluates to true if the current wxWidgets version is at

 least major.minor.release.
 
 least major.minor.release.
 

-For example, to test if the program is compiled with wxWindows 2.2 or higher,
+For example, to test if the program is compiled with wxWidgets 2.2 or higher,

 the following can be done:
 
 \begin{verbatim}
 the following can be done:
 
 \begin{verbatim}


@@ -281,13 +313,14 @@ the following can be done:
     }
 \end{verbatim}
 
     }
 \end{verbatim}
 

-\membersection{wxCHECK\_GCC\_VERSION}\label{wxcheckgccversion}

 
 

-\func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor, release}}
+\membersection{wxCHECK\_VERSION\_FULL}\label{wxcheckversionfull}
+
+\func{bool}{wxCHECK\_VERSION\_FULL}{\param{}{major, minor, release, subrel}}
+
+Same as \helpref{wxCHECK\_VERSION}{wxcheckversion} but also checks that
+\texttt{wxSUBRELEASE\_NUMBER} is at least \arg{subrel}.

 
 

-Returns $1$ if the compiler being used to compile the code is GNU C++
-compiler (g++) version major.minor.release or greater. Otherwise, and also if
-the compiler is not GNU C++ at all, returns $0$.

 
 \membersection{wxCHECK\_W32API\_VERSION}\label{wxcheckw32apiversion}
 
 
 \membersection{wxCHECK\_W32API\_VERSION}\label{wxcheckw32apiversion}
 


@@ -297,38 +330,41 @@ Returns $1$ if the version of w32api headers used is major.minor.release or
 greater. Otherwise, and also if we are not compiling with mingw32/cygwin under
 Win32 at all, returns $0$.
 
 greater. Otherwise, and also if we are not compiling with mingw32/cygwin under
 Win32 at all, returns $0$.
 

+
+

 \section{Application initialization and termination}\label{appinifunctions}
 
 The functions in this section are used on application startup/shutdown and also
 to control the behaviour of the main event loop of the GUI programs.
 
 \section{Application initialization and termination}\label{appinifunctions}
 
 The functions in this section are used on application startup/shutdown and also
 to control the behaviour of the main event loop of the GUI programs.
 

+

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

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

-wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is false, the
-function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
+wxWidgets initialization under Windows (non-DLL). If {\it enterLoop} is false, the
+function will return immediately after calling wxApp::OnInit. Otherwise, the wxWidgets

 message loop will be entered.
 
 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
  \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
 
 message loop will be entered.
 
 \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
  \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
 

-wxWindows initialization under Windows (for applications constructed as a DLL).
+wxWidgets initialization under Windows (for applications constructed as a DLL).

 
 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
 
 
 \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
 

-wxWindows initialization under Unix.
+wxWidgets initialization under Unix.

 
 \wxheading{Remarks}
 
 
 \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:
+To clean up wxWidgets, call wxApp::OnExit followed by the static function
+wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWidgets:

 
 \begin{verbatim}
 int CTheApp::ExitInstance()
 
 \begin{verbatim}
 int CTheApp::ExitInstance()


@@ -346,11 +382,12 @@ int CTheApp::ExitInstance()
 <wx/app.h>
 
 
 <wx/app.h>
 
 

+

 \membersection{::wxGetApp}\label{wxgetapp}
 
 \func{wxAppDerivedClass\&}{wxGetApp}{\void}
 
 \membersection{::wxGetApp}\label{wxgetapp}
 
 \func{wxAppDerivedClass\&}{wxGetApp}{\void}
 

-This function doesn't exist in wxWindows but it is created by using
+This function doesn't exist in wxWidgets but it is created by using

 the \helpref{IMPLEMENT\_APP}{implementapp} macro. Thus, before using it
 anywhere but in the same module where this macro is used, you must make it
 available using \helpref{DECLARE\_APP}{declareapp}.
 the \helpref{IMPLEMENT\_APP}{implementapp} macro. Thus, before using it
 anywhere but in the same module where this macro is used, you must make it
 available using \helpref{DECLARE\_APP}{declareapp}.


@@ -360,6 +397,7 @@ wxTheApp pointer is that the latter is of type {\tt wxApp *} and so wouldn't
 allow you to access the functions specific to your application class but not
 present in wxApp while wxGetApp() returns the object of the right type.
 
 allow you to access the functions specific to your application class but not
 present in wxApp while wxGetApp() returns the object of the right type.
 

+

 \membersection{::wxHandleFatalExceptions}\label{wxhandlefatalexceptions}
 
 \func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = true}}
 \membersection{::wxHandleFatalExceptions}\label{wxhandlefatalexceptions}
 
 \func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = true}}


@@ -372,6 +410,7 @@ 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.
 
 Calling wxHandleFatalExceptions() with {\it doIt} equal to false will restore
 this default behaviour.
 

+

 \membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
 
 \func{void}{wxInitAllImageHandlers}{\void}
 \membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
 
 \func{void}{wxInitAllImageHandlers}{\void}


@@ -387,13 +426,14 @@ see \helpref{wxImage}{wximage}.
 
 <wx/image.h>
 
 
 <wx/image.h>
 

+

 \membersection{::wxInitialize}\label{wxinitialize}
 
 \func{bool}{wxInitialize}{\void}
 
 This function is used in wxBase only and only if you don't create
 \helpref{wxApp}{wxapp} object at all. In this case you must call it from your
 \membersection{::wxInitialize}\label{wxinitialize}
 
 \func{bool}{wxInitialize}{\void}
 
 This function is used in wxBase only and only if you don't create
 \helpref{wxApp}{wxapp} object at all. In this case you must call it from your

-{\tt main()} function before calling any other wxWindows functions.
+{\tt main()} function before calling any other wxWidgets functions.

 
 If the function returns {\tt false} the initialization could not be performed,
 in this case the library cannot be used and
 
 If the function returns {\tt false} the initialization could not be performed,
 in this case the library cannot be used and


@@ -407,6 +447,7 @@ call to this function.
 
 <wx/app.h>
 
 
 <wx/app.h>
 

+

 \membersection{::wxSafeYield}\label{wxsafeyield}
 
 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}, \param{bool}{
 \membersection{::wxSafeYield}\label{wxsafeyield}
 
 \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}, \param{bool}{


@@ -423,6 +464,7 @@ Returns the result of the call to \helpref{::wxYield}{wxyield}.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{::wxUninitialize}\label{wxuninitialize}
 
 \func{void}{wxUninitialize}{\void}
 \membersection{::wxUninitialize}\label{wxuninitialize}
 
 \func{void}{wxUninitialize}{\void}


@@ -434,6 +476,7 @@ once for each previous successful call to \helpref{wxInitialize}{wxinitialize}.
 
 <wx/app.h>
 
 
 <wx/app.h>
 

+

 \membersection{::wxYield}\label{wxyield}
 
 \func{bool}{wxYield}{\void}
 \membersection{::wxYield}\label{wxyield}
 
 \func{bool}{wxYield}{\void}


@@ -447,6 +490,7 @@ the \helpref{wxApp::Yield}{wxappyield} method instead in any new code.
 
 <wx/app.h> or <wx/utils.h>
 
 
 <wx/app.h> or <wx/utils.h>
 

+

 \membersection{::wxWakeUpIdle}\label{wxwakeupidle}
 
 \func{void}{wxWakeUpIdle}{\void}
 \membersection{::wxWakeUpIdle}\label{wxwakeupidle}
 
 \func{void}{wxWakeUpIdle}{\void}


@@ -462,11 +506,14 @@ the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and
 
 <wx/event.h>
 
 
 <wx/event.h>
 

+
+

 \section{Process control functions}\label{processfunctions}
 
 The functions in this section are used to launch or terminate the other
 processes.
 
 \section{Process control functions}\label{processfunctions}
 
 The functions in this section are used to launch or terminate the other
 processes.
 

+

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


@@ -477,16 +524,16 @@ processes.
 
 \perlnote{In wxPerl this function is called \texttt{Wx::ExecuteArgs}}
 
 
 \perlnote{In wxPerl this function is called \texttt{Wx::ExecuteArgs}}
 

-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{int }{flags = 0}}

 
 \perlnote{In wxPerl this function is called \texttt{Wx::ExecuteStdout} and it
 only takes the {\tt command} argument,
 and returns a 2-element list {\tt ( status, output )}, where {\tt output} is
 an array reference.}
 
 
 \perlnote{In wxPerl this function is called \texttt{Wx::ExecuteStdout} and it
 only takes the {\tt command} argument,
 and returns a 2-element list {\tt ( status, output )}, where {\tt output} is
 an array reference.}
 

-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}}
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}, \param{int }{flags = 0}}

 
 

-\perlnote{In wxPerl this function is called \texttt{Wx::ExecuteStdoutStderr} 
+\perlnote{In wxPerl this function is called \texttt{Wx::ExecuteStdoutStderr}

 and it only takes the {\tt command} argument,
 and returns a 3-element list {\tt ( status, output, errors )}, where
 {\tt output} and {\tt errors} are array references.}
 and it only takes the {\tt command} argument,
 and returns a 3-element list {\tt ( status, output, errors )}, where
 {\tt output} and {\tt errors} are array references.}


@@ -509,9 +556,12 @@ In the case of synchronous execution, the return value is the 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. Also, while waiting for the process to
 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
-should ensure that this can cause no recursion, in the simplest case by
-calling \helpref{wxEnableTopLevelWindows(false)}{wxenabletoplevelwindows}.
+terminate, wxExecute will call \helpref{wxYield}{wxyield}. Because of this, by
+default this function disables all application windows to avoid unexpected
+reentrancies which could result from the users interaction with the program
+while the child process is running. If you are sure that it is safe to not
+disable the program windows, you may pass \texttt{wxEXEC\_NODISABLE} flag to
+prevent this automatic disabling from happening.

 
 For asynchronous execution, however, the return value is the process id and
 zero value indicates that the command could not be executed. As an added
 
 For asynchronous execution, however, the return value is the process id and
 zero value indicates that the command could not be executed. As an added


@@ -533,14 +583,15 @@ happening, i.e. with this flag the child process window will be shown normally.
 
 Under Unix the flag {\tt wxEXEC\_MAKE\_GROUP\_LEADER} may be used to ensure
 that the new process is a group leader (this will create a new session if
 
 Under Unix the flag {\tt wxEXEC\_MAKE\_GROUP\_LEADER} may be used to ensure
 that the new process is a group leader (this will create a new session if

-needed). Calling \helpref{wxKill}{wxkill} with the argument of -pid where pid
-is the process ID of the new process will kill this process as well as all of
-its children (except those which have started their own session).
+needed). Calling \helpref{wxKill}{wxkill} passing wxKILL\_CHILDREN will
+will kill this process as well as all of its children (except those which have
+started their own session).

 
 Finally, you may use the third overloaded version of this function to execute
 
 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.
+a process (always synchronously, the contents of \arg{flags} is or'd with
+\texttt{wxEXEC\_SYNC}) and capture its output in the array \arg{output}. The
+fourth version adds the possibility to additionally capture the messages from
+standard error output in the \arg{errors} array.

 
 {\bf NB:} Currently wxExecute() can only be used from the main thread, calling
 this function from another thread will result in an assert failure in debug
 
 {\bf NB:} Currently wxExecute() can only be used from the main thread, calling
 this function from another thread will result in an assert failure in debug


@@ -559,7 +610,7 @@ single string.}
 array, any additional ones are the command parameters and the array must be
 terminated with a NULL pointer.}
 
 array, any additional ones are the command parameters and the array must be
 terminated with a NULL pointer.}
 

-\docparam{flags}{Combination of bit masks {\tt wxEXEC\_ASYNC},
+\docparam{flags}{Combination of bit masks {\tt wxEXEC\_ASYNC},\rtfsp

 {\tt wxEXEC\_SYNC} and {\tt wxEXEC\_NOHIDE}}
 
 \docparam{callback}{An optional pointer to \helpref{wxProcess}{wxprocess}}
 {\tt wxEXEC\_SYNC} and {\tt wxEXEC\_NOHIDE}}
 
 \docparam{callback}{An optional pointer to \helpref{wxProcess}{wxprocess}}


@@ -568,6 +619,7 @@ terminated with a NULL pointer.}
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

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


@@ -581,9 +633,10 @@ application. See \helpref{wxCloseEvent}{wxcloseevent} and \helpref{wxApp}{wxapp}
 
 <wx/app.h>
 
 
 <wx/app.h>
 

+

 \membersection{::wxKill}\label{wxkill}
 
 \membersection{::wxKill}\label{wxkill}
 

-\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}}
+\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}, \param{int }{flags = 0}}

 
 Equivalent to the Unix kill function: send the given signal {\it sig} to the
 process with PID {\it pid}. The valid signal values are
 
 Equivalent to the Unix kill function: send the given signal {\it sig} to the
 process with PID {\it pid}. The valid signal values are


@@ -628,6 +681,12 @@ enum wxKillError
 };
 \end{verbatim}
 
 };
 \end{verbatim}
 

+The {\it flags} parameter can be wxKILL\_NOCHILDREN (the default),
+or wxKILL\_CHILDREN, in which case the child processes of this
+process will be killed too. Note that under Unix, for wxKILL\_CHILDREN
+to work you should have created the process by passing wxEXEC\_MAKE\_GROUP\_LEADER
+to wxExecute.
+

 \wxheading{See also}
 
 \helpref{wxProcess::Kill}{wxprocesskill},\rtfsp
 \wxheading{See also}
 
 \helpref{wxProcess::Kill}{wxprocesskill},\rtfsp


@@ -638,6 +697,7 @@ enum wxKillError
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{::wxGetProcessId}\label{wxgetprocessid}
 
 \func{unsigned long}{wxGetProcessId}{\void}
 \membersection{::wxGetProcessId}\label{wxgetprocessid}
 
 \func{unsigned long}{wxGetProcessId}{\void}


@@ -650,6 +710,7 @@ If an error occurs, $0$ is returned.
 
 <wx/utils.h>
 
 
 <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}}


@@ -663,6 +724,7 @@ See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{::wxShutdown}\label{wxshutdown}
 
 \func{bool}{wxShutdown}{\param{wxShutdownFlags}{flags}}
 \membersection{::wxShutdown}\label{wxshutdown}
 
 \func{bool}{wxShutdown}{\param{wxShutdownFlags}{flags}}


@@ -684,6 +746,8 @@ and that this function is only implemented under Unix and Win32.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+
+

 \section{Thread functions}\label{threadfunctions}
 
 The functions and macros here mainly exist to make it writing the code which
 \section{Thread functions}\label{threadfunctions}
 
 The functions and macros here mainly exist to make it writing the code which


@@ -705,39 +769,43 @@ to create and use the critical section only when needed.
 \helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}, \helpref{Multithreading overview}{wxthreadoverview}
 
 
 \helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}, \helpref{Multithreading overview}{wxthreadoverview}
 
 

+

 \membersection{wxCRIT\_SECT\_DECLARE}\label{wxcritsectdeclare}
 
 \func{}{wxCRIT\_SECT\_DECLARE}{\param{}{cs}}
 
 \membersection{wxCRIT\_SECT\_DECLARE}\label{wxcritsectdeclare}
 
 \func{}{wxCRIT\_SECT\_DECLARE}{\param{}{cs}}
 

-This macro declares a (static) critical section object named {\it cs} if 
+This macro declares a (static) critical section object named {\it cs} if

 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
 
 
 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
 
 

+

 \membersection{wxCRIT\_SECT\_DECLARE\_MEMBER}\label{wxcritsectdeclaremember}
 
 \func{}{wxCRIT\_SECT\_DECLARE}{\param{}{cs}}
 
 \membersection{wxCRIT\_SECT\_DECLARE\_MEMBER}\label{wxcritsectdeclaremember}
 
 \func{}{wxCRIT\_SECT\_DECLARE}{\param{}{cs}}
 

-This macro declares a critical section object named {\it cs} if 
+This macro declares a critical section object named {\it cs} if

 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. As it doesn't
 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. As it doesn't

-include the {\tt static} keyword (unlike 
+include the {\tt static} keyword (unlike

 \helpref{wxCRIT\_SECT\_DECLARE}{wxcritsectdeclare}), it can be used to declare
 a class or struct member which explains its name.
 
 
 \helpref{wxCRIT\_SECT\_DECLARE}{wxcritsectdeclare}), it can be used to declare
 a class or struct member which explains its name.
 
 

+

 \membersection{wxCRIT\_SECT\_LOCKER}\label{wxcritsectlocker}
 
 \func{}{wxCRIT\_SECT\_LOCKER}{\param{}{name}, \param{}{cs}}
 
 \membersection{wxCRIT\_SECT\_LOCKER}\label{wxcritsectlocker}
 
 \func{}{wxCRIT\_SECT\_LOCKER}{\param{}{name}, \param{}{cs}}
 

-This macro creates a \helpref{critical section lock}{wxcriticalsectionlocker} 
-object named {\it name} and associated with the critical section {\it cs} if 
+This macro creates a \helpref{critical section lock}{wxcriticalsectionlocker}
+object named {\it name} and associated with the critical section {\it cs} if

 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
 
 
 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
 
 

+

 \membersection{wxCRITICAL\_SECTION}\label{wxcriticalsectionmacro}
 
 \func{}{wxCRITICAL\_SECTION}{\param{}{name}}
 
 \membersection{wxCRITICAL\_SECTION}\label{wxcriticalsectionmacro}
 
 \func{}{wxCRITICAL\_SECTION}{\param{}{name}}
 

-This macro combines \helpref{wxCRIT\_SECT\_DECLARE}{wxcritsectdeclare} and 
+This macro combines \helpref{wxCRIT\_SECT\_DECLARE}{wxcritsectdeclare} and

 \helpref{wxCRIT\_SECT\_LOCKER}{wxcritsectlocker}: it creates a static critical
 section object and also the lock object associated with it. Because of this, it
 can be only used inside a function, not at global scope. For example:
 \helpref{wxCRIT\_SECT\_LOCKER}{wxcritsectlocker}: it creates a static critical
 section object and also the lock object associated with it. Because of this, it
 can be only used inside a function, not at global scope. For example:


@@ -755,10 +823,11 @@ int IncCount()
 
 (note that we suppose that the function is called the first time from the main
 thread so that the critical section object is initialized correctly by the time
 
 (note that we suppose that the function is called the first time from the main
 thread so that the critical section object is initialized correctly by the time

-other threads start calling it, if this is not the case this approach can 
+other threads start calling it, if this is not the case this approach can

 {\bf not} be used and the critical section must be made a global instead).
 
 
 {\bf not} be used and the critical section must be made a global instead).
 
 

+

 \membersection{wxENTER\_CRIT\_SECT}\label{wxentercritsect}
 
 \func{}{wxENTER\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}}
 \membersection{wxENTER\_CRIT\_SECT}\label{wxentercritsect}
 
 \func{}{wxENTER\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}}


@@ -767,6 +836,7 @@ This macro is equivalent to \helpref{cs.Enter()}{wxcriticalsectionenter} if
 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
 
 
 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
 
 

+

 \membersection{::wxIsMainThread}\label{wxismainthread}
 
 \func{bool}{wxIsMainThread}{\void}
 \membersection{::wxIsMainThread}\label{wxismainthread}
 
 \func{bool}{wxIsMainThread}{\void}


@@ -775,6 +845,7 @@ Returns {\tt true} if this thread is the main one. Always returns {\tt true} if
 {\tt wxUSE\_THREADS} is $0$.
 
 
 {\tt wxUSE\_THREADS} is $0$.
 
 

+

 \membersection{wxLEAVE\_CRIT\_SECT}\label{wxleavecritsect}
 
 \func{}{wxLEAVE\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}}
 \membersection{wxLEAVE\_CRIT\_SECT}\label{wxleavecritsect}
 
 \func{}{wxLEAVE\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}}


@@ -783,6 +854,7 @@ This macro is equivalent to \helpref{cs.Leave()}{wxcriticalsectionleave} if
 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
 
 
 {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
 
 

+

 \membersection{::wxMutexGuiEnter}\label{wxmutexguienter}
 
 \func{void}{wxMutexGuiEnter}{\void}
 \membersection{::wxMutexGuiEnter}\label{wxmutexguienter}
 
 \func{void}{wxMutexGuiEnter}{\void}


@@ -816,6 +888,7 @@ thread but the main one.
 This function is only defined on platforms which support preemptive
 threads.
 
 This function is only defined on platforms which support preemptive
 threads.
 

+

 \membersection{::wxMutexGuiLeave}\label{wxmutexguileave}
 
 \func{void}{wxMutexGuiLeave}{\void}
 \membersection{::wxMutexGuiLeave}\label{wxmutexguileave}
 
 \func{void}{wxMutexGuiLeave}{\void}


@@ -825,11 +898,13 @@ See \helpref{::wxMutexGuiEnter()}{wxmutexguienter}.
 This function is only defined on platforms which support preemptive
 threads.
 
 This function is only defined on platforms which support preemptive
 threads.
 

+
+

 \section{File functions}\label{filefunctions}
 
 \wxheading{Include files}
 
 \section{File functions}\label{filefunctions}
 
 \wxheading{Include files}
 

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

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


@@ -838,12 +913,14 @@ threads.
 \helpref{wxFile}{wxfile}\\
 \helpref{wxFileName}{wxfilename}
 
 \helpref{wxFile}{wxfile}\\
 \helpref{wxFileName}{wxfilename}
 

+

 \membersection{::wxDirExists}\label{functionwxdirexists}
 
 \func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
 
 Returns true if the directory exists.
 
 \membersection{::wxDirExists}\label{functionwxdirexists}
 
 \func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
 
 Returns true if the directory exists.
 

+

 \membersection{::wxDos2UnixFilename}\label{wxdos2unixfilename}
 
 \func{void}{wxDos2UnixFilename}{\param{wxChar *}{s}}
 \membersection{::wxDos2UnixFilename}\label{wxdos2unixfilename}
 
 \func{void}{wxDos2UnixFilename}{\param{wxChar *}{s}}


@@ -851,12 +928,13 @@ Returns true if the directory exists.
 Converts a DOS to a Unix filename by replacing backslashes with forward
 slashes.
 
 Converts a DOS to a Unix filename by replacing backslashes with forward
 slashes.
 

+

 \membersection{::wxFileExists}\label{functionwxfileexists}
 
 \func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
 
 \membersection{::wxFileExists}\label{functionwxfileexists}
 
 \func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
 

-Returns true if the file exists. It also returns true if the file is
-a directory.
+Returns true if the file exists and is a plain file.
+

 
 \membersection{::wxFileModificationTime}\label{wxfilemodificationtime}
 
 
 \membersection{::wxFileModificationTime}\label{wxfilemodificationtime}
 


@@ -864,6 +942,7 @@ a directory.
 
 Returns time of last modification of given file.
 
 
 Returns time of last modification of given file.
 

+

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


@@ -876,6 +955,7 @@ Returns time of last modification of given file.
 Returns the filename for a full path. The second form returns a pointer to
 temporary storage that should not be deallocated.
 
 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}
 
 \func{wxString}{wxFindFirstFile}{\param{const char *}{spec}, \param{int}{ flags = 0}}
 \membersection{::wxFindFirstFile}\label{wxfindfirstfile}
 
 \func{wxString}{wxFindFirstFile}{\param{const char *}{spec}, \param{int}{ flags = 0}}


@@ -885,6 +965,10 @@ that matches the path {\it spec}, or the empty string. Use \helpref{wxFindNextFi
 get the next matching file. Neither will report the current directory "." or the
 parent directory "..".
 
 get the next matching file. Neither will report the current directory "." or the
 parent directory "..".
 

+\wxheading{Warning}
+
+As of wx 2.5.2, these functions are not thread-safe! (use static variables)
+

 {\it spec} may contain wildcards.
 
 {\it flags} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
 {\it spec} may contain wildcards.
 
 {\it flags} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.


@@ -893,13 +977,14 @@ For example:
 
 \begin{verbatim}
   wxString f = wxFindFirstFile("/home/project/*.*");
 
 \begin{verbatim}
   wxString f = wxFindFirstFile("/home/project/*.*");

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

   {
     ...
     f = wxFindNextFile();
   }
 \end{verbatim}
 
   {
     ...
     f = wxFindNextFile();
   }
 \end{verbatim}
 

+

 \membersection{::wxFindNextFile}\label{wxfindnextfile}
 
 \func{wxString}{wxFindNextFile}{\void}
 \membersection{::wxFindNextFile}\label{wxfindnextfile}
 
 \func{wxString}{wxFindNextFile}{\void}


@@ -908,6 +993,7 @@ Returns the next file that matches the path passed to \helpref{wxFindFirstFile}{
 
 See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example.
 
 
 See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example.
 

+

 \membersection{::wxGetDiskSpace}\label{wxgetdiskspace}
 
 \func{bool}{wxGetDiskSpace}{\param{const wxString\& }{path}, \param{wxLongLong }{*total = NULL}, \param{wxLongLong }{*free = NULL}}
 \membersection{::wxGetDiskSpace}\label{wxgetdiskspace}
 
 \func{bool}{wxGetDiskSpace}{\param{const wxString\& }{path}, \param{wxLongLong }{*total = NULL}, \param{wxLongLong }{*free = NULL}}


@@ -924,10 +1010,35 @@ directory doesn't exist).
 
 \wxheading{Portability}
 
 
 \wxheading{Portability}
 

-This function is implemented for Win16 (only for drives less than 2Gb), Win32,
+This function is implemented for Win32,

 Mac OS and generic Unix provided the system has {\tt statfs()} function.
 
 Mac OS and generic Unix provided the system has {\tt statfs()} function.
 

-This function first appeared in wxWindows 2.3.2.
+This function first appeared in wxWidgets 2.3.2.
+
+
+\membersection{::wxGetFileType}\label{wxgetfiletype}
+
+\func{wxFileTypeEnum}{wxGetFileType}{\param{int }{fd}}
+
+\func{wxFileTypeEnum}{wxGetFileType}{\param{FILE *}{fp}}
+
+Returns the type of an open file. Possible return values are:
+
+\begin{verbatim}
+enum wxFileTypeEnum
+{
+  wxFILE_TYPE_UNKNOWN,
+  wxFILE_TYPE_DISK,     // a file supporting seeking to arbitrary offsets
+  wxFILE_TYPE_TERMINAL, // a tty
+  wxFILE_TYPE_PIPE      // a pipe
+};
+
+\end{verbatim}
+
+\wxheading{Include files}
+
+<wx/filefn.h>
+

 
 \membersection{::wxGetOSDirectory}\label{wxgetosdirectory}
 
 
 \membersection{::wxGetOSDirectory}\label{wxgetosdirectory}
 


@@ -935,6 +1046,7 @@ This function first appeared in wxWindows 2.3.2.
 
 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{::wxIsAbsolutePath}\label{wxisabsolutepath}
 
 \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
 \membersection{::wxIsAbsolutePath}\label{wxisabsolutepath}
 
 \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}


@@ -942,12 +1054,14 @@ Returns the Windows directory under Windows; on other platforms returns the empt
 Returns true if the argument is an absolute filename, i.e. with a slash
 or drive name at the beginning.
 
 Returns true if the argument is an absolute filename, i.e. with a slash
 or drive name at the beginning.
 

+

 \membersection{::wxPathOnly}\label{wxpathonly}
 
 \func{wxString}{wxPathOnly}{\param{const wxString\& }{path}}
 
 Returns the directory part of the filename.
 
 \membersection{::wxPathOnly}\label{wxpathonly}
 
 \func{wxString}{wxPathOnly}{\param{const wxString\& }{path}}
 
 Returns the directory part of the filename.
 

+

 \membersection{::wxUnix2DosFilename}\label{wxunix2dosfilename}
 
 \func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}}
 \membersection{::wxUnix2DosFilename}\label{wxunix2dosfilename}
 
 \func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}}


@@ -955,6 +1069,19 @@ Returns the directory part of the filename.
 Converts a Unix to a DOS filename by replacing forward
 slashes with backslashes.
 
 Converts a Unix to a DOS filename by replacing forward
 slashes with backslashes.
 

+
+\membersection{wxCHANGE\_UMASK}\label{wxchangeumask}
+
+\func{}{wxCHANGE\_UMASK}{\param{int }{mask}}
+
+Under Unix this macro changes the current process umask to the given value,
+unless it is equal to $-1$ in which case nothing is done, and restores it to
+the original value on scope exit. It works by declaring a variable which sets
+umask to \arg{mask} in its constructor and restores it in its destructor.
+
+Under other platforms this macro expands to nothing.
+
+

 \membersection{::wxConcatFiles}\label{wxconcatfiles}
 
 \func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2},
 \membersection{::wxConcatFiles}\label{wxconcatfiles}
 
 \func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2},


@@ -963,6 +1090,7 @@ slashes with backslashes.
 Concatenates {\it file1} and {\it file2} to {\it file3}, returning
 true if successful.
 
 Concatenates {\it file1} and {\it file2} to {\it file3}, returning
 true if successful.
 

+

 \membersection{::wxCopyFile}\label{wxcopyfile}
 
 \func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = true}}
 \membersection{::wxCopyFile}\label{wxcopyfile}
 
 \func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = true}}


@@ -972,12 +1100,14 @@ Copies {\it file1} to {\it file2}, returning true if successful. If
 if it exists, but if {\it overwrite} is false, the functions fails in this
 case.
 
 if it exists, but if {\it overwrite} is false, the functions fails in this
 case.
 

+

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

+

 \membersection{::wxGetWorkingDirectory}\label{wxgetworkingdirectory}
 
 \func{wxString}{wxGetWorkingDirectory}{\param{char *}{buf=NULL}, \param{int }{sz=1000}}
 \membersection{::wxGetWorkingDirectory}\label{wxgetworkingdirectory}
 
 \func{wxString}{wxGetWorkingDirectory}{\param{char *}{buf=NULL}, \param{int }{sz=1000}}


@@ -985,11 +1115,12 @@ Returns a string containing the current (or working) directory.
 {\bf NB:} This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.
 
 Copies the current working directory into the buffer if supplied, or
 {\bf NB:} 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)
-if the buffer is NULL.
+copies the working directory into new storage (which you {\emph must} delete
+yourself) if the buffer is NULL.

 
 {\it sz} is the size of the buffer if supplied.
 
 
 {\it sz} is the size of the buffer if supplied.
 

+

 \membersection{::wxGetTempFileName}\label{wxgettempfilename}
 
 \func{char *}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char *}{buf=NULL}}
 \membersection{::wxGetTempFileName}\label{wxgettempfilename}
 
 \func{char *}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char *}{buf=NULL}}


@@ -1010,40 +1141,60 @@ if the buffer is NULL.
 \helpref{wxFileName::CreateTempFileName}{wxfilenamecreatetempfilename}\rtfsp
 instead.
 
 \helpref{wxFileName::CreateTempFileName}{wxfilenamecreatetempfilename}\rtfsp
 instead.
 

+

 \membersection{::wxIsWild}\label{wxiswild}
 
 \func{bool}{wxIsWild}{\param{const wxString\& }{pattern}}
 
 Returns true if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}.
 
 \membersection{::wxIsWild}\label{wxiswild}
 
 \func{bool}{wxIsWild}{\param{const wxString\& }{pattern}}
 
 Returns true if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}.
 

+

 \membersection{::wxMatchWild}\label{wxmatchwild}
 
 \func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}}
 
 \membersection{::wxMatchWild}\label{wxmatchwild}
 
 \func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}}
 

-Returns true if the {\it pattern}\/ matches the {\it text}\/; if {\it
+Returns true if the \arg{pattern}\/ matches the {\it text}\/; if {\it

 dot\_special}\/ is true, filenames beginning with a dot are not matched
 with wildcard characters. See \helpref{wxIsWild}{wxiswild}.
 
 dot\_special}\/ is true, filenames beginning with a dot are not matched
 with wildcard characters. See \helpref{wxIsWild}{wxiswild}.
 

+

 \membersection{::wxMkdir}\label{wxmkdir}
 
 \func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}}
 
 \membersection{::wxMkdir}\label{wxmkdir}
 
 \func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}}
 

-Makes the directory {\it dir}, returning true if successful.
+Makes the directory \arg{dir}, returning true if successful.

 
 {\it perm} is the access mask for the directory for the systems on which it is
 supported (Unix) and doesn't have effect for the other ones.
 
 
 {\it perm} is the access mask for the directory for the systems on which it is
 supported (Unix) and doesn't have effect for the other ones.
 

+
+\membersection{::wxParseCommonDialogsFilter}\label{wxparsecommondialogsfilter}
+
+\func{int}{wxParseCommonDialogsFilter}{\param{const wxString\& }{wildCard}, \param{wxArrayString\& }{descriptions}, \param{wxArrayString\& }{filters}}
+
+Parses the \arg{wildCard}, returning the number of filters.
+Returns 0 if none or if there's a problem.
+The arrays will contain an equal number of items found before the error.
+On platforms where native dialogs handle only one filter per entry,
+entries in arrays are automatically adjusted.
+\arg{wildCard} is in the form:
+\begin{verbatim}
+ "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png"
+\end{verbatim}
+

 \membersection{::wxRemoveFile}\label{wxremovefile}
 
 \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
 
 \membersection{::wxRemoveFile}\label{wxremovefile}
 
 \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
 

-Removes {\it file}, returning true if successful.
+Removes \arg{file}, returning true if successful.
+

 
 \membersection{::wxRenameFile}\label{wxrenamefile}
 
 \func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
 
 
 \membersection{::wxRenameFile}\label{wxrenamefile}
 
 \func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
 

-Renames {\it file1} to {\it file2}, returning true if successful.
+Renames \arg{file1} to \arg{file2}, returning true if successful.
+

 
 \membersection{::wxRmdir}\label{wxrmdir}
 
 
 \membersection{::wxRmdir}\label{wxrmdir}
 


@@ -1053,6 +1204,7 @@ Removes the directory {\it dir}, returning true if successful. Does not work und
 
 The {\it flags} parameter is reserved for future use.
 
 
 The {\it flags} parameter is reserved for future use.
 

+

 \membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory}
 
 \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
 \membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory}
 
 \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}


@@ -1060,6 +1212,7 @@ 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{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
 \membersection{::wxSplitPath}\label{wxsplitfunction}
 
 \func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}


@@ -1084,6 +1237,7 @@ three of them may be empty if the corresponding component is. The old contents o
 strings pointed to by these parameters will be overwritten in any case (if the pointers
 are not NULL).
 
 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}}
 \membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
 
 \func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}


@@ -1095,6 +1249,7 @@ use streams (within the document/view framework, for example).
 
 <wx/docview.h>
 
 
 <wx/docview.h>
 

+

 \membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
 
 \func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
 \membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
 
 \func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}


@@ -1106,23 +1261,43 @@ use streams (within the document/view framework, for example).
 
 <wx/docview.h>
 
 
 <wx/docview.h>
 

+
+

 \section{Network, user and OS functions}\label{networkfunctions}
 
 The functions in this section are used to retrieve information about the
 current computer and/or user characteristics.
 
 \section{Network, user and OS functions}\label{networkfunctions}
 
 The functions in this section are used to retrieve information about the
 current computer and/or user characteristics.
 

+
+\membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
+
+\func{wxString}{wxGetEmailAddress}{\void}
+
+\func{bool}{wxGetEmailAddress}{\param{char * }{buf}, \param{int }{sz}}
+
+Copies the user's email address into the supplied buffer, by
+concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
+and \helpref{wxGetUserId}{wxgetuserid}.
+
+Returns true if successful, false otherwise.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+

 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
 
 \membersection{::wxGetFreeMemory}\label{wxgetfreememory}
 

-\func{long}{wxGetFreeMemory}{\void}
+\func{wxMemorySize}{wxGetFreeMemory}{\void}

 
 Returns the amount of free memory in bytes under environments which
 
 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.
+support it, and -1 if not supported or failed to perform measurement.

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

+

 \membersection{::wxGetFullHostName}\label{wxgetfullhostname}
 
 \func{wxString}{wxGetFullHostName}{\void}
 \membersection{::wxGetFullHostName}\label{wxgetfullhostname}
 
 \func{wxString}{wxGetFullHostName}{\void}


@@ -1138,19 +1313,6 @@ error.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
-
-\func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
-
-Copies the user's email address into the supplied buffer, by
-concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
-and \helpref{wxGetUserId}{wxgetuserid}.
-
-Returns true if successful, false otherwise.
-
-\wxheading{Include files}
-
-<wx/utils.h>

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


@@ -1166,6 +1328,7 @@ Return the (current) user's home directory.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{::wxGetHostName}\label{wxgethostname}
 
 \func{wxString}{wxGetHostName}{\void}
 \membersection{::wxGetHostName}\label{wxgethostname}
 
 \func{wxString}{wxGetHostName}{\void}


@@ -1178,7 +1341,7 @@ the domain name.
 
 Under Windows or NT, this function first looks in the environment
 variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp
 
 Under Windows or NT, this function first looks in the environment
 variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp

-in the {\bf wxWindows} section of the WIN.INI file is tried.
+in the {\bf wxWidgets} section of the WIN.INI file is tried.

 
 The first variant of this function returns the hostname if successful or an
 empty string otherwise. The second (deprecated) function returns true
 
 The first variant of this function returns the hostname if successful or an
 empty string otherwise. The second (deprecated) function returns true


@@ -1192,30 +1355,6 @@ if successful, false otherwise.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\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.
-something like "jsmith". It uniquely identifies the current user (on this system).
-
-Under Windows or NT, this function first looks in the environment
-variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp
-in the {\bf wxWindows} section of the WIN.INI file is tried.
-
-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.
-
-\wxheading{See also}
-
-\helpref{wxGetUserName}{wxgetusername}
-
-\wxheading{Include files}
-
-<wx/utils.h>

 
 \membersection{::wxGetOsDescription}\label{wxgetosdescription}
 
 
 \membersection{::wxGetOsDescription}\label{wxgetosdescription}
 


@@ -1233,6 +1372,7 @@ user-readable form. For example, this function may return strings like
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

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


@@ -1241,7 +1381,7 @@ Gets operating system version information.
 
 \begin{twocollist}\itemsep=0pt
 \twocolitemruled{Platform}{Return types}
 
 \begin{twocollist}\itemsep=0pt
 \twocolitemruled{Platform}{Return types}

-\twocolitem{Mac OS}{Return value is wxMAC when compiled with CodeWarrior under Mac OS 8.x/9.x and Mac OS X, wxMAC\_DARWIN when compiled with the Apple Developer Tools under Mac OS X. 
+\twocolitem{Mac OS}{Return value is wxMAC when compiled with CodeWarrior under Mac OS 8.x/9.x and Mac OS X, wxMAC\_DARWIN when compiled with the Apple Developer Tools under Mac OS X.

 
 Both {\it major} and {\it minor} have to be looked at as hexadecimal numbers. So System 10.2.4 returns 0x10, resp 16 for {\it major} and 0x24, resp 36 for {\it minor}. }
 \twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }
 
 Both {\it major} and {\it minor} have to be looked at as hexadecimal numbers. So System 10.2.4 returns 0x10, resp 16 for {\it major} and 0x24, resp 36 for {\it minor}. }
 \twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }


@@ -1263,6 +1403,7 @@ Both {\it major} and {\it minor} have to be looked at as hexadecimal numbers. So
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{::wxGetUserHome}\label{wxgetuserhome}
 
 \func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
 \membersection{::wxGetUserHome}\label{wxgetuserhome}
 
 \func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}


@@ -1275,6 +1416,33 @@ Returns the home directory for the given user. If the username is empty
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+
+\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.
+something like "jsmith". It uniquely identifies the current user (on this system).
+
+Under Windows or NT, this function first looks in the environment
+variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp
+in the {\bf wxWidgets} section of the WIN.INI file is tried.
+
+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.
+
+\wxheading{See also}
+
+\helpref{wxGetUserName}{wxgetusername}
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+

 \membersection{::wxGetUserName}\label{wxgetusername}
 
 \func{wxString}{wxGetUserName}{\void}
 \membersection{::wxGetUserName}\label{wxgetusername}
 
 \func{wxString}{wxGetUserName}{\void}


@@ -1284,7 +1452,7 @@ Returns the home directory for the given user. If the username is empty
 This function returns the full user name (something like "Mr. John Smith").
 
 Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp
 This function returns the full user name (something like "Mr. John Smith").
 
 Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp

-in the {\bf wxWindows} section of the WIN.INI file. If PenWindows
+in the {\bf wxWidgets} section of the WIN.INI file. If PenWindows

 is running, the entry {\bf Current} in the section {\bf User} of
 the PENWIN.INI file is used.
 
 is running, the entry {\bf Current} in the section {\bf User} of
 the PENWIN.INI file is used.
 


@@ -1300,7 +1468,10 @@ if successful, {\tt false} otherwise.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\section{String functions}
+
+
+\section{String functions}\label{stringfunctions}
+

 
 \membersection{::copystring}\label{copystring}
 
 
 \membersection{::copystring}\label{copystring}
 


@@ -1311,10 +1482,13 @@ deleted with the {\it delete} operator.
 
 This function is deprecated, use \helpref{wxString}{wxstring} class instead.
 
 
 This function is deprecated, use \helpref{wxString}{wxstring} class instead.
 

+

 \membersection{::wxGetTranslation}\label{wxgettranslation}
 
 \func{const char *}{wxGetTranslation}{\param{const char * }{str}}
 
 \membersection{::wxGetTranslation}\label{wxgettranslation}
 
 \func{const char *}{wxGetTranslation}{\param{const char * }{str}}
 

+\func{const char *}{wxGetTranslation}{\param{const char * }{str}, \param{const char * }{strPlural}, \param{size\_t }{n}}
+

 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{internationalization overview}{internationalization}), the
 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{internationalization overview}{internationalization}), the


@@ -1324,6 +1498,19 @@ is used very often, an alternative (and also common in Unix world) syntax is
 provided: the \helpref{\_()}{underscore} macro is defined to do the same thing
 as wxGetTranslation.
 
 provided: the \helpref{\_()}{underscore} macro is defined to do the same thing
 as wxGetTranslation.
 

+The second form is used when retrieving translation of string that has
+different singular and plural form in English or different plural forms in some
+other language. It takes two extra arguments: \arg{str}
+parameter must contain the singular form of the string to be converted.
+It is also used as the key for the search in the catalog.
+The \arg{strPlural} parameter is the plural form (in English).
+The parameter \arg{n} is used to determine the plural form.  If no
+message catalog is found \arg{str} is returned if `n == 1',
+otherwise \arg{strPlural}.
+See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150} for additional information on plural forms handling.
+
+Both versions call \helpref{wxLocale::GetString}{wxlocalegetstring}.
+

 \membersection{::wxIsEmpty}\label{wxisempty}
 
 \func{bool}{wxIsEmpty}{\param{const char *}{ p}}
 \membersection{::wxIsEmpty}\label{wxisempty}
 
 \func{bool}{wxIsEmpty}{\param{const char *}{ p}}


@@ -1331,6 +1518,7 @@ as wxGetTranslation.
 Returns {\tt true} if the pointer is either {\tt NULL} or points to an empty
 string, {\tt false} otherwise.
 
 Returns {\tt true} if the pointer is either {\tt NULL} or points to an empty
 string, {\tt false} otherwise.
 

+

 \membersection{::wxStrcmp}\label{wxstrcmp}
 
 \func{int}{wxStrcmp}{\param{const char *}{p1}, \param{const char *}{p2}}
 \membersection{::wxStrcmp}\label{wxstrcmp}
 
 \func{int}{wxStrcmp}{\param{const char *}{p1}, \param{const char *}{p2}}


@@ -1341,6 +1529,7 @@ to or greater than {\it p2}. The comparison is case-sensitive.
 This function complements the standard C function {\it stricmp()} which performs
 case-insensitive comparison.
 
 This function complements the standard C function {\it stricmp()} which performs
 case-insensitive comparison.
 

+

 \membersection{::wxStricmp}\label{wxstricmp}
 
 \func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}}
 \membersection{::wxStricmp}\label{wxstricmp}
 
 \func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}}


@@ -1351,6 +1540,7 @@ to or greater than {\it p2}. The comparison is case-insensitive.
 This function complements the standard C function {\it strcmp()} which performs
 case-sensitive comparison.
 
 This function complements the standard C function {\it strcmp()} which performs
 case-sensitive comparison.
 

+

 \membersection{::wxStringMatch}\label{wxstringmatch}
 
 \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
 \membersection{::wxStringMatch}\label{wxstringmatch}
 
 \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\


@@ -1362,6 +1552,7 @@ Returns {\tt true} if the substring {\it s1} is found within {\it s2},
 ignoring case if {\it exact} is false. If {\it subString} is {\tt false},
 no substring matching is done.
 
 ignoring case if {\it exact} is false. If {\it subString} is {\tt false},
 no substring matching is done.
 

+

 \membersection{::wxStringEq}\label{wxstringeq}
 
 \func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
 \membersection{::wxStringEq}\label{wxstringeq}
 
 \func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}


@@ -1374,6 +1565,7 @@ 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{::wxStrlen}\label{wxstrlen}
 
 \func{size\_t}{wxStrlen}{\param{const char *}{ p}}
 \membersection{::wxStrlen}\label{wxstrlen}
 
 \func{size\_t}{wxStrlen}{\param{const char *}{ p}}


@@ -1382,6 +1574,7 @@ 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 {\tt NULL} pointer.
 
 same thing (i.e. returns the length of the string) except that it returns 0 if
 {\it p} is the {\tt NULL} pointer.
 

+

 \membersection{::wxSnprintf}\label{wxsnprintf}
 
 \func{int}{wxSnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{}{...}}
 \membersection{::wxSnprintf}\label{wxsnprintf}
 
 \func{int}{wxSnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{}{...}}


@@ -1398,6 +1591,7 @@ enough space.
 
 \helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}
 
 
 \helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}
 

+

 \membersection{wxT}\label{wxt}
 
 \func{wxChar}{wxT}{\param{char }{ch}}
 \membersection{wxT}\label{wxt}
 
 \func{wxChar}{wxT}{\param{char }{ch}}


@@ -1406,7 +1600,7 @@ enough space.
 
 wxT() is a macro which can be used with character and string literals (in other
 words, {\tt 'x'} or {\tt "foo"}) to automatically convert them to Unicode in
 
 wxT() is a macro which can be used with character and string literals (in other
 words, {\tt 'x'} or {\tt "foo"}) to automatically convert them to Unicode in

-Unicode build configuration. Please see the 
+Unicode build configuration. Please see the

 \helpref{Unicode overview}{unicode} for more information.
 
 This macro is simply returns the value passed to it without changes in ASCII
 \helpref{Unicode overview}{unicode} for more information.
 
 This macro is simply returns the value passed to it without changes in ASCII


@@ -1419,21 +1613,22 @@ build. In fact, its definition is:
 #endif
 \end{verbatim}
 
 #endif
 \end{verbatim}
 

+

 \membersection{wxTRANSLATE}\label{wxtranslate}
 
 \func{const wxChar *}{wxTRANSLATE}{\param{const char *}{s}}
 
 This macro doesn't do anything in the program code -- it simply expands to the
 \membersection{wxTRANSLATE}\label{wxtranslate}
 
 \func{const wxChar *}{wxTRANSLATE}{\param{const char *}{s}}
 
 This macro doesn't do anything in the program code -- it simply expands to the

-value of its argument (expand in Unicode build where it is equivalent to 
+value of its argument (except in Unicode build where it is equivalent to

 \helpref{wxT}{wxt} which makes it unnecessary to use both wxTRANSLATE and wxT
 with the same string which would be really unreadable).
 
 However it does have a purpose and it is to mark the literal strings for the
 extraction into the message catalog created by {\tt xgettext} program. Usually
 this is achieved using \helpref{\_()}{underscore} but that macro not only marks
 \helpref{wxT}{wxt} which makes it unnecessary to use both wxTRANSLATE and wxT
 with the same string which would be really unreadable).
 
 However it does have a purpose and it is to mark the literal strings for the
 extraction into the message catalog created by {\tt xgettext} program. Usually
 this is achieved using \helpref{\_()}{underscore} but that macro not only marks

-the string for extraction but also expands into 
+the string for extraction but also expands into a

 \helpref{wxGetTranslation}{wxgettranslation} function call which means that it
 \helpref{wxGetTranslation}{wxgettranslation} function call which means that it

-cannot be used in some situations, notably for the static arrays
+cannot be used in some situations, notably for static array

 initialization.
 
 Here is an example which should make it more clear: suppose that you have a
 initialization.
 
 Here is an example which should make it more clear: suppose that you have a


@@ -1441,18 +1636,22 @@ static array of strings containing the weekday names and which have to be
 translated (note that it is a bad example, really, as
 \helpref{wxDateTime}{wxdatetime} already can be used to get the localized week
 day names already). If you write
 translated (note that it is a bad example, really, as
 \helpref{wxDateTime}{wxdatetime} already can be used to get the localized week
 day names already). If you write

+

 \begin{verbatim}
 static const wxChar * const weekdays[] = { _("Mon"), ..., _("Sun") };
 ...
 // use weekdays[n] as usual
 \end{verbatim}
 \begin{verbatim}
 static const wxChar * const weekdays[] = { _("Mon"), ..., _("Sun") };
 ...
 // use weekdays[n] as usual
 \end{verbatim}

+

 the code wouldn't compile because the function calls are forbidden in the array
 initializer. So instead you should do
 the code wouldn't compile because the function calls are forbidden in the array
 initializer. So instead you should do

+

 \begin{verbatim}
 static const wxChar * const weekdays[] = { wxTRANSLATE("Mon"), ..., wxTRANSLATE("Sun") };
 ...
 // use wxGetTranslation(weekdays[n])
 \end{verbatim}
 \begin{verbatim}
 static const wxChar * const weekdays[] = { wxTRANSLATE("Mon"), ..., wxTRANSLATE("Sun") };
 ...
 // use wxGetTranslation(weekdays[n])
 \end{verbatim}

+

 here.
 
 Note that although the code {\bf would} compile if you simply omit
 here.
 
 Note that although the code {\bf would} compile if you simply omit


@@ -1460,27 +1659,6 @@ wxTRANSLATE() in the above, it wouldn't work as expected because there would be
 no translations for the weekday names in the program message catalog and
 wxGetTranslation wouldn't find them.
 
 no translations for the weekday names in the program message catalog and
 wxGetTranslation wouldn't find them.
 

-
-\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.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-

 \membersection{::wxVsnprintf}\label{wxvsnprintf}
 
 \func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}}
 \membersection{::wxVsnprintf}\label{wxvsnprintf}
 
 \func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}}


@@ -1493,11 +1671,12 @@ argument instead of arbitrary number of parameters.
 \helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv}
 
 
 \helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv}
 
 

+

 \membersection{\_}\label{underscore}
 
 \func{const wxChar *}{\_}{\param{const char *}{s}}
 
 \membersection{\_}\label{underscore}
 
 \func{const wxChar *}{\_}{\param{const char *}{s}}
 

-This macro expands into a call to \helpref{wxGetTranslation}{wxgettranslation} 
+This macro expands into a call to \helpref{wxGetTranslation}{wxgettranslation}

 function, so it marks the message for the extraction by {\tt xgettext} just as
 \helpref{wxTRANSLATE}{wxtranslate} does, but also returns the translation of
 the string for the current locale during execution.
 function, so it marks the message for the extraction by {\tt xgettext} just as
 \helpref{wxTRANSLATE}{wxtranslate} does, but also returns the translation of
 the string for the current locale during execution.


@@ -1512,12 +1691,14 @@ Don't confuse this macro with \helpref{\_T()}{underscoret}!
 \func{const wxChar *}{\_T}{\param{const wxChar }{ch}}
 
 This macro is exactly the same as \helpref{wxT}{wxt} and is defined in
 \func{const wxChar *}{\_T}{\param{const wxChar }{ch}}
 
 This macro is exactly the same as \helpref{wxT}{wxt} and is defined in

-wxWindows simply because it may be more intuitive for Windows programmers as
+wxWidgets simply because it may be more intuitive for Windows programmers as

 the standard Win32 headers also define it (as well as yet another name for the
 same macro which is {\tt \_TEXT()}).
 
 Don't confuse this macro with \helpref{\_()}{underscore}!
 
 the standard Win32 headers also define it (as well as yet another name for the
 same macro which is {\tt \_TEXT()}).
 
 Don't confuse this macro with \helpref{\_()}{underscore}!
 

+
+

 \section{Dialog functions}\label{dialogfunctions}
 
 Below are a number of convenience functions for getting input from the
 \section{Dialog functions}\label{dialogfunctions}
 
 Below are a number of convenience functions for getting input from the


@@ -1526,6 +1707,7 @@ parameters are optional. However, it is recommended to pass a parent frame
 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
 the front when the dialog box is popped up.
 
 parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
 the front when the dialog box is popped up.
 

+

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


@@ -1541,6 +1723,7 @@ See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{::wxBell}\label{wxbell}
 
 \func{void}{wxBell}{\void}
 \membersection{::wxBell}\label{wxbell}
 
 \func{void}{wxBell}{\void}


@@ -1551,6 +1734,7 @@ Ring the system bell.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider}
 
 \func{wxTipProvider *}{wxCreateFileTipProvider}{\param{const wxString\& }{filename},
 \membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider}
 
 \func{wxTipProvider *}{wxCreateFileTipProvider}{\param{const wxString\& }{filename},


@@ -1571,6 +1755,7 @@ is remembered between the 2 program runs.}
 
 <wx/tipdlg.h>
 
 
 <wx/tipdlg.h>
 

+

 \membersection{::wxDirSelector}\label{wxdirselector}
 
 \func{wxString}{wxDirSelector}{\param{const wxString\& }{message = wxDirSelectorPromptStr},\\
 \membersection{::wxDirSelector}\label{wxdirselector}
 
 \func{wxString}{wxDirSelector}{\param{const wxString\& }{message = wxDirSelectorPromptStr},\\


@@ -1597,11 +1782,12 @@ if ( !dir.empty() )
 
 <wx/dirdlg.h>
 
 
 <wx/dirdlg.h>
 

+

 \membersection{::wxFileSelector}\label{wxfileselector}
 
 \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\
  \param{const wxString\& }{default\_filename = ""}, \param{const wxString\& }{default\_extension = ""},\\
 \membersection{::wxFileSelector}\label{wxfileselector}
 
 \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{const wxString\& }{wildcard = "*.*"}, \param{int }{flags = 0}, \param{wxWindow *}{parent = NULL},\\

  \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


@@ -1611,7 +1797,7 @@ 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,

-wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0.
+wxSAVE, wxOVERWRITE\_PROMPT, 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


@@ -1642,6 +1828,7 @@ if ( !filename.empty() )
 
 <wx/filedlg.h>
 
 
 <wx/filedlg.h>
 

+

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


@@ -1655,6 +1842,7 @@ See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
 
 \func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
 \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
 
 \func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}


@@ -1673,6 +1861,7 @@ is valid) if the dialog was cancelled.
 
 <wx/colordlg.h>
 
 
 <wx/colordlg.h>
 

+

 \membersection{::wxGetFontFromUser}\label{wxgetfontfromuser}
 
 \func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}}
 \membersection{::wxGetFontFromUser}\label{wxgetfontfromuser}
 
 \func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}}


@@ -1692,6 +1881,7 @@ is valid) if the dialog was cancelled.
 <wx/fontdlg.h>
 
 
 <wx/fontdlg.h>
 
 

+

 \membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
 
 \func{size\_t}{wxGetMultipleChoices}{\\
 \membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
 
 \func{size\_t}{wxGetMultipleChoices}{\\


@@ -1735,6 +1925,7 @@ characters) is centred; if false, the message is left-justified.
 and {\tt choices}, and no {\tt selections} parameter; the function
 returns an array containing the user selections.}
 
 and {\tt choices}, and no {\tt selections} parameter; the function
 returns an array containing the user selections.}
 

+

 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
 
 \func{long}{wxGetNumberFromUser}{
 \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
 
 \func{long}{wxGetNumberFromUser}{


@@ -1760,12 +1951,14 @@ Dialog is centered on its {\it parent} unless an explicit position is given in
 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 

-<wx/textdlg.h>
+<wx/numdlg.h>
+

 
 \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
 
 
 \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}}
+\func{wxString}{wxGetPasswordFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
+ \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = wxDefaultCoord}, \param{int}{ y = wxDefaultCoord}, \param{bool}{ centre = true}}

 
 Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
 in the dialog is not shown on screen but replaced with stars. This is intended
 
 Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
 in the dialog is not shown on screen but replaced with stars. This is intended


@@ -1775,11 +1968,12 @@ to be used for entering passwords as the function name implies.
 
 <wx/textdlg.h>
 
 
 <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},\\
 \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}}
+ \param{int}{ x = wxDefaultCoord}, \param{int}{ y = wxDefaultCoord}, \param{bool}{ centre = true}}

 
 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,
 
 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,


@@ -1792,6 +1986,7 @@ is centred; if false, the message is left-justified.
 
 <wx/textdlg.h>
 
 
 <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[]},\\


@@ -1818,6 +2013,7 @@ is centred; if false, the message is left-justified.
 
 <wx/choicdlg.h>
 
 
 <wx/choicdlg.h>
 

+

 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
 
 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
 
 \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\


@@ -1856,6 +2052,7 @@ characters) is centred; if false, the message is left-justified.
 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
 and {\tt choices}.}
 
 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
 and {\tt choices}.}
 

+

 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
 
 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
 
 \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\


@@ -1880,6 +2077,7 @@ string. If the user pressed cancel, -1 is returned.
 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
 and {\tt choices}.}
 
 \perlnote{In wxPerl there is just an array reference in place of {\tt n}
 and {\tt choices}.}
 

+

 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
 
 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
 
 \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\


@@ -1911,6 +2109,7 @@ elements as {\it choices} or {\it aChoices}!
 and {\tt choices}, and the client data array must have the
 same length as the choices array.}
 
 and {\tt choices}, and the client data array must have the
 same length as the choices array.}
 

+

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


@@ -1924,6 +2123,7 @@ See also \helpref{wxBusyCursor}{wxbusycursor}.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

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


@@ -1965,6 +2165,7 @@ message will be split into separate lines, to cater for large messages.
 
 <wx/msgdlg.h>
 
 
 <wx/msgdlg.h>
 

+

 \membersection{::wxShowTip}\label{wxshowtip}
 
 \func{bool}{wxShowTip}{\param{wxWindow *}{parent},
 \membersection{::wxShowTip}\label{wxshowtip}
 
 \func{bool}{wxShowTip}{\param{wxWindow *}{parent},


@@ -1972,7 +2173,7 @@ message will be split into separate lines, to cater for large messages.
  \param{bool }{showAtStartup = true}}
 
 This function shows a "startup tip" to the user. The return value is the
  \param{bool }{showAtStartup = true}}
 
 This function shows a "startup tip" to the user. The return value is the

-state of the ``Show tips at startup'' checkbox.
+state of the `Show tips at startup' checkbox.

 
 \docparam{parent}{The parent window for the modal dialog}
 
 
 \docparam{parent}{The parent window for the modal dialog}
 


@@ -1992,19 +2193,23 @@ checkbox which is shown in the tips dialog.}
 <wx/tipdlg.h>
 
 
 <wx/tipdlg.h>
 
 

-\section{Math functions}
+
+
+\section{Math functions}\label{mathfunctions}

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

+

 \membersection{wxFinite}\label{wxfinite}
 
 \func{int}{wxFinite}{\param{double }{x}}
 
 \membersection{wxFinite}\label{wxfinite}
 
 \func{int}{wxFinite}{\param{double }{x}}
 

-Returns a non-zero value if {\it x} is neither infinite or NaN (not a number), 
+Returns a non-zero value if {\it x} is neither infinite or NaN (not a number),

 returns 0 otherwise.
 
 returns 0 otherwise.
 

+

 \membersection{wxIsNaN}\label{wxisnan}
 
 \func{bool}{wxIsNaN}{\param{double }{x}}
 \membersection{wxIsNaN}\label{wxisnan}
 
 \func{bool}{wxIsNaN}{\param{double }{x}}


@@ -2013,6 +2218,8 @@ Returns a non-zero value if {\it x} is NaN (not a number), returns 0
 otherwise.
 
 
 otherwise.
 
 

+
+

 \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).


@@ -2021,6 +2228,7 @@ The following are relevant to the GDI (Graphics Device Interface).
 
 <wx/gdicmn.h>
 
 
 <wx/gdicmn.h>
 

+

 \membersection{wxBITMAP}\label{wxbitmapmacro}
 
 \func{}{wxBITMAP}{bitmapName}
 \membersection{wxBITMAP}\label{wxbitmapmacro}
 
 \func{}{wxBITMAP}{bitmapName}


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

+

 \membersection{::wxClientDisplayRect}\label{wxclientdisplayrect}
 
 \func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
 \membersection{::wxClientDisplayRect}\label{wxclientdisplayrect}
 
 \func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},


@@ -2050,18 +2259,21 @@ this means the area not covered by the taskbar, etc.  Other platforms
 are currently defaulting to the whole display until a way is found to
 provide this info for all window managers, etc.
 
 are currently defaulting to the whole display until a way is found to
 provide this info for all window managers, etc.
 

+

 \membersection{::wxColourDisplay}\label{wxcolourdisplay}
 
 \func{bool}{wxColourDisplay}{\void}
 
 Returns true if the display is colour, false otherwise.
 
 \membersection{::wxColourDisplay}\label{wxcolourdisplay}
 
 \func{bool}{wxColourDisplay}{\void}
 
 Returns true if the display is colour, false otherwise.
 

+

 \membersection{::wxDisplayDepth}\label{wxdisplaydepth}
 
 \func{int}{wxDisplayDepth}{\void}
 
 Returns the depth of the display (a value of 1 denotes a monochrome display).
 
 \membersection{::wxDisplayDepth}\label{wxdisplaydepth}
 
 \func{int}{wxDisplayDepth}{\void}
 
 Returns the depth of the display (a value of 1 denotes a monochrome display).
 

+

 \membersection{::wxDisplaySize}\label{wxdisplaysize}
 
 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
 \membersection{::wxDisplaySize}\label{wxdisplaysize}
 
 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}


@@ -2070,6 +2282,7 @@ Returns the depth of the display (a value of 1 denotes a monochrome display).
 
 Returns the display size in pixels.
 
 
 Returns the display size in pixels.
 

+

 \membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}
 
 \func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
 \membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}
 
 \func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}


@@ -2078,6 +2291,7 @@ Returns the display size in pixels.
 
 Returns the display size in millimeters.
 
 
 Returns the display size in millimeters.
 

+

 \membersection{::wxDROP\_ICON}\label{wxdropicon}
 
 \func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
 \membersection{::wxDROP\_ICON}\label{wxdropicon}
 
 \func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}


@@ -2093,6 +2307,7 @@ This macro should be used with
 
 <wx/dnd.h>
 
 
 <wx/dnd.h>
 

+

 \membersection{wxICON}\label{wxiconmacro}
 
 \func{}{wxICON}{iconName}
 \membersection{wxICON}\label{wxiconmacro}
 
 \func{}{wxICON}{iconName}


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

+

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


@@ -2129,7 +2345,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 wxMM\_TEXT mapping mode, which wxWindows assumes.
+This simulates the wxMM\_TEXT mapping mode, which wxWidgets 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.


@@ -2138,6 +2354,7 @@ used in RTF (Rich Text Format) files.
 
 This function is only available under Windows.
 
 
 This function is only available under Windows.
 

+

 \membersection{::wxSetCursor}\label{wxsetcursor}
 
 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
 \membersection{::wxSetCursor}\label{wxsetcursor}
 
 \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}


@@ -2145,6 +2362,8 @@ This function is only available under Windows.
 Globally sets the cursor; only has an effect in Windows and GTK.
 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
 
 Globally sets the cursor; only has an effect in Windows and GTK.
 See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
 

+
+

 \section{Printer settings}\label{printersettings}
 
 {\bf NB:} These routines are obsolete and should no longer be used!
 \section{Printer settings}\label{printersettings}
 
 {\bf NB:} These routines are obsolete and should no longer be used!


@@ -2156,18 +2375,21 @@ Windows, PostScript output can only be sent to a file.
 
 <wx/dcps.h>
 
 
 <wx/dcps.h>
 

+

 \membersection{::wxGetPrinterCommand}\label{wxgetprintercommand}
 
 \func{wxString}{wxGetPrinterCommand}{\void}
 
 Gets the printer command used to print a file. The default is {\tt lpr}.
 
 \membersection{::wxGetPrinterCommand}\label{wxgetprintercommand}
 
 \func{wxString}{wxGetPrinterCommand}{\void}
 
 Gets the printer command used to print a file. The default is {\tt lpr}.
 

+

 \membersection{::wxGetPrinterFile}\label{wxgetprinterfile}
 
 \func{wxString}{wxGetPrinterFile}{\void}
 
 Gets the PostScript output filename.
 
 \membersection{::wxGetPrinterFile}\label{wxgetprinterfile}
 
 \func{wxString}{wxGetPrinterFile}{\void}
 
 Gets the PostScript output filename.
 

+

 \membersection{::wxGetPrinterMode}\label{wxgetprintermode}
 
 \func{int}{wxGetPrinterMode}{\void}
 \membersection{::wxGetPrinterMode}\label{wxgetprintermode}
 
 \func{int}{wxGetPrinterMode}{\void}


@@ -2175,48 +2397,56 @@ Gets the PostScript output filename.
 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
 The default is PS\_PREVIEW.
 
 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
 The default is PS\_PREVIEW.
 

+

 \membersection{::wxGetPrinterOptions}\label{wxgetprinteroptions}
 
 \func{wxString}{wxGetPrinterOptions}{\void}
 
 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
 
 \membersection{::wxGetPrinterOptions}\label{wxgetprinteroptions}
 
 \func{wxString}{wxGetPrinterOptions}{\void}
 
 Gets the additional options for the print command (e.g. specific printer). The default is nothing.
 

+

 \membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation}
 
 \func{int}{wxGetPrinterOrientation}{\void}
 
 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
 
 \membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation}
 
 \func{int}{wxGetPrinterOrientation}{\void}
 
 Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
 

+

 \membersection{::wxGetPrinterPreviewCommand}\label{wxgetprinterpreviewcommand}
 
 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
 
 Gets the command used to view a PostScript file. The default depends on the platform.
 
 \membersection{::wxGetPrinterPreviewCommand}\label{wxgetprinterpreviewcommand}
 
 \func{wxString}{wxGetPrinterPreviewCommand}{\void}
 
 Gets the command used to view a PostScript file. The default depends on the platform.
 

+

 \membersection{::wxGetPrinterScaling}\label{wxgetprinterscaling}
 
 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
 
 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
 
 \membersection{::wxGetPrinterScaling}\label{wxgetprinterscaling}
 
 \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
 
 Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
 

+

 \membersection{::wxGetPrinterTranslation}\label{wxgetprintertranslation}
 
 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
 
 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
 
 \membersection{::wxGetPrinterTranslation}\label{wxgetprintertranslation}
 
 \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
 
 Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
 

+

 \membersection{::wxSetPrinterCommand}\label{wxsetprintercommand}
 
 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
 
 Sets the printer command used to print a file. The default is {\tt lpr}.
 
 \membersection{::wxSetPrinterCommand}\label{wxsetprintercommand}
 
 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
 
 Sets the printer command used to print a file. The default is {\tt lpr}.
 

+

 \membersection{::wxSetPrinterFile}\label{wxsetprinterfile}
 
 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
 
 Sets the PostScript output filename.
 
 \membersection{::wxSetPrinterFile}\label{wxsetprinterfile}
 
 \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
 
 Sets the PostScript output filename.
 

+

 \membersection{::wxSetPrinterMode}\label{wxsetprintermode}
 
 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
 \membersection{::wxSetPrinterMode}\label{wxsetprintermode}
 
 \func{void}{wxSetPrinterMode}{\param{int }{mode}}


@@ -2224,36 +2454,43 @@ Sets the PostScript output filename.
 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
 The default is PS\_PREVIEW.
 
 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
 The default is PS\_PREVIEW.
 

+

 \membersection{::wxSetPrinterOptions}\label{wxsetprinteroptions}
 
 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
 
 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
 
 \membersection{::wxSetPrinterOptions}\label{wxsetprinteroptions}
 
 \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
 
 Sets the additional options for the print command (e.g. specific printer). The default is nothing.
 

+

 \membersection{::wxSetPrinterOrientation}\label{wxsetprinterorientation}
 
 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
 
 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
 
 \membersection{::wxSetPrinterOrientation}\label{wxsetprinterorientation}
 
 \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
 
 Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
 

+

 \membersection{::wxSetPrinterPreviewCommand}\label{wxsetprinterpreviewcommand}
 
 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
 
 Sets the command used to view a PostScript file. The default depends on the platform.
 
 \membersection{::wxSetPrinterPreviewCommand}\label{wxsetprinterpreviewcommand}
 
 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
 
 Sets the command used to view a PostScript file. The default depends on the platform.
 

+

 \membersection{::wxSetPrinterScaling}\label{wxsetprinterscaling}
 
 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
 
 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
 
 \membersection{::wxSetPrinterScaling}\label{wxsetprinterscaling}
 
 \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
 
 Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
 

+

 \membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation}
 
 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
 
 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
 
 \membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation}
 
 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
 
 Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
 

+
+

 \section{Clipboard functions}\label{clipsboard}
 
 These clipboard functions are implemented for Windows only. The use of these functions
 \section{Clipboard functions}\label{clipsboard}
 
 These clipboard functions are implemented for Windows only. The use of these functions


@@ -2264,24 +2501,28 @@ class instead.
 
 <wx/clipbrd.h>
 
 
 <wx/clipbrd.h>
 

+

 \membersection{::wxClipboardOpen}\label{functionwxclipboardopen}
 
 \func{bool}{wxClipboardOpen}{\void}
 
 Returns true if this application has already opened the clipboard.
 
 \membersection{::wxClipboardOpen}\label{functionwxclipboardopen}
 
 \func{bool}{wxClipboardOpen}{\void}
 
 Returns true if this application has already opened the clipboard.
 

+

 \membersection{::wxCloseClipboard}\label{wxcloseclipboard}
 
 \func{bool}{wxCloseClipboard}{\void}
 
 Closes the clipboard to allow other applications to use it.
 
 \membersection{::wxCloseClipboard}\label{wxcloseclipboard}
 
 \func{bool}{wxCloseClipboard}{\void}
 
 Closes the clipboard to allow other applications to use it.
 

+

 \membersection{::wxEmptyClipboard}\label{wxemptyclipboard}
 
 \func{bool}{wxEmptyClipboard}{\void}
 
 Empties the clipboard.
 
 \membersection{::wxEmptyClipboard}\label{wxemptyclipboard}
 
 \func{bool}{wxEmptyClipboard}{\void}
 
 Empties the clipboard.
 

+

 \membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}
 
 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
 \membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}
 
 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}


@@ -2302,6 +2543,7 @@ is not open.
 Before it enumerates the formats function, an application must open the clipboard by using the
 wxOpenClipboard function.
 
 Before it enumerates the formats function, an application must open the clipboard by using the
 wxOpenClipboard function.
 

+

 \membersection{::wxGetClipboardData}\label{wxgetclipboarddata}
 
 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
 \membersection{::wxGetClipboardData}\label{wxgetclipboarddata}
 
 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}


@@ -2317,6 +2559,7 @@ Gets data from the clipboard.
 
 The clipboard must have previously been opened for this call to succeed.
 
 
 The clipboard must have previously been opened for this call to succeed.
 

+

 \membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}
 
 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
 \membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}
 
 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}


@@ -2324,24 +2567,28 @@ The clipboard must have previously been opened for this call to succeed.
 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
 
 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
 

+

 \membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
 
 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
 
 Returns true if the given data format is available on the clipboard.
 
 \membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
 
 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
 
 Returns true if the given data format is available on the clipboard.
 

+

 \membersection{::wxOpenClipboard}\label{wxopenclipboard}
 
 \func{bool}{wxOpenClipboard}{\void}
 
 Opens the clipboard for passing data to it or getting data from it.
 
 \membersection{::wxOpenClipboard}\label{wxopenclipboard}
 
 \func{bool}{wxOpenClipboard}{\void}
 
 Opens the clipboard for passing data to it or getting data from it.
 

+

 \membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat}
 
 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
 
 Registers the clipboard data format name and returns an identifier.
 
 \membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat}
 
 \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
 
 Registers the clipboard data format name and returns an identifier.
 

+

 \membersection{::wxSetClipboardData}\label{wxsetclipboarddata}
 
 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
 \membersection{::wxSetClipboardData}\label{wxsetclipboarddata}
 
 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}


@@ -2360,21 +2607,31 @@ Passes data to the clipboard.
 The clipboard must have previously been opened for this call to succeed.
 
 
 The clipboard must have previously been opened for this call to succeed.
 
 

+
+

 \section{Miscellaneous functions}\label{miscellany}
 
 \section{Miscellaneous functions}\label{miscellany}
 

+
+\membersection{wxCONCAT}\label{wxconcat}
+
+\func{}{wxCONCAT}{\param{}{x}, \param{}{y}}
+
+This macro returns the concatenation of two tokens \arg{x} and \arg{y}.
+
+

 \membersection{wxDYNLIB\_FUNCTION}\label{wxdynlibfunction}
 
 \func{}{wxDYNLIB\_FUNCTION}{\param{}{type}, \param{}{name}, \param{}{dynlib}}
 
 \membersection{wxDYNLIB\_FUNCTION}\label{wxdynlibfunction}
 
 \func{}{wxDYNLIB\_FUNCTION}{\param{}{type}, \param{}{name}, \param{}{dynlib}}
 

-When loading a function from a DLL you always have to cast the returned 
-\tt{void *} pointer to the correct type and, even more annoyingly, you have to
+When loading a function from a DLL you always have to cast the returned
+{\tt void *} pointer to the correct type and, even more annoyingly, you have to

 repeat this type twice if you want to declare and define a function pointer all
 in one line
 
 This macro makes this slightly less painful by allowing you to specify the
 type only once, as the first parameter, and creating a variable of this type
 named after the function but with {\tt pfn} prefix and initialized with the
 repeat this type twice if you want to declare and define a function pointer all
 in one line
 
 This macro makes this slightly less painful by allowing you to specify the
 type only once, as the first parameter, and creating a variable of this type
 named after the function but with {\tt pfn} prefix and initialized with the

-function \arg{name} from the \helpref{wxDynamicLibrary}{wxdynamiclibrary} 
+function \arg{name} from the \helpref{wxDynamicLibrary}{wxdynamiclibrary}

 \arg{dynlib}.
 
 \wxheading{Parameters}
 \arg{dynlib}.
 
 \wxheading{Parameters}


@@ -2387,6 +2644,7 @@ it is quoted automatically by the macro)}
 \docparam{dynlib}{the library to load the function from}
 
 
 \docparam{dynlib}{the library to load the function from}
 
 

+

 \membersection{wxEXPLICIT}\label{wxexplicit}
 
 {\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if
 \membersection{wxEXPLICIT}\label{wxexplicit}
 
 {\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if


@@ -2394,6 +2652,20 @@ the compiler supports it or nothing otherwise. Thus, it can be used even in the
 code which might have to be compiled with an old compiler without support for
 this language feature but still take advantage of it when it is available.
 
 code which might have to be compiled with an old compiler without support for
 this language feature but still take advantage of it when it is available.
 

+
+\membersection{::wxGetKeyState}\label{wxgetkeystate}
+
+\func{bool}{wxGetKeyState}{\param{wxKeyCode }{key}}
+
+Returns \true if the key parameter is currently pressed on the keyboard, or
+with modifier keys, (caps lock, etc) if the key is active (the led light is
+on).
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+

 \membersection{wxLL}\label{wxll}
 
 \func{wxLongLong\_t}{wxLL}{\param{}{number}}
 \membersection{wxLL}\label{wxll}
 
 \func{wxLongLong\_t}{wxLL}{\param{}{number}}


@@ -2411,6 +2683,11 @@ allows to define 64 bit compile time constants:
 
 <wx/longlong.h>
 
 
 <wx/longlong.h>
 

+\wxheading{See also}
+
+\helpref{wxULL}{wxull}, \helpref{wxLongLong}{wxlonglong}
+
+

 \membersection{wxLongLongFmtSpec}\label{wxlonglongfmtspec}
 
 This macro is defined to contain the {\tt printf()} format specifier using
 \membersection{wxLongLongFmtSpec}\label{wxlonglongfmtspec}
 
 This macro is defined to contain the {\tt printf()} format specifier using


@@ -2432,6 +2709,7 @@ printed. Example of using it:
 
 <wx/longlong.h>
 
 
 <wx/longlong.h>
 

+

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


@@ -2442,6 +2720,7 @@ Generates an integer identifier unique to this run of the program.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{::wxRegisterId}\label{wxregisterid}
 
 \func{void}{wxRegisterId}{\param{long}{ id}}
 \membersection{::wxRegisterId}\label{wxregisterid}
 
 \func{void}{wxRegisterId}{\param{long}{ id}}


@@ -2453,11 +2732,12 @@ the given {\bf id}.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{::wxDDECleanUp}\label{wxddecleanup}
 
 \func{void}{wxDDECleanUp}{\void}
 
 \membersection{::wxDDECleanUp}\label{wxddecleanup}
 
 \func{void}{wxDDECleanUp}{\void}
 

-Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
+Called when wxWidgets exits, to clean up the DDE system. This no longer needs to be

 called by the application.
 
 See also \helpref{wxDDEInitialize}{wxddeinitialize}.
 called by the application.
 
 See also \helpref{wxDDEInitialize}{wxddeinitialize}.


@@ -2466,6 +2746,7 @@ See also \helpref{wxDDEInitialize}{wxddeinitialize}.
 
 <wx/dde.h>
 
 
 <wx/dde.h>
 

+

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


@@ -2473,15 +2754,16 @@ See also \helpref{wxDDEInitialize}{wxddeinitialize}.
 Initializes the DDE system. May be called multiple times without harm.
 
 This no longer needs to be called by the application: it will be called
 Initializes the DDE system. May be called multiple times without harm.
 
 This no longer needs to be called by the application: it will be called

-by wxWindows if necessary.
+by wxWidgets if necessary.

 
 

-See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
+See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},\rtfsp

 \helpref{wxDDECleanUp}{wxddecleanup}.
 
 \wxheading{Include files}
 
 <wx/dde.h>
 
 \helpref{wxDDECleanUp}{wxddecleanup}.
 
 \wxheading{Include files}
 
 <wx/dde.h>
 

+

 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
 
 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = true}}
 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
 
 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = true}}


@@ -2493,6 +2775,7 @@ This function enables or disables all top level windows. It is used by
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}
 
 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
 \membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}
 
 \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}


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

+

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


@@ -2519,6 +2803,7 @@ The search is recursive in both cases.
 
 <wx/utils.h>
 
 
 <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}}


@@ -2537,6 +2822,7 @@ 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}}
 \membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
 
 \func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}


@@ -2544,6 +2830,7 @@ If no such named window is found, {\bf wxFindWindowByLabel} is called.
 Find the deepest window at the given mouse position in screen coordinates,
 returning the window if found, or NULL if not.
 
 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}}
 \membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
 
 \func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}


@@ -2551,6 +2838,7 @@ returning the window if found, or NULL if not.
 Find the deepest window at the mouse pointer position, returning the window
 and current pointer position in screen coordinates.
 
 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}


@@ -2561,6 +2849,22 @@ Gets the currently active window (Windows only).
 
 <wx/windows.h>
 
 
 <wx/windows.h>
 

+
+\membersection{::wxGetBatteryState}\label{wxgetbatterystate}
+
+\func{wxBatteryState}{wxGetBatteryState}{\void}
+
+Returns battery state as one of \texttt{wxBATTERY\_NORMAL\_STATE},
+\texttt{wxBATTERY\_LOW\_STATE}, \texttt{wxBATTERY\_CRITICAL\_STATE},
+\texttt{wxBATTERY\_SHUTDOWN\_STATE} or \texttt{wxBATTERY\_UNKNOWN\_STATE}.
+\texttt{wxBATTERY\_UNKNOWN\_STATE} is also the default on platforms where
+this feature is not implemented.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+

 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
 
 \func{wxString}{wxGetDisplayName}{\void}
 \membersection{::wxGetDisplayName}\label{wxgetdisplayname}
 
 \func{wxString}{wxGetDisplayName}{\void}


@@ -2571,6 +2875,21 @@ Under X only, returns the current display name. See also \helpref{wxSetDisplayNa
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+
+\membersection{::wxGetPowerType}\label{wxgetpowertype}
+
+\func{wxPowerType}{wxGetPowerType}{\void}
+
+Returns the type of power source as one of \texttt{wxPOWER\_SOCKET},
+\texttt{wxPOWER\_BATTERY} or \texttt{wxPOWER\_UNKNOWN}.
+\texttt{wxPOWER\_UNKNOWN} is also the default on platforms where this
+feature is not implemented.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+

 \membersection{::wxGetMousePosition}\label{wxgetmouseposition}
 
 \func{wxPoint}{wxGetMousePosition}{\void}
 \membersection{::wxGetMousePosition}\label{wxgetmouseposition}
 
 \func{wxPoint}{wxGetMousePosition}{\void}


@@ -2581,6 +2900,7 @@ Returns the mouse position in screen coordinates.
 
 <wx/utils.h>
 
 
 <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},


@@ -2615,6 +2935,29 @@ See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxco
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+
+\membersection{::wxGetStockLabel}\label{wxgetstocklabel}
+
+\func{wxString}{wxGetStockLabel}{\param{wxWindowID }{id}, \param{bool }{withCodes = true}, \param{wxString }{accelerator = wxEmptyString}}
+
+Returns label that should be used for given {\it id} element.
+
+\wxheading{Parameters}
+
+\docparam{id}{given id of the \helpref{wxMenuItem}{wxmenuitem}, \helpref{wxButton}{wxbutton}, \helpref{wxToolBar}{wxtoolbar} tool, etc.}
+
+\docparam{withCodes}{if false then strip accelerator code from the label;
+usefull for getting labels without accelerator char code like for toolbar tooltip or
+under platforms without traditional keyboard like smartphones}
+
+\docparam{accelerator}{optional accelerator string automatically added to label; useful
+for building labels for \helpref{wxMenuItem}{wxmenuitem}}
+
+\wxheading{Include files}
+
+<wx/stockitem.h>
+
+

 \membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
 
 \func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}
 \membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
 
 \func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}


@@ -2626,6 +2969,7 @@ frame or dialog containing it, or {\tt NULL}.
 
 <wx/window.h>
 
 
 <wx/window.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"}}


@@ -2647,6 +2991,7 @@ This function is available under Windows only.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

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


@@ -2662,6 +3007,7 @@ Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{::wxPostEvent}\label{wxpostevent}
 
 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
 \membersection{::wxPostEvent}\label{wxpostevent}
 
 \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}


@@ -2676,6 +3022,7 @@ See the respective documentation for details (and caveats).
 
 <wx/app.h>
 
 
 <wx/app.h>
 

+

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


@@ -2691,6 +3038,7 @@ See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

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


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

+
+\membersection{wxULL}\label{wxull}
+
+\func{wxLongLong\_t}{wxULL}{\param{}{number}}
+
+This macro is defined for the platforms with a native 64 bit integer type and
+allows to define unsigned 64 bit compile time constants:
+
+\begin{verbatim}
+    #ifdef wxLongLong_t
+        unsigned wxLongLong_t ll = wxULL(0x1234567890abcdef);
+    #endif
+\end{verbatim}
+
+\wxheading{Include files}
+
+<wx/longlong.h>
+
+\wxheading{See also}
+
+\helpref{wxLL}{wxll}, \helpref{wxLongLong}{wxlonglong}
+
+
+\membersection{wxVaCopy}\label{wxvacopy}
+
+\func{void}{wxVaCopy}{\param{va\_list }{argptrDst}, \param{va\_list}{argptrSrc}}
+
+This macro is the same as the standard C99 \texttt{va\_copy} for the compilers
+which support it or its replacement for those that don't. It must be used to
+preserve the value of a \texttt{va\_list} object if you need to use it after
+passing it to another function because it can be modified by the latter.
+
+As with \texttt{va\_start}, each call to \texttt{wxVaCopy} must have a matching
+\texttt{va\_end}.
+
+

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


@@ -2741,6 +3125,8 @@ See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfig
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+
+

 \section{Byte order macros}\label{byteordermacros}
 
 The endian-ness issues (that is the difference between big-endian and
 \section{Byte order macros}\label{byteordermacros}
 
 The endian-ness issues (that is the difference between big-endian and


@@ -2749,6 +3135,7 @@ with the external binary data (for example, data files or data coming from
 network) which is usually in some fixed, platform-independent format. The
 macros are helpful for transforming the data to the correct format.
 
 network) which is usually in some fixed, platform-independent format. The
 macros are helpful for transforming the data to the correct format.
 

+

 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
 
 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
 
 \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}


@@ -2763,6 +3150,7 @@ These macros will swap the bytes of the {\it value} variable from little
 endian to big endian or vice versa unconditionally, i.e. independently of the
 current platform.
 
 endian to big endian or vice versa unconditionally, i.e. independently of the
 current platform.
 

+

 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
 
 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
 
 \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}


@@ -2781,6 +3169,7 @@ been compiled on a little-endian architecture, the value will be unchanged.
 Use these macros to read data from and write data to a file that stores
 data in little-endian (for example Intel i386) format.
 
 Use these macros to read data from and write data to a file that stores
 data in little-endian (for example Intel i386) format.
 

+

 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
 
 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
 
 \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}


@@ -2799,9 +3188,11 @@ been compiled on a big-endian architecture, the value will be unchanged.
 Use these macros to read data from and write data to a file that stores
 data in big-endian format.
 
 Use these macros to read data from and write data to a file that stores
 data in big-endian format.
 

+
+

 \section{RTTI functions}\label{rttimacros}
 
 \section{RTTI functions}\label{rttimacros}
 

-wxWindows uses its own RTTI ("run-time type identification") system which
+wxWidgets uses its own RTTI ("run-time type identification") system which

 predates the current standard C++ RTTI and so is kept for backwards
 compatibility reasons but also because it allows some things which the
 standard RTTI doesn't directly support (such as creating a class from its
 predates the current standard C++ RTTI and so is kept for backwards
 compatibility reasons but also because it allows some things which the
 standard RTTI doesn't directly support (such as creating a class from its


@@ -2809,12 +3200,13 @@ name).
 
 The standard C++ RTTI can be used in the user code without any problems and in
 general you shouldn't need to use the functions and the macros in this section
 
 The standard C++ RTTI can be used in the user code without any problems and in
 general you shouldn't need to use the functions and the macros in this section

-unless you are thinking of modifying or adding any wxWindows classes.
+unless you are thinking of modifying or adding any wxWidgets classes.

 
 \wxheading{See also}
 
 \helpref{RTTI overview}{runtimeclassoverview}
 
 
 \wxheading{See also}
 
 \helpref{RTTI overview}{runtimeclassoverview}
 

+

 \membersection{CLASSINFO}\label{classinfo}
 
 \func{wxClassInfo *}{CLASSINFO}{className}
 \membersection{CLASSINFO}\label{classinfo}
 
 \func{wxClassInfo *}{CLASSINFO}{className}


@@ -2825,6 +3217,7 @@ Returns a pointer to the wxClassInfo object associated with this class.
 
 <wx/object.h>
 
 
 <wx/object.h>
 

+

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


@@ -2851,13 +3244,14 @@ class wxCommand: public wxObject
 
 <wx/object.h>
 
 
 <wx/object.h>
 

+

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

-This is used in headers to create a forward declaration of the 
-\helpref{wxGetApp}{wxgetapp} function implemented by 
-\helpref{IMPLEMENT\_APP}{implementapp}. It creates the declaration 
+This is used in headers to create a forward declaration of the
+\helpref{wxGetApp}{wxgetapp} function implemented by
+\helpref{IMPLEMENT\_APP}{implementapp}. It creates the declaration

 {\tt className\& wxGetApp(void)}.
 
 Example:
 {\tt className\& wxGetApp(void)}.
 
 Example:


@@ -2870,6 +3264,7 @@ Example:
 
 <wx/app.h>
 
 
 <wx/app.h>
 

+

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


@@ -2882,6 +3277,7 @@ dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
 
 <wx/object.h>
 
 
 <wx/object.h>
 

+

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


@@ -2907,6 +3303,7 @@ class wxFrame: public wxWindow
 
 <wx/object.h>
 
 
 <wx/object.h>
 

+

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


@@ -2929,6 +3326,7 @@ wxCommand::wxCommand(void)
 
 <wx/object.h>
 
 
 <wx/object.h>
 

+

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


@@ -2940,12 +3338,13 @@ a class that has run-time type information and two base classes. The same as IMP
 
 <wx/object.h>
 
 
 <wx/object.h>
 

+

 \membersection{IMPLEMENT\_APP}\label{implementapp}
 
 \func{}{IMPLEMENT\_APP}{className}
 
 This is used in the application class implementation file to make the application class known to
 \membersection{IMPLEMENT\_APP}\label{implementapp}
 
 \func{}{IMPLEMENT\_APP}{className}
 
 This is used in the application class implementation file to make the application class known to

-wxWindows for dynamic construction. You use this instead of
+wxWidgets for dynamic construction. You use this instead of

 
 Old form:
 
 
 Old form:
 


@@ -2965,6 +3364,7 @@ See also \helpref{DECLARE\_APP}{declareapp}.
 
 <wx/app.h>
 
 
 <wx/app.h>
 

+

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


@@ -2976,6 +3376,7 @@ a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLA
 
 <wx/object.h>
 
 
 <wx/object.h>
 

+

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


@@ -2988,6 +3389,7 @@ same as IMPLEMENT\_ABSTRACT\_CLASS2.
 
 <wx/object.h>
 
 
 <wx/object.h>
 

+

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


@@ -3011,6 +3413,7 @@ wxFrame::wxFrame(void)
 
 <wx/object.h>
 
 
 <wx/object.h>
 

+

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


@@ -3024,6 +3427,7 @@ base classes.
 
 <wx/object.h>
 
 
 <wx/object.h>
 

+

 \membersection{wxConstCast}\label{wxconstcast}
 
 \func{classname *}{wxConstCast}{ptr, classname}
 \membersection{wxConstCast}\label{wxconstcast}
 
 \func{classname *}{wxConstCast}{ptr, classname}


@@ -3033,9 +3437,11 @@ supports {\it const\_cast} or into an old, C-style cast, otherwise.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

+\helpref{wx\_const\_cast}{wxconstcastraw}\\

 \helpref{wxDynamicCast}{wxdynamiccast}\\
 \helpref{wxStaticCast}{wxstaticcast}
 
 \helpref{wxDynamicCast}{wxdynamiccast}\\
 \helpref{wxStaticCast}{wxstaticcast}
 

+

 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
 
 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
 \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
 
 \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}


@@ -3043,6 +3449,7 @@ supports {\it const\_cast} or into an old, C-style cast, otherwise.
 Creates and returns an object of the given class, if the class has been
 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
 
 Creates and returns an object of the given class, if the class has been
 registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
 

+

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


@@ -3060,6 +3467,7 @@ In non-debug mode, this is defined as the normal new operator.
 
 <wx/object.h>
 
 
 <wx/object.h>
 

+

 \membersection{wxDynamicCast}\label{wxdynamiccast}
 
 \func{classname *}{wxDynamicCast}{ptr, classname}
 \membersection{wxDynamicCast}\label{wxdynamiccast}
 
 \func{classname *}{wxDynamicCast}{ptr, classname}


@@ -3094,6 +3502,7 @@ Example:
 \helpref{wxConstCast}{wxconstcast}\\
 \helpref{wxStatiicCast}{wxstaticcast}
 
 \helpref{wxConstCast}{wxconstcast}\\
 \helpref{wxStatiicCast}{wxstaticcast}
 

+

 \membersection{wxDynamicCastThis}\label{wxdynamiccastthis}
 
 \func{classname *}{wxDynamicCastThis}{classname}
 \membersection{wxDynamicCastThis}\label{wxdynamiccastthis}
 
 \func{classname *}{wxDynamicCastThis}{classname}


@@ -3107,6 +3516,7 @@ this macro should be used to avoid them.
 
 \helpref{wxDynamicCast}{wxdynamiccast}
 
 
 \helpref{wxDynamicCast}{wxdynamiccast}
 

+

 \membersection{wxStaticCast}\label{wxstaticcast}
 
 \func{classname *}{wxStaticCast}{ptr, classname}
 \membersection{wxStaticCast}\label{wxstaticcast}
 
 \func{classname *}{wxStaticCast}{ptr, classname}


@@ -3115,20 +3525,70 @@ 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)}.
 
 result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the
 result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
 

+\wxheading{See also}
+
+\helpref{wx\_static\_cast}{wxstaticcastraw}\\

 \helpref{wxDynamicCast}{wxdynamiccast}\\
 \helpref{wxConstCast}{wxconstcast}
 
 \helpref{wxDynamicCast}{wxdynamiccast}\\
 \helpref{wxConstCast}{wxconstcast}
 

+
+\membersection{wx\_const\_cast}\label{wxconstcastraw}
+
+\func{T}{wx\_const\_cast}{T, x}
+
+Same as \texttt{const\_cast<T>(x)} if the compiler supports const cast or
+\texttt{(T)x} for old compilers. Unlike \helpref{wxConstCast}{wxconstcast},
+the cast it to the type \arg{T} and not to \texttt{T *} and also the order of
+arguments is the same as for the standard cast.
+
+\wxheading{See also}
+
+\helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw},\\
+\helpref{wx\_static\_cast}{wxstaticcastraw}
+
+
+\membersection{wx\_reinterpret\_cast}\label{wxreinterpretcastraw}
+
+\func{T}{wx\_reinterpret\_cast}{T, x}
+
+Same as \texttt{reinterpret\_cast<T>(x)} if the compiler supports reinterpret cast or
+\texttt{(T)x} for old compilers.
+
+\wxheading{See also}
+
+\helpref{wx\_const\_cast}{wxconstcastraw},\\
+\helpref{wx\_static\_cast}{wxstaticcastraw}
+
+
+\membersection{wx\_static\_cast}\label{wxstaticcastraw}
+
+\func{T}{wx\_static\_cast}{T, x}
+
+Same as \texttt{static\_cast<T>(x)} if the compiler supports static cast or
+\texttt{(T)x} for old compilers. Unlike \helpref{wxStaticCast}{wxstaticcast},
+there are no checks being done and the meaning of the macro arguments is exactly
+the same as for the standard static cast, i.e. \arg{T} is the full type name and
+star is not appended to it.
+
+\wxheading{See also}
+
+\helpref{wx\_const\_cast}{wxconstcastraw},\\
+\helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw}
+
+
+

 \section{Log functions}\label{logfunctions}
 
 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
 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
 \section{Log functions}\label{logfunctions}
 
 These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
 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).
+standard one (installed by wxWidgets in the beginning of the program).

 
 \wxheading{Include files}
 
 <wx/log.h>
 
 
 \wxheading{Include files}
 
 <wx/log.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{...}{}}


@@ -3153,36 +3613,39 @@ instead.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{::wxError}\label{wxerror}
 
 \membersection{::wxError}\label{wxerror}
 

-\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
+\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Internal Error"}}

 
 {\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
 instead.
 
 Displays {\it msg} and continues. This writes to standard error under
 Unix, and pops up a message box under Windows. Used for internal
 
 {\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
 instead.
 
 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}.
+wxWidgets errors. See also \helpref{wxFatalError}{wxfatalerror}.

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

+

 \membersection{::wxFatalError}\label{wxfatalerror}
 
 \membersection{::wxFatalError}\label{wxfatalerror}
 

-\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
+\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Fatal Error"}}

 
 {\bf NB:} This function is now obsolete, please use
 \helpref{wxLogFatalError}{wxlogfatalerror} instead.
 
 Displays {\it msg} and exits. This writes to standard error under Unix,
 and pops up a message box under Windows. Used for fatal internal
 
 {\bf NB:} This function is now obsolete, please use
 \helpref{wxLogFatalError}{wxlogfatalerror} instead.
 
 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}.
+wxWidgets errors. See also \helpref{wxError}{wxerror}.

 
 \wxheading{Include files}
 
 <wx/utils.h>
 
 
 \wxheading{Include files}
 
 <wx/utils.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{...}{}}


@@ -3193,6 +3656,7 @@ The functions 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.
 
 to the user. The default processing is to pop up a message box to inform the
 user about it.
 

+

 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
 
 \func{void}{wxLogFatalError}{\param{const char *}{formatString}, \param{...}{}}
 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
 
 \func{void}{wxLogFatalError}{\param{const char *}{formatString}, \param{...}{}}


@@ -3203,6 +3667,7 @@ Like \helpref{wxLogError}{wxlogerror}, but also
 terminates the program with the exit code 3. Using {\it abort()} standard
 function also terminates the program with this exit code.
 
 terminates the program with the exit code 3. Using {\it abort()} standard
 function also terminates the program with this exit code.
 

+

 \membersection{::wxLogWarning}\label{wxlogwarning}
 
 \func{void}{wxLogWarning}{\param{const char *}{formatString}, \param{...}{}}
 \membersection{::wxLogWarning}\label{wxlogwarning}
 
 \func{void}{wxLogWarning}{\param{const char *}{formatString}, \param{...}{}}


@@ -3212,6 +3677,7 @@ function also terminates the program with this exit code.
 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{...}{}}


@@ -3224,6 +3690,7 @@ show informational messages if there are any errors later - the logic being
 that the later error messages make the informational messages preceding them
 meaningless.
 
 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{...}{}}


@@ -3234,6 +3701,7 @@ 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}).
 
 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{...}{}}
 \membersection{::wxLogStatus}\label{wxlogstatus}
 
 \func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{...}{}}


@@ -3250,13 +3718,14 @@ the second version of the functions).
 
 If the target frame doesn't have a statusbar, the message will be lost.
 
 
 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{...}{}}
 
 \func{void}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
 
 \membersection{::wxLogSysError}\label{wxlogsyserror}
 
 \func{void}{wxLogSysError}{\param{const char *}{formatString}, \param{...}{}}
 
 \func{void}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
 

-Mostly used by wxWindows itself, but might be handy for logging errors after
+Mostly used by wxWidgets 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
 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


@@ -3267,6 +3736,7 @@ of this function takes the error code explicitly as the first argument.
 \helpref{wxSysErrorCode}{wxsyserrorcode},
 \helpref{wxSysErrorMsg}{wxsyserrormsg}
 
 \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{...}{}}


@@ -3277,6 +3747,7 @@ The right functions for debug output. They only do something in debug
 mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expand to
 nothing in release mode (otherwise).
 
 mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expand 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{...}{}}


@@ -3304,8 +3775,10 @@ 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
 
 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:
+\helpref{AddTraceMask}{wxlogaddtracemask} or by setting
+\helpref{{\tt WXTRACE} environment variable}{envvars}.
+The predefined string trace masks
+used by wxWidgets are:

 
 \begin{itemize}\itemsep=0pt
 \item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
 
 \begin{itemize}\itemsep=0pt
 \item wxTRACE\_MemAlloc: trace memory allocation (new/delete)


@@ -3315,7 +3788,14 @@ used by wxWindows are:
 \item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
 \end{itemize}
 
 \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
+{\bf Caveats:} since both the mask and the format string are strings,
+this might lead to function signature confusion in some cases:
+if you intend to call the format string only version of wxLogTrace,
+then add a \%s format string parameter and then supply a second string parameter for that \%s, the string mask version of wxLogTrace will erroneously get called instead, since you are supplying two string parameters to the function.
+In this case you'll unfortunately have to avoid having two leading
+string parameters, e.g. by adding a bogus integer (with its \%d format string).
+
+The third version of the function only logs the message if all the bits

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


@@ -3330,6 +3810,7 @@ trace masks.
 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
 \end{itemize}
 
 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
 \end{itemize}
 

+

 \membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
 
 \func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}
 \membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
 
 \func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}


@@ -3356,6 +3837,7 @@ of the message string}
 
 <wx/log.h>
 
 
 <wx/log.h>
 

+

 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
 
 \func{unsigned long}{wxSysErrorCode}{\void}
 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
 
 \func{unsigned long}{wxSysErrorCode}{\void}


@@ -3368,6 +3850,7 @@ Returns the error code from the last system call. This function uses
 \helpref{wxSysErrorMsg}{wxsyserrormsg},
 \helpref{wxLogSysError}{wxlogsyserror}
 
 \helpref{wxSysErrorMsg}{wxsyserrormsg},
 \helpref{wxLogSysError}{wxlogsyserror}
 

+

 \membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
 
 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
 \membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
 
 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}


@@ -3381,6 +3864,7 @@ Returns the error message corresponding to the given system error code. If
 \helpref{wxSysErrorCode}{wxsyserrorcode},
 \helpref{wxLogSysError}{wxlogsyserror}
 
 \helpref{wxSysErrorCode}{wxsyserrorcode},
 \helpref{wxLogSysError}{wxlogsyserror}
 

+

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


@@ -3398,6 +3882,7 @@ is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugco
 
 <wx/memory.h>
 
 
 <wx/memory.h>
 

+

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


@@ -3414,6 +3899,7 @@ this value.
 
 <wx/memory.h>
 
 
 <wx/memory.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{...}{}}


@@ -3427,6 +3913,7 @@ is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugco
 
 <wx/memory.h>
 
 
 <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{...}{}}


@@ -3443,6 +3930,8 @@ this value.
 
 <wx/memory.h>
 
 
 <wx/memory.h>
 

+
+

 \section{Time functions}\label{timefunctions}
 
 The functions in this section deal with getting the current time and
 \section{Time functions}\label{timefunctions}
 
 The functions in this section deal with getting the current time and


@@ -3453,6 +3942,7 @@ should be used instead. For retrieving the current time, you may also use
 \helpref{wxDateTime::Now}{wxdatetimenow} or
 \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
 
 \helpref{wxDateTime::Now}{wxdatetimenow} or
 \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
 

+

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


@@ -3468,6 +3958,7 @@ See also \helpref{wxTimer}{wxtimer}.
 
 <wx/timer.h>
 
 
 <wx/timer.h>
 

+

 \membersection{::wxGetLocalTime}\label{wxgetlocaltime}
 
 \func{long}{wxGetLocalTime}{\void}
 \membersection{::wxGetLocalTime}\label{wxgetlocaltime}
 
 \func{long}{wxGetLocalTime}{\void}


@@ -3482,6 +3973,7 @@ Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
 
 <wx/timer.h>
 
 
 <wx/timer.h>
 

+

 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
 
 \func{wxLongLong}{wxGetLocalTimeMillis}{\void}
 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
 
 \func{wxLongLong}{wxGetLocalTimeMillis}{\void}


@@ -3497,6 +3989,7 @@ Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
 
 <wx/timer.h>
 
 
 <wx/timer.h>
 

+

 \membersection{::wxGetUTCTime}\label{wxgetutctime}
 
 \func{long}{wxGetUTCTime}{\void}
 \membersection{::wxGetUTCTime}\label{wxgetutctime}
 
 \func{long}{wxGetUTCTime}{\void}


@@ -3511,6 +4004,34 @@ Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
 
 <wx/timer.h>
 
 
 <wx/timer.h>
 

+
+\membersection{::wxMicroSleep}\label{wxmicrosleep}
+
+\func{void}{wxMicroSleep}{\param{unsigned long}{ microseconds}}
+
+Sleeps for the specified number of microseconds. The microsecond resolution may
+not, in fact, be available on all platforms (currently only Unix platforms with
+nanosleep(2) may provide it) in which case this is the same as
+\helpref{wxMilliSleep}{wxmillisleep}(\arg{microseconds}$/1000$).
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+
+\membersection{::wxMilliSleep}\label{wxmillisleep}
+
+\func{void}{wxMilliSleep}{\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{::wxNow}\label{wxnow}
 
 \func{wxString}{wxNow}{\void}
 \membersection{::wxNow}\label{wxnow}
 
 \func{wxString}{wxNow}{\void}


@@ -3521,6 +4042,7 @@ Returns a string representing the current date and time.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{::wxSleep}\label{wxsleep}
 
 \func{void}{wxSleep}{\param{int}{ secs}}
 \membersection{::wxSleep}\label{wxsleep}
 
 \func{void}{wxSleep}{\param{int}{ secs}}


@@ -3531,6 +4053,7 @@ Sleeps for the specified number of seconds.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

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


@@ -3543,22 +4066,22 @@ See also \helpref{wxTimer}{wxtimer}.
 
 <wx/timer.h>
 
 
 <wx/timer.h>
 

+

 \membersection{::wxUsleep}\label{wxusleep}
 
 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
 
 \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.
+This function is deprecated because its name is misleading: notice that the
+argument is in milliseconds, not microseconds. Please use either
+\helpref{wxMilliSleep}{wxmillisleep} or \helpref{wxMicroSleep}{wxmicrosleep}
+depending on the resolution you need.

 
 

-\wxheading{Include files}

 
 

-<wx/utils.h>

 
 \section{Debugging macros and functions}\label{debugmacros}
 
 Useful macros and functions for error checking and defensive programming.
 
 \section{Debugging macros and functions}\label{debugmacros}
 
 Useful macros and functions for error checking and defensive programming.

-wxWindows defines three families of the assert-like macros:
+wxWidgets defines three families of the assert-like macros:

 the wxASSERT and wxFAIL macros only do anything if \_\_WXDEBUG\_\_ is defined
 (in other words, in the debug build) but disappear completely in the release
 build. On the other hand, the wxCHECK macros stay event in release builds but a
 the wxASSERT and wxFAIL macros only do anything if \_\_WXDEBUG\_\_ is defined
 (in other words, in the debug build) but disappear completely in the release
 build. On the other hand, the wxCHECK macros stay event in release builds but a


@@ -3570,6 +4093,7 @@ compilation error messages if the condition they check fail.
 
 <wx/debug.h>
 
 
 <wx/debug.h>
 

+

 \membersection{::wxOnAssert}\label{wxonassert}
 
 \func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
 \membersection{::wxOnAssert}\label{wxonassert}
 
 \func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}


@@ -3584,6 +4108,7 @@ ignoring any subsequent assert failures, you may override
 \helpref{wxApp::OnAssert}{wxapponassert} which is called by this function if
 the global application object exists.
 
 \helpref{wxApp::OnAssert}{wxapponassert} which is called by this function if
 the global application object exists.
 

+

 \membersection{wxASSERT}\label{wxassert}
 
 \func{}{wxASSERT}{\param{}{condition}}
 \membersection{wxASSERT}\label{wxassert}
 
 \func{}{wxASSERT}{\param{}{condition}}


@@ -3599,6 +4124,7 @@ because it will not be executed in release mode at all.
 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
 
 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
 

+

 \membersection{wxASSERT\_MIN\_BITSIZE}\label{wxassertminbitsize}
 
 \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}}
 \membersection{wxASSERT\_MIN\_BITSIZE}\label{wxassertminbitsize}
 
 \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}}


@@ -3617,6 +4143,7 @@ You may use it like this, for example:
     wxASSERT_MIN_BITSIZE(wchar_t, 16);
 \end{verbatim}
 
     wxASSERT_MIN_BITSIZE(wchar_t, 16);
 \end{verbatim}
 

+

 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
 
 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
 
 \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}


@@ -3628,6 +4155,7 @@ Assert macro with message. An error message will be generated if the condition i
 \helpref{wxASSERT}{wxassert},\\
 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
 
 \helpref{wxASSERT}{wxassert},\\
 \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
 

+

 \membersection{wxCOMPILE\_TIME\_ASSERT}\label{wxcompiletimeassert}
 
 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}}
 \membersection{wxCOMPILE\_TIME\_ASSERT}\label{wxcompiletimeassert}
 
 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}}


@@ -3647,11 +4175,17 @@ use it on the same line in two different source files. In this case you may
 either change the line in which either of them appears on or use the
 \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro.
 
 either change the line in which either of them appears on or use the
 \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro.
 

+Also note that Microsoft Visual C++ has a bug which results in compiler errors
+if you use this macro with `Program Database For Edit And Continue'
+(\texttt{/ZI}) option, so you shouldn't use it (`Program Database'
+(\texttt{/Zi}) is ok though) for the code making use of this macro.
+

 \wxheading{See also}
 
 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
 \helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}
 
 \wxheading{See also}
 
 \helpref{wxASSERT\_MSG}{wxassertmsg},\\
 \helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}
 

+

 \membersection{wxCOMPILE\_TIME\_ASSERT2}\label{wxcompiletimeassert2}
 
 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}, \param{}{name}}
 \membersection{wxCOMPILE\_TIME\_ASSERT2}\label{wxcompiletimeassert2}
 
 \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}, \param{}{name}}


@@ -3661,6 +4195,7 @@ except that it allows you to specify a unique {\it name} for the struct
 internally defined by this macro to avoid getting the compilation errors
 described \helpref{above}{wxcompiletimeassert}.
 
 internally defined by this macro to avoid getting the compilation errors
 described \helpref{above}{wxcompiletimeassert}.
 

+

 \membersection{wxFAIL}\label{wxfail}
 
 \func{}{wxFAIL}{\void}
 \membersection{wxFAIL}\label{wxfail}
 
 \func{}{wxFAIL}{\void}


@@ -3669,6 +4204,7 @@ Will always generate an assert error if this code is reached (in debug mode).
 
 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
 
 
 See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
 

+

 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
 
 \func{}{wxFAIL\_MSG}{\param{}{msg}}
 \membersection{wxFAIL\_MSG}\label{wxfailmsg}
 
 \func{}{wxFAIL\_MSG}{\param{}{msg}}


@@ -3683,6 +4219,7 @@ cases are processed above.
 
 \helpref{wxFAIL}{wxfail}
 
 
 \helpref{wxFAIL}{wxfail}
 

+

 \membersection{wxCHECK}\label{wxcheck}
 
 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
 \membersection{wxCHECK}\label{wxcheck}
 
 \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}


@@ -3690,6 +4227,7 @@ cases are processed above.
 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
 This check is done even in release mode.
 
 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
 This check is done even in release mode.
 

+

 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
 
 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}
 \membersection{wxCHECK\_MSG}\label{wxcheckmsg}
 
 \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}}


@@ -3700,6 +4238,7 @@ This check is done even in release mode.
 This macro may be only used in non void functions, see also
 \helpref{wxCHECK\_RET}{wxcheckret}.
 
 This macro may be only used in non void functions, see also
 \helpref{wxCHECK\_RET}{wxcheckret}.
 

+

 \membersection{wxCHECK\_RET}\label{wxcheckret}
 
 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}
 \membersection{wxCHECK\_RET}\label{wxcheckret}
 
 \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}}


@@ -3710,6 +4249,7 @@ message in debug mode). This check is done even in release mode.
 This macro should be used in void functions instead of
 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
 
 This macro should be used in void functions instead of
 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
 

+

 \membersection{wxCHECK2}\label{wxcheck2}
 
 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
 \membersection{wxCHECK2}\label{wxcheck2}
 
 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}


@@ -3721,6 +4261,7 @@ returning from the function must be done when the {\it condition} is false.
 
 This check is done even in release mode.
 
 
 This check is done even in release mode.
 

+

 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
 
 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
 \membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
 
 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}


@@ -3729,6 +4270,7 @@ 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.
 

+

 \membersection{::wxTrap}\label{wxtrap}
 
 \func{void}{wxTrap}{\void}
 \membersection{::wxTrap}\label{wxtrap}
 
 \func{void}{wxTrap}{\void}


@@ -3744,15 +4286,17 @@ In release mode this function does nothing.
 <wx/debug.h>
 
 
 <wx/debug.h>
 
 

+

 \membersection{::wxIsDebuggerRunning}\label{wxisdebuggerrunning}
 
 \func{bool}{wxIsDebuggerRunning}{\void}
 
 \membersection{::wxIsDebuggerRunning}\label{wxisdebuggerrunning}
 
 \func{bool}{wxIsDebuggerRunning}{\void}
 

-Returns {\tt true} if the program is running under debugger, {\tt false} 
-otherwise.
+Returns \true if the program is running under debugger, \false otherwise.
+
+Please note that this function is currently only implemented for Win32 and Mac
+builds using CodeWarrior and always returns \false elsewhere.
+

 
 

-Please note that this function is currently only implemented for Mac builds
-using CodeWarrior and always returns {\tt false} elsewhere.

 
 
 \section{Environment access functions}\label{environfunctions}
 
 
 \section{Environment access functions}\label{environfunctions}


@@ -3767,6 +4311,7 @@ Win32 and POSIX-like systems (Unix).
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+

 \membersection{wxGetenv}\label{wxgetenvmacro}
 
 \func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}
 \membersection{wxGetenv}\label{wxgetenvmacro}
 
 \func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}


@@ -3778,6 +4323,7 @@ Note that under Win32 it may not return correct value for the variables set
 with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
 instead.
 
 with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
 instead.
 

+

 \membersection{wxGetEnv}\label{wxgetenv}
 
 \func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}
 \membersection{wxGetEnv}\label{wxgetenv}
 
 \func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}


@@ -3788,6 +4334,7 @@ and are not interested in its value.
 
 Returns {\tt true} if the variable exists, {\tt false} otherwise.
 
 
 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}}
 \membersection{wxSetEnv}\label{wxsetenv}
 
 \func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxChar *}{value}}


@@ -3797,6 +4344,7 @@ to {\it value}.
 
 Returns {\tt true} on success.
 
 
 Returns {\tt true} on success.
 

+

 \membersection{wxUnsetEnv}\label{wxunsetenv}
 
 \func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}
 \membersection{wxUnsetEnv}\label{wxunsetenv}
 
 \func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}