As per the wx-dev discussion in early Jan, replaced

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

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index 5975b0250d266433c4514aeb27390323d6d81f9d..35eeebcb3ee44e066b672640d1583391008afef1 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -2,7 +2,227 @@
 \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.
+The functions and macros defined in wxWindows are described here: you can
+either look up a function using the alphabetical listing of them or find it in
+the corresponding topic.
+
+\section{Alphabetical functions and macros list}
+
+\helpref{CLASSINFO}{classinfo}\\
+\helpref{copystring}{copystring}\\
+\helpref{DECLARE\_ABSTRACT\_CLASS}{declareabstractclass}\\
+\helpref{DECLARE\_APP}{declareapp}\\
+\helpref{DECLARE\_CLASS}{declareclass}\\
+\helpref{DECLARE\_DYNAMIC\_CLASS}{declaredynamicclass}\\
+\helpref{IMPLEMENT\_ABSTRACT\_CLASS2}{implementabstractclass2}\\
+\helpref{IMPLEMENT\_ABSTRACT\_CLASS}{implementabstractclass}\\
+\helpref{IMPLEMENT\_APP}{implementapp}\\
+\helpref{IMPLEMENT\_CLASS2}{implementclass2}\\
+\helpref{IMPLEMENT\_CLASS}{implementclass}\\
+\helpref{IMPLEMENT\_DYNAMIC\_CLASS2}{implementdynamicclass2}\\
+\helpref{IMPLEMENT\_DYNAMIC\_CLASS}{implementdynamicclass}\\
+\helpref{WXDEBUG\_NEW}{debugnew}\\
+\helpref{WXTRACELEVEL}{tracelevel}\\
+\helpref{WXTRACE}{trace}\\
+\helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}\\
+\helpref{wxASSERT\_MSG}{wxassertmsg}\\
+\helpref{wxASSERT}{wxassert}\\
+\helpref{wxBITMAP}{wxbitmapmacro}\\
+\helpref{wxBeginBusyCursor}{wxbeginbusycursor}\\
+\helpref{wxBell}{wxbell}\\
+\helpref{wxCHECK2\_MSG}{wxcheck2msg}\\
+\helpref{wxCHECK2}{wxcheck2}\\
+\helpref{wxCHECK\_MSG}{wxcheckmsg}\\
+\helpref{wxCHECK\_RET}{wxcheckret}\\
+\helpref{wxCHECK\_VERSION}{wxcheckversion}\\
+\helpref{wxCHECK}{wxcheck}\\
+\helpref{wxClientDisplayRect}{wxclientdisplayrect}\\
+\helpref{wxClipboardOpen}{wxclipboardopen}\\
+\helpref{wxCloseClipboard}{wxcloseclipboard}\\
+\helpref{wxColourDisplay}{wxcolourdisplay}\\
+\helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}\\
+\helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}\\
+\helpref{wxConcatFiles}{wxconcatfiles}\\
+\helpref{wxConstCast}{wxconstcast}\\
+\helpref{wxCopyFile}{wxcopyfile}\\
+\helpref{wxCreateDynamicObject}{wxcreatedynamicobject}\\
+\helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider}\\
+\helpref{wxDDECleanUp}{wxddecleanup}\\
+\helpref{wxDDEInitialize}{wxddeinitialize}\\
+\helpref{wxDROP\_ICON}{wxdropicon}\\
+\helpref{wxDebugMsg}{wxdebugmsg}\\
+\helpref{wxDirExists}{wxdirexists}\\
+\helpref{wxDirSelector}{wxdirselector}\\
+\helpref{wxDisplayDepth}{wxdisplaydepth}\\
+\helpref{wxDisplaySizeMM}{wxdisplaysizemm}\\
+\helpref{wxDisplaySize}{wxdisplaysize}\\
+\helpref{wxDisplaySize}{wxdisplaysize}\\
+\helpref{wxDos2UnixFilename}{wxdos2unixfilename}\\
+\helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
+\helpref{wxDynamicCast}{wxdynamiccast}\\
+\helpref{wxEmptyClipboard}{wxemptyclipboard}\\
+\helpref{wxEnableTopLevelWindows}{wxenabletoplevelwindows}\\
+\helpref{wxEndBusyCursor}{wxendbusycursor}\\
+\helpref{wxEntry}{wxentry}\\
+\helpref{wxEnumClipboardFormats}{wxenumclipboardformats}\\
+\helpref{wxError}{wxerror}\\
+\helpref{wxExecute}{wxexecute}\\
+\helpref{wxExit}{wxexit}\\
+\helpref{wxFAIL\_MSG}{wxfailmsg}\\
+\helpref{wxFAIL}{wxfail}\\
+\helpref{wxFatalError}{wxfatalerror}\\
+\helpref{wxFileExists}{wxfileexists}\\
+\helpref{wxFileModificationTime}{wxfilemodificationtime}\\
+\helpref{wxFileNameFromPath}{wxfilenamefrompath}\\
+\helpref{wxFileSelector}{wxfileselector}\\
+\helpref{wxFindFirstFile}{wxfindfirstfile}\\
+\helpref{wxFindMenuItemId}{wxfindmenuitemid}\\
+\helpref{wxFindNextFile}{wxfindnextfile}\\
+\helpref{wxFindWindowAtPointer}{wxfindwindowatpointer}\\
+\helpref{wxFindWindowAtPoint}{wxfindwindowatpoint}\\
+\helpref{wxFindWindowByLabel}{wxfindwindowbylabel}\\
+\helpref{wxFindWindowByName}{wxfindwindowbyname}\\
+\helpref{wxGetActiveWindow}{wxgetactivewindow}\\
+\helpref{wxGetClipboardData}{wxgetclipboarddata}\\
+\helpref{wxGetClipboardFormatName}{wxgetclipboardformatname}\\
+\helpref{wxGetColourFromUser}{wxgetcolourfromuser}\\
+\helpref{wxGetCwd}{wxgetcwd}\\
+\helpref{wxGetDiskSpace}{wxgetdiskspace}\\
+\helpref{wxGetDisplayName}{wxgetdisplayname}\\
+\helpref{wxGetElapsedTime}{wxgetelapsedtime}\\
+\helpref{wxGetEmailAddress}{wxgetemailaddress}\\
+\helpref{wxGetEnv}{wxgetenv}\\
+\helpref{wxGetFontFromUser}{wxgetfontfromuser}\\
+\helpref{wxGetFreeMemory}{wxgetfreememory}\\
+\helpref{wxGetFullHostName}{wxgetfullhostname}\\
+\helpref{wxGetHomeDir}{wxgethomedir}\\
+\helpref{wxGetHostName}{wxgethostname}\\
+\helpref{wxGetLocalTimeMillis}{wxgetlocaltimemillis}\\
+\helpref{wxGetLocalTime}{wxgetlocaltime}\\
+\helpref{wxGetMousePosition}{wxgetmouseposition}\\
+\helpref{wxGetMultipleChoices}{wxgetmultiplechoices}\\
+\helpref{wxGetMultipleChoice}{wxgetmultiplechoice}\\
+\helpref{wxGetNumberFromUser}{wxgetnumberfromuser}\\
+\helpref{wxGetOSDirectory}{wxgetosdirectory}\\
+\helpref{wxGetOsDescription}{wxgetosdescription}\\
+\helpref{wxGetOsVersion}{wxgetosversion}\\
+\helpref{wxGetPasswordFromUser}{wxgetpasswordfromuser}\\
+\helpref{wxGetPrinterCommand}{wxgetprintercommand}\\
+\helpref{wxGetPrinterFile}{wxgetprinterfile}\\
+\helpref{wxGetPrinterMode}{wxgetprintermode}\\
+\helpref{wxGetPrinterOptions}{wxgetprinteroptions}\\
+\helpref{wxGetPrinterOrientation}{wxgetprinterorientation}\\
+\helpref{wxGetPrinterPreviewCommand}{wxgetprinterpreviewcommand}\\
+\helpref{wxGetPrinterScaling}{wxgetprinterscaling}\\
+\helpref{wxGetPrinterTranslation}{wxgetprintertranslation}\\
+\helpref{wxGetResource}{wxgetresource}\\
+\helpref{wxGetSingleChoiceData}{wxgetsinglechoicedata}\\
+\helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex}\\
+\helpref{wxGetSingleChoice}{wxgetsinglechoice}\\
+\helpref{wxGetTempFileName}{wxgettempfilename}\\
+\helpref{wxGetTextFromUser}{wxgettextfromuser}\\
+\helpref{wxGetTranslation}{wxgettranslation}\\
+\helpref{wxGetUTCTime}{wxgetutctime}\\
+\helpref{wxGetUserHome}{wxgetuserhome}\\
+\helpref{wxGetUserId}{wxgetuserid}\\
+\helpref{wxGetUserName}{wxgetusername}\\
+\helpref{wxGetWorkingDirectory}{wxgetworkingdirectory}\\
+\helpref{wxGetenv}{wxgetenvmacro}\\
+\helpref{wxHandleFatalExceptions}{wxhandlefatalexceptions}\\
+\helpref{wxICON}{wxiconmacro}\\
+\helpref{wxINTXX\_SWAP\_ALWAYS}{intswapalways}\\
+\helpref{wxINTXX\_SWAP\_ON\_BE}{intswaponbe}\\
+\helpref{wxINTXX\_SWAP\_ON\_LE}{intswaponle}\\
+\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}\\
+\helpref{wxInitialize}{wxinitialize}\\
+\helpref{wxIsAbsolutePath}{wxisabsolutepath}\\
+\helpref{wxIsBusy}{wxisbusy}\\
+\helpref{wxIsClipboardFormatAvailable}{wxisclipboardformatavailable}\\
+\helpref{wxIsEmpty}{wxisempty}\\
+\helpref{wxIsWild}{wxiswild}\\
+\helpref{wxKill}{wxkill}\\
+\helpref{wxLoadUserResource}{wxloaduserresource}\\
+\helpref{wxLogDebug}{wxlogdebug}\\
+\helpref{wxLogError}{wxlogerror}\\
+\helpref{wxLogFatalError}{wxlogfatalerror}\\
+\helpref{wxLogMessage}{wxlogmessage}\\
+\helpref{wxLogStatus}{wxlogstatus}\\
+\helpref{wxLogSysError}{wxlogsyserror}\\
+\helpref{wxLogTrace}{wxlogtrace}\\
+\helpref{wxLogVerbose}{wxlogverbose}\\
+\helpref{wxLogWarning}{wxlogwarning}\\
+\helpref{wxMakeMetafilePlaceable}{wxmakemetafileplaceable}\\
+\helpref{wxMatchWild}{wxmatchwild}\\
+\helpref{wxMessageBox}{wxmessagebox}\\
+\helpref{wxMkdir}{wxmkdir}\\
+\helpref{wxMutexGuiEnter}{wxmutexguienter}\\
+\helpref{wxMutexGuiLeave}{wxmutexguileave}\\
+\helpref{wxNewId}{wxnewid}\\
+\helpref{wxNow}{wxnow}\\
+\helpref{wxOnAssert}{wxonassert}\\
+\helpref{wxOpenClipboard}{wxopenclipboard}\\
+\helpref{wxPathOnly}{wxpathonly}\\
+\helpref{wxPostDelete}{wxpostdelete}\\
+\helpref{wxPostEvent}{wxpostevent}\\
+\helpref{wxRegisterClipboardFormat}{wxregisterclipboardformat}\\
+\helpref{wxRegisterId}{wxregisterid}\\
+\helpref{wxRemoveFile}{wxremovefile}\\
+\helpref{wxRenameFile}{wxrenamefile}\\
+\helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}\\
+\helpref{wxResourceClear}{wxresourceclear}\\
+\helpref{wxResourceCreateBitmap}{wxresourcecreatebitmap}\\
+\helpref{wxResourceCreateIcon}{wxresourcecreateicon}\\
+\helpref{wxResourceCreateMenuBar}{wxresourcecreatemenubar}\\
+\helpref{wxResourceGetIdentifier}{wxresourcegetidentifier}\\
+\helpref{wxResourceParseData}{wxresourcedata}\\
+\helpref{wxResourceParseFile}{wxresourceparsefile}\\
+\helpref{wxResourceParseString}{wxresourceparsestring}\\
+\helpref{wxResourceRegisterBitmapData}{registerbitmapdata}\\
+\helpref{wxResourceRegisterIconData}{wxresourceregistericondata}\\
+\helpref{wxRmdir}{wxrmdir}\\
+\helpref{wxSafeYield}{wxsafeyield}\\
+\helpref{wxSetClipboardData}{wxsetclipboarddata}\\
+\helpref{wxSetCursor}{wxsetcursor}\\
+\helpref{wxSetDisplayName}{wxsetdisplayname}\\
+\helpref{wxSetEnv}{wxsetenv}\\
+\helpref{wxSetPrinterCommand}{wxsetprintercommand}\\
+\helpref{wxSetPrinterFile}{wxsetprinterfile}\\
+\helpref{wxSetPrinterMode}{wxsetprintermode}\\
+\helpref{wxSetPrinterOptions}{wxsetprinteroptions}\\
+\helpref{wxSetPrinterOrientation}{wxsetprinterorientation}\\
+\helpref{wxSetPrinterPreviewCommand}{wxsetprinterpreviewcommand}\\
+\helpref{wxSetPrinterScaling}{wxsetprinterscaling}\\
+\helpref{wxSetPrinterTranslation}{wxsetprintertranslation}\\
+\helpref{wxSetWorkingDirectory}{wxsetworkingdirectory}\\
+\helpref{wxShell}{wxshell}\\
+\helpref{wxShowTip}{wxshowtip}\\
+\helpref{wxSleep}{wxsleep}\\
+\helpref{wxSnprintf}{wxsnprintf}\\
+\helpref{wxSplitPath}{wxsplitfunction}\\
+\helpref{wxStartTimer}{wxstarttimer}\\
+\helpref{wxStaticCast}{wxstaticcast}\\
+\helpref{wxStricmp}{wxstricmp}\\
+\helpref{wxStringEq}{wxstringeq}\\
+\helpref{wxStringMatch}{wxstringmatch}\\
+\helpref{wxStripMenuCodes}{wxstripmenucodes}\\
+\helpref{wxStrlen}{wxstrlen}\\
+\helpref{wxSysErrorCode}{wxsyserrorcode}\\
+\helpref{wxSysErrorMsg}{wxsyserrormsg}\\
+\helpref{wxToLower}{wxtolower}\\
+\helpref{wxToUpper}{wxtoupper}\\
+\helpref{wxTraceLevel}{wxtracelevel}\\
+\helpref{wxTrace}{wxtrace}\\
+\helpref{wxTransferFileToStream}{wxtransferfiletostream}\\
+\helpref{wxTransferStreamToFile}{wxtransferstreamtofile}\\
+\helpref{wxTrap}{wxtrap}\\
+\helpref{wxUninitialize}{wxuninitialize}\\
+\helpref{wxUnix2DosFilename}{wxunix2dosfilename}\\
+\helpref{wxUnsetEnv}{wxunsetenv}\\
+\helpref{wxUsleep}{wxusleep}\\
+\helpref{wxVsnprintf}{wxvsnprintf}\\
+\helpref{wxWakeUpIdle}{wxwakeupidle}\\
+\helpref{wxWriteResource}{wxwriteresource}\\
+\helpref{wxYield}{wxyield}

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


@@ -11,7 +231,7 @@ The following constants are defined in wxWindows:
 \begin{itemize}\itemsep=0pt
 \item {\tt wxMAJOR\_VERSION} is the major version of wxWindows
 \item {\tt wxMINOR\_VERSION} is the minor version of wxWindows
 \begin{itemize}\itemsep=0pt
 \item {\tt wxMAJOR\_VERSION} is the major version of wxWindows
 \item {\tt wxMINOR\_VERSION} is the minor version of wxWindows

-\item {\tt wxRELASE\_NUMBER} is the release number
+\item {\tt wxRELEASE\_NUMBER} is the release number

 \end{itemize}
 
 For example, the values or these constants for wxWindows 2.1.15 are 2, 1 and
 \end{itemize}
 
 For example, the values or these constants for wxWindows 2.1.15 are 2, 1 and


@@ -48,6 +268,300 @@ the following can be done:
     }
 \end{verbatim}
 
     }
 \end{verbatim}
 

+\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}
+
+This initializes wxWindows in a platform-dependent way. Use this if you
+are not using the default wxWindows entry code (e.g. main or WinMain). For example,
+you can initialize wxWindows from an Microsoft Foundation Classes application using
+this function.
+
+\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
+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).
+
+\func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
+
+wxWindows initialization under Unix.
+
+\wxheading{Remarks}
+
+To clean up wxWindows, call wxApp::OnExit followed by the static function
+wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
+
+\begin{verbatim}
+int CTheApp::ExitInstance()
+{
+  // OnExit isn't called by CleanUp so must be called explicitly.
+  wxTheApp->OnExit();
+  wxApp::CleanUp();
+
+  return CWinApp::ExitInstance();
+}
+\end{verbatim}
+
+\wxheading{Include files}
+
+<wx/app.h>
+
+\membersection{::wxHandleFatalExceptions}\label{wxhandlefatalexceptions}
+
+\func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = TRUE}}
+
+If {\it doIt} is TRUE, the fatal exceptions (also known as general protection
+faults under Windows or segmentation violations in the Unix world) will be
+caught and passed to \helpref{wxApp::OnFatalException}{wxapponfatalexception}.
+By default, i.e. before this function is called, they will be handled in the
+normal way which usually just means that the application will be terminated.
+Calling wxHandleFatalExceptions() with {\it doIt} equal to FALSE will restore
+this default behaviour.
+
+\membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
+
+\func{void}{wxInitAllImageHandlers}{\void}
+
+Initializes all available image handlers. For a list of available handlers,
+see \helpref{wxImage}{wximage}.
+
+\wxheading{See also}
+
+\helpref{wxImage}{wximage}, \helpref{wxImageHandler}{wximagehandler}
+
+\wxheading{Include files}
+
+<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
+{\tt main()} function before calling any other wxWindows functions.
+
+If the function returns {\tt FALSE} the initialization could not be performed,
+in this case the library cannot be used and
+\helpref{wxUninitialize}{wxuninitialize} shouldn't be called neither.
+
+This function may be called several times but
+\helpref{wxUninitialize}{wxuninitialize} must be called for each successful
+call to this function.
+
+\wxheading{Include files}
+
+<wx/app.h>
+
+\membersection{::wxSafeYield}\label{wxsafeyield}
+
+\func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
+
+This function is similar to wxYield, except that it disables the user input to
+all program windows before calling wxYield and re-enables it again
+afterwards. If {\it win} is not NULL, this window will remain enabled,
+allowing the implementation of some limited user interaction.
+
+Returns the result of the call to \helpref{::wxYield}{wxyield}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxUninitialize}\label{wxuninitialize}
+
+\func{void}{wxUninitialize}{\void}
+
+This function is for use in console (wxBase) programs only. It must be called
+once for each previous successful call to \helpref{wxInitialize}{wxinitialize}.
+
+\wxheading{Include files}
+
+<wx/app.h>
+
+\membersection{::wxYield}\label{wxyield}
+
+\func{bool}{wxYield}{\void}
+
+Calls \helpref{wxApp::Yield}{wxappyield}.
+
+This function is kept only for backwards compatibility, please use 
+\helpref{wxApp::Yield}{wxappyield}method instead in any new code.
+
+\wxheading{Include files}
+
+<wx/app.h> or <wx/utils.h>
+
+\membersection{::wxWakeUpIdle}\label{wxwakeupidle}
+
+\func{void}{wxWakeUpIdle}{\void}
+
+This functions wakes up the (internal and platform dependent) idle system, i.e. it
+will force the system to send an idle event even if the system currently {\it is}
+ idle and thus would not send any idle event until after some other event would get
+sent. This is also useful for sending events between two threads and is used by
+the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and
+\helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
+
+\wxheading{Include files}
+
+<wx/app.h>
+
+\section{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{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
+
+\func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
+
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
+
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}}
+
+Executes another program in Unix or Windows.
+
+The first form takes a command string, such as {\tt "emacs file.txt"}.
+
+The second form takes an array of values: a command, any number of
+arguments, terminated by NULL.
+
+The semantics of the third and fourth versions is different from the first two
+and is described in more details below.
+
+If {\it sync} is FALSE (the default), flow of control immediately returns.
+If TRUE, the current application waits until the other program has terminated.
+
+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
+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}.
+
+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
+complication, the return value of $-1$ in this case indicattes that we didn't
+launch a new process, but connected to the running one (this can only happen in
+case of using DDE under Windows for command execution). In particular, in this,
+and only this, case the calling code will not get the notification about
+process termination.
+
+If callback isn't NULL and if execution is asynchronous (note that callback
+parameter can not be non-NULL for synchronous execution),
+\helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
+the process finishes.
+
+Finally, you may use the third overloaded version of this function to execute
+a process (always synchronously) and capture its output in the array
+{\it output}. The fourth version adds the possibility to additionally capture
+the messages from standard error output in the {\it errors} array.
+
+See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
+\helpref{Exec sample}{sampleexec}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxExit}\label{wxexit}
+
+\func{void}{wxExit}{\void}
+
+Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
+Should only be used in an emergency: normally the top-level frame
+should be deleted (after deleting all other frames) to terminate the
+application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
+
+\wxheading{Include files}
+
+<wx/app.h>
+
+\membersection{::wxKill}\label{wxkill}
+
+\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}}
+
+Equivalent to the Unix kill function: send the given signal {\it sig} to the
+process with PID {\it pid}. The valud signal values are
+
+\begin{verbatim}
+enum wxSignal
+{
+    wxSIGNONE = 0,  // verify if the process exists under Unix
+    wxSIGHUP,
+    wxSIGINT,
+    wxSIGQUIT,
+    wxSIGILL,
+    wxSIGTRAP,
+    wxSIGABRT,
+    wxSIGEMT,
+    wxSIGFPE,
+    wxSIGKILL,      // forcefully kill, dangerous!
+    wxSIGBUS,
+    wxSIGSEGV,
+    wxSIGSYS,
+    wxSIGPIPE,
+    wxSIGALRM,
+    wxSIGTERM       // terminate the process gently
+};
+\end{verbatim}
+
+{\tt wxSIGNONE}, {\tt wxSIGKILL} and {\tt wxSIGTERM} have the same meaning
+under both Unix and Windows but all the other signals are equivalent to
+{\tt wxSIGTERM} under Windows.
+
+Returns 0 on success, -1 on failure. If {\it rc} parameter is not NULL, it will
+be filled with an element of {\tt wxKillError} enum:
+
+\begin{verbatim}
+enum wxKillError
+{
+    wxKILL_OK,              // no error
+    wxKILL_BAD_SIGNAL,      // no such signal
+    wxKILL_ACCESS_DENIED,   // permission denied
+    wxKILL_NO_PROCESS,      // no such process
+    wxKILL_ERROR            // another, unspecified error
+};
+\end{verbatim}
+
+\wxheading{See also}
+
+\helpref{wxProcess::Kill}{wxprocesskill},\rtfsp
+\helpref{wxProcess::Exists}{wxprocessexists},\rtfsp
+\helpref{Exec sample}{sampleexec}
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxShell}\label{wxshell}
+
+\func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
+
+Executes a command in an interactive shell window. If no command is
+specified, then just the shell is spawned.
+
+See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+

 \section{Thread functions}\label{threadfunctions}
 
 \wxheading{Include files}
 \section{Thread functions}\label{threadfunctions}
 
 \wxheading{Include files}


@@ -108,22 +622,25 @@ threads.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

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

 
 

-\membersection{::wxDirExists}
+\membersection{::wxDirExists}\label{wxdirexists}

 
 \func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
 
 Returns TRUE if the directory exists.
 
 
 \func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
 
 Returns TRUE if the directory exists.
 

-\membersection{::wxDos2UnixFilename}
+\membersection{::wxDos2UnixFilename}\label{wxdos2unixfilename}

 
 

-\func{void}{Dos2UnixFilename}{\param{const wxString\& }{s}}
+\func{void}{wxDos2UnixFilename}{\param{wxChar *}{s}}

 
 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}
+\membersection{::wxFileExists}\label{wxfileexists}

 
 \func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
 
 
 \func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
 


@@ -136,18 +653,18 @@ a directory.
 
 Returns time of last modification of given file.
 
 
 Returns time of last modification of given file.
 

-\membersection{::wxFileNameFromPath}
+\membersection{::wxFileNameFromPath}\label{wxfilenamefrompath}

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

-\func{char*}{wxFileNameFromPath}{\param{char* }{path}}
+\func{char *}{wxFileNameFromPath}{\param{char *}{path}}

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

 
 This function does directory searching; returns the first file
 that matches the path {\it spec}, or the empty string. Use \helpref{wxFindNextFile}{wxfindnextfile} to
 
 This function does directory searching; returns the first file
 that matches the path {\it spec}, or the empty string. Use \helpref{wxFindNextFile}{wxfindnextfile} to


@@ -177,33 +694,54 @@ 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}}
+
+This function returns the total number of bytes and number of free bytes on
+the disk containing the directory {\it path} (it should exist). Both
+{\it total} and {\it free} parameters may be {\tt NULL} if the corresponding
+information is not needed.
+
+\wxheading{Returns}
+
+{\tt TRUE} on success, {\tt FALSE} if an error occured (for example, the
+directory doesn't exist).
+
+\wxheading{Portability}
+
+This function is implemented for Win16 (only for drives less than 2Gb), Win32,
+Mac OS and generic Unix provided the system has {\tt statfs()} function.
+
+This function first appeared in wxWindows 2.3.2.
+

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

-\membersection{::wxIsAbsolutePath}
+\membersection{::wxIsAbsolutePath}\label{wxisabsolutepath}

 
 \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
 
 Returns TRUE if the argument is an absolute filename, i.e. with a slash
 or drive name at the beginning.
 
 
 \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
 
 Returns TRUE if the argument is an absolute filename, i.e. with a slash
 or drive name at the beginning.
 

-\membersection{::wxPathOnly}
+\membersection{::wxPathOnly}\label{wxpathonly}

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

-\membersection{::wxUnix2DosFilename}
+\membersection{::wxUnix2DosFilename}\label{wxunix2dosfilename}

 
 \func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}}
 
 Converts a Unix to a DOS filename by replacing forward
 slashes with backslashes.
 
 
 \func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}}
 
 Converts a Unix to a DOS filename by replacing forward
 slashes with backslashes.
 

-\membersection{::wxConcatFiles}
+\membersection{::wxConcatFiles}\label{wxconcatfiles}

 
 \func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2},
 \param{const wxString\& }{file3}}
 
 \func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2},
 \param{const wxString\& }{file3}}


@@ -211,11 +749,14 @@ 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}
+\membersection{::wxCopyFile}\label{wxcopyfile}

 
 

-\func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
+\func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = TRUE}}

 
 

-Copies {\it file1} to {\it file2}, returning TRUE if successful.
+Copies {\it file1} to {\it file2}, returning TRUE if successful. If
+{\it overwrite} parameter is TRUE (default), the destination file is overwritten
+if it exists, but if {\it overwrite} is FALSE, the functions failes in this
+case.

 
 \membersection{::wxGetCwd}\label{wxgetcwd}
 
 
 \membersection{::wxGetCwd}\label{wxgetcwd}
 


@@ -223,9 +764,9 @@ Copies {\it file1} to {\it file2}, returning TRUE if successful.
 
 Returns a string containing the current (or working) directory.
 
 
 Returns a string containing the current (or working) directory.
 

-\membersection{::wxGetWorkingDirectory}
+\membersection{::wxGetWorkingDirectory}\label{wxgetworkingdirectory}

 
 

-\func{wxString}{wxGetWorkingDirectory}{\param{char*}{buf=NULL}, \param{int }{sz=1000}}
+\func{wxString}{wxGetWorkingDirectory}{\param{char *}{buf=NULL}, \param{int }{sz=1000}}

 
 This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.
 
 
 This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.
 


@@ -235,21 +776,25 @@ 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}
+\membersection{::wxGetTempFileName}\label{wxgettempfilename}

 
 

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

 
 \func{bool}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{wxString\& }{buf}}
 
 
 \func{bool}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{wxString\& }{buf}}
 

-Makes a temporary filename based on {\it prefix}, opens and closes the file,
-and places the name in {\it buf}. If {\it buf} is NULL, new store
-is allocated for the temporary filename using {\it new}.
-
-Under Windows, the filename will include the drive and name of the
-directory allocated for temporary files (usually the contents of the
-TEMP variable). Under Unix, the {\tt /tmp} directory is used.
-
-It is the application's responsibility to create and delete the file.
+%% Makes a temporary filename based on {\it prefix}, opens and closes the file,
+%% and places the name in {\it buf}. If {\it buf} is NULL, new store
+%% is allocated for the temporary filename using {\it new}.
+%%
+%% Under Windows, the filename will include the drive and name of the
+%% directory allocated for temporary files (usually the contents of the
+%% TEMP variable). Under Unix, the {\tt /tmp} directory is used.
+%%
+%% It is the application's responsibility to create and delete the file.
+
+These functions are obsolete, please use\rtfsp
+\helpref{wxFileName::CreateTempFileName}{wxfilenamecreatetempfilename}\rtfsp
+instead.

 
 \membersection{::wxIsWild}\label{wxiswild}
 
 
 \membersection{::wxIsWild}\label{wxiswild}
 


@@ -265,7 +810,7 @@ Returns TRUE if the {\it 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}
+\membersection{::wxMkdir}\label{wxmkdir}

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


@@ -274,19 +819,19 @@ Makes the directory {\it 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{::wxRemoveFile}
+\membersection{::wxRemoveFile}\label{wxremovefile}

 
 \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
 
 Removes {\it file}, returning TRUE if successful.
 
 
 \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
 
 Removes {\it file}, returning TRUE if successful.
 

-\membersection{::wxRenameFile}
+\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.
 
 
 \func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
 
 Renames {\it file1} to {\it file2}, returning TRUE if successful.
 

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

 
 \func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
 
 
 \func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
 


@@ -294,7 +839,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}
+\membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory}

 
 \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
 
 
 \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
 


@@ -329,7 +874,9 @@ are not NULL).
 Copies the given file to {\it stream}. Useful when converting an old application to
 use streams (within the document/view framework, for example).
 
 Copies the given file to {\it stream}. Useful when converting an old application to
 use streams (within the document/view framework, for example).
 

-Use of this function requires the file wx\_doc.h to be included.
+\wxheading{Include files}
+
+<wx/docview.h>

 
 \membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
 
 
 \membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
 


@@ -338,9 +885,26 @@ Use of this function requires the file wx\_doc.h to be included.
 Copies the given stream to the file {\it filename}. Useful when converting an old application to
 use streams (within the document/view framework, for example).
 
 Copies the given stream to the file {\it filename}. Useful when converting an old application to
 use streams (within the document/view framework, for example).
 

-Use of this function requires the file wx\_doc.h to be included.
+\wxheading{Include files}
+
+<wx/docview.h>

 
 

-\section{Network functions}\label{networkfunctions}
+\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{::wxGetFreeMemory}\label{wxgetfreememory}
+
+\func{long}{wxGetFreeMemory}{\void}
+
+Returns the amount of free memory in bytes under environments which
+support it, and -1 if not supported. Currently, it is supported only
+under Windows, Linux and Solaris.
+
+\wxheading{Include files}
+
+<wx/utils.h>

 
 \membersection{::wxGetFullHostName}\label{wxgetfullhostname}
 
 
 \membersection{::wxGetFullHostName}\label{wxgetfullhostname}
 


@@ -371,9 +935,23 @@ Returns TRUE if successful, FALSE otherwise.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

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

 
 

-\func{wxString}{wxGetHostName}{\void}
+\func{wxString}{wxGetHomeDir}{\void}
+
+Return the (current) user's home directory.
+
+\wxheading{See also}
+
+\helpref{wxGetUserHome}{wxgetuserhome}
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxGetHostName}\label{wxgethostname}
+
+\func{wxString}{wxGetHostName}{\void}

 
 \func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
 
 
 \func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
 


@@ -397,8 +975,6 @@ if successful, FALSE otherwise.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\section{User identification}\label{useridfunctions}
-

 \membersection{::wxGetUserId}\label{wxgetuserid}
 
 \func{wxString}{wxGetUserId}{\void}
 \membersection{::wxGetUserId}\label{wxgetuserid}
 
 \func{wxString}{wxGetUserId}{\void}


@@ -424,6 +1000,62 @@ if successful, FALSE otherwise.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

+\membersection{::wxGetOsDescription}\label{wxgetosdescription}
+
+\func{wxString}{wxGetOsDescription}{\void}
+
+Returns the string containing the description of the current platform in a
+user-readable form. For example, this function may return strings like
+{\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
+
+\wxheading{See also}
+
+\helpref{::wxGetOsVersion}{wxgetosversion}
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxGetOsVersion}\label{wxgetosversion}
+
+\func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
+
+Gets operating system version information.
+
+\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{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }
+\twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
+\twocolitem{OS/2}{Return value is wxOS2\_PM.}
+\twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
+\twocolitem{Windows NT/2000}{Return value is wxWINDOWS\_NT, version is returned in {\it major} and {\it minor}}
+\twocolitem{Windows 98}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 1 or greater.}
+\twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 0.}
+\twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
+\twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
+\end{twocollist}
+
+\wxheading{See also}
+
+\helpref{::wxGetOsDescription}{wxgetosdescription}
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxGetUserHome}\label{wxgetuserhome}
+
+\func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
+
+Returns the home directory for the given user. If the username is empty
+(default value), this function behaves like 
+\helpref{wxGetHomeDir}{wxgethomedir}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+

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


@@ -438,8 +1070,8 @@ is running, the entry {\bf Current} in the section {\bf User} of
 the PENWIN.INI file is used.
 
 The first variant of this function returns the user name if successful or an
 the PENWIN.INI file is used.
 
 The first variant of this function returns the user name if successful or an

-empty string otherwise. The second (deprecated) function returns TRUE
-if successful, FALSE otherwise.
+empty string otherwise. The second (deprecated) function returns {\tt TRUE}
+if successful, {\tt FALSE} otherwise.

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


@@ -451,22 +1083,43 @@ if successful, FALSE otherwise.
 
 \section{String functions}
 
 
 \section{String functions}
 

-\membersection{::copystring}
+\membersection{::copystring}\label{copystring}

 
 

-\func{char*}{copystring}{\param{const char* }{s}}
+\func{char *}{copystring}{\param{const char *}{s}}

 
 Makes a copy of the string {\it s} using the C++ new operator, so it can be
 deleted with the {\it delete} operator.
 
 
 Makes a copy of the string {\it s} using the C++ new operator, so it can be
 deleted with the {\it delete} operator.
 

-\membersection{::wxStringMatch}
+This function is deprecated, use \helpref{wxString}{wxstring} class instead.
+
+\membersection{::wxIsEmpty}\label{wxisempty}
+
+\func{bool}{wxIsEmpty}{\param{const char *}{ p}}
+
+Returns {\tt TRUE} if the pointer is either {\tt NULL} or points to an empty
+string, {\tt FALSE} otherwise.
+
+\membersection{::wxStricmp}\label{wxstricmp}
+
+\func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}}
+
+Returns a negative value, 0, or positive value if {\it p1} is less than, equal
+to or greater than {\it p2}. The comparison is case-insensitive.
+
+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},\\
   \param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}}
 
 
 \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
   \param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}}
 

-Returns TRUE if the substring {\it s1} is found within {\it s2},
-ignoring case if {\it exact} is FALSE. If {\it subString} is FALSE,
+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.
 
 no substring matching is done.
 

+This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
+

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


@@ -477,36 +1130,21 @@ 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{::IsEmpty}\label{isempty}
-
-\func{bool}{IsEmpty}{\param{const char *}{ p}}
-
-Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL
-pointer to this function and it will return TRUE for it.
-
-\membersection{::Stricmp}\label{stricmp}
+This function is obsolete, use \helpref{wxString}{wxstring} instead.

 
 

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

 
 

-Returns a negative value, 0, or positive value if {\it p1} is less than, equal
-to or greater than {\it p2}. The comparison is case-insensitive.
-
-This function complements the standard C function {\it strcmp()} which performs
-case-sensitive comparison.
-
-\membersection{::Strlen}\label{strlen}
-
-\func{size\_t}{Strlen}{\param{const char *}{ p}}
+\func{size\_t}{wxStrlen}{\param{const char *}{ p}}

 
 This is a safe version of standard function {\it strlen()}: it does exactly the
 
 This is a safe version of standard function {\it strlen()}: it does exactly the

-same thing (i.e. returns the length of the string) except that it returns 0 if 
-{\it p} is the NULL pointer.
+same thing (i.e. returns the length of the string) except that it returns 0 if
+{\it p} is the {\tt NULL} pointer.

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

-This function returns the translation of string {\it str} in the current 
+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
 original string is returned. In debug build, an error message is logged - this
 \helpref{locale}{wxlocale}. If the string is not found in any of the loaded
 message catalogs (see \helpref{internationalization overview}{internationalization}), the
 original string is returned. In debug build, an error message is logged - this


@@ -530,11 +1168,31 @@ enough space.
 
 \helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}
 
 
 \helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}
 

+\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}
 
 \membersection{::wxVsnprintf}\label{wxvsnprintf}
 

-\func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argptr}}
+\func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}}

 
 

-The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list}
+The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list }

 argument instead of arbitrary number of parameters.
 
 \wxheading{See also}
 argument instead of arbitrary number of parameters.
 
 \wxheading{See also}


@@ -549,6 +1207,31 @@ 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}}
+
+Changes the cursor to the given cursor for all windows in the application.
+Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
+to its previous state. These two calls can be nested, and a counter
+ensures that only the outer calls take effect.
+
+See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxBell}\label{wxbell}
+
+\func{void}{wxBell}{\void}
+
+Ring the system bell.
+
+\wxheading{Include files}
+
+<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},


@@ -569,6 +1252,32 @@ 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},\\
+ \param{const wxString\& }{default\_path = ""},\\
+ \param{long }{style = 0}, \param{const wxPoint\& }{pos = wxDefaultPosition},\\
+ \param{wxWindow *}{parent = NULL}}
+
+Pops up a directory selector dialog. The arguments have the same meaning as
+those of wxDirDialog::wxDirDialog(). The message is displayed at the top,
+and the default\_path, if specified, is set as the initial selection.
+
+The application must check for an empty return value (if the user pressed
+Cancel). For example:
+
+\begin{verbatim}
+const wxString& dir = wxDirSelector("Choose a folder");
+if ( !dir.empty() )
+{
+  ...
+}
+\end{verbatim}
+
+\wxheading{Include files}
+
+<wx/dirdlg.h>
+

 \membersection{::wxFileSelector}\label{wxfileselector}
 
 \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\
 \membersection{::wxFileSelector}\label{wxfileselector}
 
 \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\


@@ -590,7 +1299,7 @@ filename containing wildcards (*, ?) in the filename text item, and
 clicking on Ok, will result in only those files matching the pattern being
 displayed.
 
 clicking on Ok, will result in only those files matching the pattern being
 displayed.
 

-The wildcard may be a specification for multiple types of file 
+The wildcard may be a specification for multiple types of file

 with a description for each, such as:
 
 \begin{verbatim}
 with a description for each, such as:
 
 \begin{verbatim}


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

+\membersection{::wxEndBusyCursor}\label{wxendbusycursor}
+
+\func{void}{wxEndBusyCursor}{\void}
+
+Changes the cursor back to the original cursor, for all windows in the application.
+Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
+
+See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
+
+\wxheading{Include files}
+
+<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}}


@@ -630,6 +1352,68 @@ 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}}
+
+Shows the font selection dialog and returns the font selected by user or
+invalid font (use \helpref{wxFont::Ok}{wxfontok} to test whether a font
+is valid) if the dialog was cancelled.
+
+\wxheading{Parameters}
+
+\docparam{parent}{The parent window for the font selection dialog}
+
+\docparam{fontInit}{If given, this will be the font initially selected in the dialog.}
+
+\wxheading{Include files}
+
+<wx/fontdlg.h>
+
+
+\membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
+
+\func{size\_t}{wxGetMultipleChoices}{\\
+ \param{wxArrayInt\& }{selections},\\
+ \param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{const wxArrayString\& }{aChoices},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE},\\
+ \param{int }{width=150}, \param{int }{height=200}}
+
+\func{size\_t}{wxGetMultipleChoices}{\\
+ \param{wxArrayInt\& }{selections},\\
+ \param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE},\\
+ \param{int }{width=150}, \param{int }{height=200}}
+
+Pops up a dialog box containing a message, OK/Cancel buttons and a
+multiple-selection listbox. The user may choose an arbitrary (including 0)
+number of items in the listbox whose indices will be returned in
+{\it selection} array. The initial contents of this array will be used to
+select the items when the dialog is shown.
+
+You may pass the list of strings to choose from either using {\it choices}
+which is an array of {\it n} strings for the listbox or by using a single
+{\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
+
+If {\it centre} is TRUE, the message text (which may include new line
+characters) is centred; if FALSE, the message is left-justified.
+
+\wxheading{Include files}
+
+<wx/choicdlg.h>
+
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+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}{


@@ -642,7 +1426,7 @@ is valid) if the dialog was cancelled.
  \param{wxWindow *}{parent = NULL},
  \param{const wxPoint\& }{pos = wxDefaultPosition}}
 
  \param{wxWindow *}{parent = NULL},
  \param{const wxPoint\& }{pos = wxDefaultPosition}}
 

-Shows a dialog asking the user for numeric input. The dialogs title is set to 
+Shows a dialog asking the user for numeric input. The dialogs title is set to

 {\it caption}, it contains a (possibly) multiline {\it message} above the
 single line {\it prompt} and the zone for entering the number.
 
 {\it caption}, it contains a (possibly) multiline {\it message} above the
 single line {\it prompt} and the zone for entering the number.
 


@@ -650,7 +1434,7 @@ The number entered must be in the range {\it min}..{\it max} (both of which
 should be positive) and {\it value} is the initial value of it. If the user
 enters an invalid value or cancels the dialog, the function will return -1.
 
 should be positive) and {\it value} is the initial value of it. If the user
 enters an invalid value or cancels the dialog, the function will return -1.
 

-Dialog is centered on its {\it parent} unless an explicit position is given in 
+Dialog is centered on its {\it parent} unless an explicit position is given in

 {\it pos}.
 
 \wxheading{Include files}
 {\it pos}.
 
 \wxheading{Include files}


@@ -715,49 +1499,110 @@ is centred; if FALSE, the message is left-justified.
 
 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
 
 
 \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
 

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

 
 

-Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection
-listbox. The user may choose an item and press OK to return a string or
-Cancel to return the empty string.
+\func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE},\\
+ \param{int }{width=150}, \param{int }{height=200}}

 
 

-{\it choices} is an array of {\it n} strings for the listbox.
+Pops up a dialog box containing a message, OK/Cancel buttons and a
+single-selection listbox. The user may choose an item and press OK to return a
+string or Cancel to return the empty string. Use
+\helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex} if empty string is a
+valid choice and if you want to be able to detect pressing Cancel reliably.

 
 

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

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

+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
+

 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
 
 \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
 

-\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{const wxArrayString\& }{aChoices},\\

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

-As {\bf wxGetSingleChoice} but returns the index representing the selected string.
-If the user pressed cancel, -1 is returned.
+\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+ \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
+
+As {\bf wxGetSingleChoice} but returns the index representing the selected
+string. If the user pressed cancel, -1 is returned.

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

+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
+

 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
 
 \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
 

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

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

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

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

+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+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}
+
+Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
+\helpref{wxEndBusyCursor}{wxendbusycursor} calls.
+
+See also \helpref{wxBusyCursor}{wxbusycursor}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+

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


@@ -774,7 +1619,8 @@ wxYES\_NO or wxOK.}
 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
 \twocolitem{wxCENTRE}{Centres the text.}
 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
 \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
 \twocolitem{wxCENTRE}{Centres the text.}
 \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}

-\twocolitem{wxICON\_HAND}{Displays a hand symbol.}
+\twocolitem{wxICON\_HAND}{Displays an error symbol.}
+\twocolitem{wxICON\_ERROR}{Displays an error symbol - the same as wxICON\_HAND.}

 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
 \end{twocollist}
 \twocolitem{wxICON\_QUESTION}{Displays a question mark symbol.}
 \twocolitem{wxICON\_INFORMATION}{Displays an information symbol.}
 \end{twocollist}


@@ -837,43 +1683,120 @@ The following are relevant to the GDI (Graphics Device Interface).
 
 <wx/gdicmn.h>
 
 
 <wx/gdicmn.h>
 

-\membersection{::wxColourDisplay}
+\membersection{wxBITMAP}\label{wxbitmapmacro}
+
+\func{}{wxBITMAP}{bitmapName}
+
+This macro loads a bitmap from either application resources (on the platforms
+for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
+avoid using {\tt \#ifdef}s when creating bitmaps.
+
+\wxheading{See also}
+
+\helpref{Bitmaps and icons overview}{wxbitmapoverview},
+\helpref{wxICON}{wxiconmacro}
+
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+
+\membersection{::wxClientDisplayRect}\label{wxclientdisplayrect}
+
+\func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
+\param{int *}{width}, \param{int *}{height}}
+
+\func{wxRect}{wxGetClientDisplayRect}{\void}
+
+Returns the dimensions of the work area on the display.  On Windows
+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.
+
+\membersection{::wxColourDisplay}\label{wxcolourdisplay}

 
 \func{bool}{wxColourDisplay}{\void}
 
 Returns TRUE if the display is colour, FALSE otherwise.
 
 
 \func{bool}{wxColourDisplay}{\void}
 
 Returns TRUE if the display is colour, FALSE otherwise.
 

-\membersection{::wxDisplayDepth}
+\membersection{::wxDisplayDepth}\label{wxdisplaydepth}

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

-\membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
+\membersection{::wxDisplaySize}\label{wxdisplaysize}

 
 

-\func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
- \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
+\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}

 
 

-Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
-makes it into a placeable metafile by prepending a header containing the given
-bounding box. The bounding box may be obtained from a device context after drawing
-into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
+\func{wxSize}{wxGetDisplaySize}{\void}

 
 

-In addition to adding the placeable metafile header, this function adds
-the equivalent of the following code to the start of the metafile data:
+Returns the display size in pixels.

 
 

-\begin{verbatim}
- SetMapMode(dc, MM_ANISOTROPIC);
- SetWindowOrg(dc, minX, minY);
- SetWindowExt(dc, maxX - minX, maxY - minY);
-\end{verbatim}
+\membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}

 
 

-This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
+\func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}

 
 

-Placeable metafiles may be imported by many Windows applications, and can be
-used in RTF (Rich Text Format) files.
+\func{wxSize}{wxGetDisplaySizeMM}{\void}

 
 

-{\it scale} allows the specification of scale for the metafile.
+Returns the display size in millimeters.
+
+\membersection{::wxDROP\_ICON}\label{wxdropicon}
+
+\func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
+
+This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
+name. Under MSW, the cursor is loaded from the resource file and the icon is
+loaded from XPM file under other platforms.
+
+This macro should be used with
+\helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
+
+\wxheading{Include files}
+
+<wx/dnd.h>
+
+\membersection{wxICON}\label{wxiconmacro}
+
+\func{}{wxICON}{iconName}
+
+This macro loads an icon from either application resources (on the platforms
+for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
+avoid using {\tt \#ifdef}s when creating icons.
+
+\wxheading{See also}
+
+\helpref{Bitmaps and icons overview}{wxbitmapoverview},
+\helpref{wxBITMAP}{wxbitmapmacro}
+
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+
+\membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
+
+\func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
+ \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
+
+Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
+makes it into a placeable metafile by prepending a header containing the given
+bounding box. The bounding box may be obtained from a device context after drawing
+into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
+
+In addition to adding the placeable metafile header, this function adds
+the equivalent of the following code to the start of the metafile data:
+
+\begin{verbatim}
+ SetMapMode(dc, MM_ANISOTROPIC);
+ SetWindowOrg(dc, minX, minY);
+ SetWindowExt(dc, maxX - minX, maxY - minY);
+\end{verbatim}
+
+This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
+
+Placeable metafiles may be imported by many Windows applications, and can be
+used in RTF (Rich Text Format) files.
+
+{\it scale} allows the specification of scale for the metafile.

 
 This function is only available under Windows.
 
 
 This function is only available under Windows.
 


@@ -895,99 +1818,99 @@ Windows, PostScript output can only be sent to a file.
 
 <wx/dcps.h>
 
 
 <wx/dcps.h>
 

-\membersection{::wxGetPrinterCommand}
+\membersection{::wxGetPrinterCommand}\label{wxgetprintercommand}

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

-\membersection{::wxGetPrinterFile}
+\membersection{::wxGetPrinterFile}\label{wxgetprinterfile}

 
 \func{wxString}{wxGetPrinterFile}{\void}
 
 Gets the PostScript output filename.
 
 
 \func{wxString}{wxGetPrinterFile}{\void}
 
 Gets the PostScript output filename.
 

-\membersection{::wxGetPrinterMode}
+\membersection{::wxGetPrinterMode}\label{wxgetprintermode}

 
 \func{int}{wxGetPrinterMode}{\void}
 
 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
 The default is PS\_PREVIEW.
 
 
 \func{int}{wxGetPrinterMode}{\void}
 
 Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
 The default is PS\_PREVIEW.
 

-\membersection{::wxGetPrinterOptions}
+\membersection{::wxGetPrinterOptions}\label{wxgetprinteroptions}

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

-\membersection{::wxGetPrinterOrientation}
+\membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation}

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

-\membersection{::wxGetPrinterPreviewCommand}
+\membersection{::wxGetPrinterPreviewCommand}\label{wxgetprinterpreviewcommand}

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

-\membersection{::wxGetPrinterScaling}
+\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.
 
 
 \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}
+\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.
 
 
 \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}
+\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}.
 
 
 \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
 
 Sets the printer command used to print a file. The default is {\tt lpr}.
 

-\membersection{::wxSetPrinterFile}
+\membersection{::wxSetPrinterFile}\label{wxsetprinterfile}

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

-\membersection{::wxSetPrinterMode}
+\membersection{::wxSetPrinterMode}\label{wxsetprintermode}

 
 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
 
 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
 The default is PS\_PREVIEW.
 
 
 \func{void}{wxSetPrinterMode}{\param{int }{mode}}
 
 Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
 The default is PS\_PREVIEW.
 

-\membersection{::wxSetPrinterOptions}
+\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.
 
 
 \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}
+\membersection{::wxSetPrinterOrientation}\label{wxsetprinterorientation}

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

-\membersection{::wxSetPrinterPreviewCommand}
+\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.
 
 
 \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
 
 Sets the command used to view a PostScript file. The default depends on the platform.
 

-\membersection{::wxSetPrinterScaling}
+\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.
 
 
 \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}
+\membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation}

 
 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
 
 
 \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
 


@@ -996,52 +1919,52 @@ Sets the translation (from the top left corner) for PostScript output. The defau
 \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

-is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard} 
+is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}

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

-\membersection{::wxClipboardOpen}
+\membersection{::wxClipboardOpen}\label{wxclipboardopen}

 
 \func{bool}{wxClipboardOpen}{\void}
 
 Returns TRUE if this application has already opened the clipboard.
 
 
 \func{bool}{wxClipboardOpen}{\void}
 
 Returns TRUE if this application has already opened the clipboard.
 

-\membersection{::wxCloseClipboard}
+\membersection{::wxCloseClipboard}\label{wxcloseclipboard}

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

-\membersection{::wxEmptyClipboard}
+\membersection{::wxEmptyClipboard}\label{wxemptyclipboard}

 
 \func{bool}{wxEmptyClipboard}{\void}
 
 Empties the clipboard.
 
 
 \func{bool}{wxEmptyClipboard}{\void}
 
 Empties the clipboard.
 

-\membersection{::wxEnumClipboardFormats}
+\membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}

 
 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
 
 Enumerates the formats found in a list of available formats that belong
 to the clipboard. Each call to this  function specifies a known
 available format; the function returns the format that appears next in
 
 \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
 
 Enumerates the formats found in a list of available formats that belong
 to the clipboard. Each call to this  function specifies a known
 available format; the function returns the format that appears next in

-the list. 
+the list.

 
 {\it dataFormat} specifies a known format. If this parameter is zero,
 
 {\it dataFormat} specifies a known format. If this parameter is zero,

-the function returns the first format in the list. 
+the function returns the first format in the list.

 
 The return value specifies the next known clipboard data format if the
 function is successful. It is zero if the {\it dataFormat} parameter specifies
 the last  format in the list of available formats, or if the clipboard
 
 The return value specifies the next known clipboard data format if the
 function is successful. It is zero if the {\it dataFormat} parameter specifies
 the last  format in the list of available formats, or if the clipboard

-is not open. 
+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}
+\membersection{::wxGetClipboardData}\label{wxgetclipboarddata}

 
 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
 
 
 \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
 


@@ -1056,32 +1979,32 @@ 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}
+\membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}

 
 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
 
 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.
 
 
 \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
 
 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}
+\membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}

 
 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
 
 Returns TRUE if the given data format is available on the clipboard.
 
 
 \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
 
 Returns TRUE if the given data format is available on the clipboard.
 

-\membersection{::wxOpenClipboard}
+\membersection{::wxOpenClipboard}\label{wxopenclipboard}

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

-\membersection{::wxRegisterClipboardFormat}
+\membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat}

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

-\membersection{::wxSetClipboardData}
+\membersection{::wxSetClipboardData}\label{wxsetclipboarddata}

 
 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
 
 
 \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
 


@@ -1100,22 +2023,7 @@ The clipboard must have previously been opened for this call to succeed.
 
 \section{Miscellaneous functions}\label{miscellany}
 
 
 \section{Miscellaneous functions}\label{miscellany}
 

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

 
 \func{long}{wxNewId}{\void}
 
 
 \func{long}{wxNewId}{\void}
 


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

-\membersection{::wxRegisterId}
+\membersection{::wxRegisterId}\label{wxregisterid}

 
 \func{void}{wxRegisterId}{\param{long}{ id}}
 
 
 \func{void}{wxRegisterId}{\param{long}{ id}}
 


@@ -1136,38 +2044,6 @@ the given {\bf id}.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
-
-\func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
-
-Changes the cursor to the given cursor for all windows in the application.
-Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
-to its previous state. These two calls can be nested, and a counter
-ensures that only the outer calls take effect.
-
-See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxBell}
-
-\func{void}{wxBell}{\void}
-
-Ring the system bell.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
-
-\func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
-
-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{::wxDDECleanUp}\label{wxddecleanup}
 
 \func{void}{wxDDECleanUp}{\void}
 \membersection{::wxDDECleanUp}\label{wxddecleanup}
 
 \func{void}{wxDDECleanUp}{\void}


@@ -1190,39 +2066,14 @@ 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.
 
 This no longer needs to be called by the application: it will be called
 by wxWindows if necessary.
 

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

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

-\membersection{::wxDebugMsg}\label{wxdebugmsg}
-
-\func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
-
-{\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogdebug} instead!}
-
-Display a debugging message; under Windows, this will appear on the
-debugger command window, and under Unix, it will be written to standard
-error.
-
-The syntax is identical to {\bf printf}: pass a format string and a
-variable list of arguments.
-
-{\bf Tip:} under Windows, if your application crashes before the
-message appears in the debugging window, put a wxYield call after
-each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
-(at least for Watcom C++): preformat your messages and use OutputDebugString
-instead.
-
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxDisplaySize}
+\membersection{::wxDisplaySize}\label{wxdisplaysize}

 
 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
 
 
 \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
 


@@ -1236,158 +2087,14 @@ Gets the physical size of the display in pixels.
 
 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
 
 
 \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
 

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

 \helpref{::wxSafeYield}{wxsafeyield}.
 
 \wxheading{Include files}
 
 <wx/utils.h>
 
 \helpref{::wxSafeYield}{wxsafeyield}.
 
 \wxheading{Include files}
 
 <wx/utils.h>
 

-\membersection{::wxEntry}\label{wxentry}
-
-This initializes wxWindows in a platform-dependent way. Use this if you
-are not using the default wxWindows entry code (e.g. main or WinMain). For example,
-you can initialize wxWindows from an Microsoft Foundation Classes application using
-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
-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).
-
-\func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
-
-wxWindows initialization under Unix.
-
-\wxheading{Remarks}
-
-To clean up wxWindows, call wxApp::OnExit followed by the static function
-wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
-
-\begin{verbatim}
-int CTheApp::ExitInstance()
-{
-  // OnExit isn't called by CleanUp so must be called explicitly.
-  wxTheApp->OnExit();
-  wxApp::CleanUp();
-
-  return CWinApp::ExitInstance();
-}
-\end{verbatim}
-
-\wxheading{Include files}
-
-<wx/app.h>
-
-\membersection{::wxEndBusyCursor}\label{wxendbusycursor}
-
-\func{void}{wxEndBusyCursor}{\void}
-
-Changes the cursor back to the original cursor, for all windows in the application.
-Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
-
-See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxError}\label{wxerror}
-
-\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
-
-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}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxExecute}\label{wxexecute}
-
-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
-
-\func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
-
-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
-
-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}}
-
-Executes another program in Unix or Windows.
-
-The first form takes a command string, such as {\tt "emacs file.txt"}.
-
-The second form takes an array of values: a command, any number of
-arguments, terminated by NULL.
-
-The semantics of the third and fourth versions is different from the first two
-and is described in more details below.
-
-If {\it sync} is FALSE (the default), flow of control immediately returns.
-If TRUE, the current application waits until the other program has terminated.
-
-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
-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}.
-
-For asynchronous execution, however, the return value is the process id and
-zero value indicates that the command could not be executed.
-
-If callback isn't NULL and if execution is asynchronous (note that callback
-parameter can not be non-NULL for synchronous execution), 
-\helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
-the process finishes.
-
-Finally, you may use the third overloaded version of this function to execute
-a process (always synchronously) and capture its output in the array 
-{\it output}. The fourth version adds the possibility to additionally capture
-the messages from standard error output in the {\it errors} array.
-
-See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}, 
-\helpref{Exec sample}{sampleexec}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxExit}\label{wxexit}
-
-\func{void}{wxExit}{\void}
-
-Exits application after calling \helpref{wxApp::OnExit}{wxapponexit}.
-Should only be used in an emergency: normally the top-level frame
-should be deleted (after deleting all other frames) to terminate the
-application. See \helpref{wxWindow::OnCloseWindow}{wxwindowonclosewindow} and \helpref{wxApp}{wxapp}.
-
-\wxheading{Include files}
-
-<wx/app.h>
-
-\membersection{::wxFatalError}\label{wxfatalerror}
-
-\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
-
-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}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxFindMenuItemId}
+\membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}

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


@@ -1403,257 +2110,101 @@ Find a menu item identifier associated with the given frame's menu bar.
 
 Find a window by its label. Depending on the type of window, the label may be a window title
 or panel item label. If {\it parent} is NULL, the search will start from all top-level
 
 Find a window by its label. Depending on the type of window, the label may be a window title
 or panel item label. If {\it parent} is NULL, the search will start from all top-level

-frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
-The search is recursive in both cases.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
-
-\func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
-
-Find a window by its name (as given in a window constructor or {\bf Create} function call).
-If {\it parent} is NULL, the search will start from all top-level
-frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
-The search is recursive in both cases.
-
-If no such named window is found, {\bf wxFindWindowByLabel} is called.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
-
-\func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
-
-Find the deepest window at the given mouse position in screen coordinates,
-returning the window if found, or NULL if not.
-
-\membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
-
-\func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
-
-Find the deepest window at the mouse pointer position, returning the window
-and current pointer position in screen coordinates.
-
-\membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
-
-\func{wxWindow *}{wxGetActiveWindow}{\void}
-
-Gets the currently active window (Windows only).
-
-\wxheading{Include files}
-
-<wx/windows.h>
-
-\membersection{::wxGetDisplayName}\label{wxgetdisplayname}
-
-\func{wxString}{wxGetDisplayName}{\void}
-
-Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxGetHomeDir}\label{wxgethomedir}
-
-\func{wxString}{wxGetHomeDir}{\void}
-
-Return the (current) user's home directory.
-
-\wxheading{See also}
-
-\helpref{wxGetUserHome}{wxgetuserhome}
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxGetFreeMemory}\label{wxgetfreememory}
-
-\func{long}{wxGetFreeMemory}{\void}
-
-Returns the amount of free memory in bytes under environments which
-support it, and -1 if not supported. Currently, it is supported only
-under Windows, Linux and Solaris.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxGetMousePosition}\label{wxgetmouseposition}
-
-\func{wxPoint}{wxGetMousePosition}{\void}
-
-Returns the mouse position in screen coordinates.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxGetOsDescription}\label{wxgetosdescription}
-
-\func{wxString}{wxGetOsDescription}{\void}
-
-Returns the string containing the description of the current platform in a
-user-readable form. For example, this function may return strings like  
-{\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
-
-\wxheading{See also}
-
-\helpref{::wxGetOsVersion}{wxgetosversion}
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxGetOsVersion}\label{wxgetosversion}
-
-\func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
-
-Gets operating system version information.
-
-\begin{twocollist}\itemsep=0pt
-\twocolitemruled{Platform}{Return types}
-\twocolitem{Macintosh}{Return value is wxMACINTOSH.}
-\twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }
-\twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
-\twocolitem{OS/2}{Return value is wxOS2\_PM.}
-\twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
-\twocolitem{Windows NT/2000}{Return value is wxWINDOWS\_NT, version is returned in {\it major} and {\it minor}}
-\twocolitem{Windows 98}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 1 or greater.}
-\twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 0.}
-\twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
-\twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
-\end{twocollist}
-
-\wxheading{See also}
-
-\helpref{::wxGetOsDescription}{wxgetosdescription}
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxGetResource}\label{wxgetresource}
-
-\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
-
-\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{float *}{value}, \param{const wxString\& }{file = NULL}}
-
-\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{long *}{value}, \param{const wxString\& }{file = NULL}}
-
-\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{int *}{value}, \param{const wxString\& }{file = NULL}}
-
-Gets a resource value from the resource database (for example, WIN.INI, or
-.Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
-otherwise the specified file is used.
-
-Under X, if an application class (wxApp::GetClassName) has been defined,
-it is appended to the string /usr/lib/X11/app-defaults/ to try to find
-an applications default file when merging all resource databases.
-
-The reason for passing the result in an argument is that it
-can be convenient to define a default value, which gets overridden
-if the value exists in the resource file. It saves a separate
-test for that resource's existence, and it also allows
-the overloading of the function for different types.
-
-See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
+frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
+The search is recursive in both cases.

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

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

 
 

-\func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
+Find a window by its name (as given in a window constructor or {\bf Create} function call).
+If {\it parent} is NULL, the search will start from all top-level
+frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
+The search is recursive in both cases.

 
 

-Copies the user's login identity (such as ``jacs'') into the buffer {\it
-buf}, of maximum size {\it bufSize}, returning TRUE if successful.
-Under Windows, this returns ``user''.
+If no such named window is found, {\bf wxFindWindowByLabel} is called.

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

-\membersection{::wxGetUserHome}\label{wxgetuserhome}
+\membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}

 
 

-\func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
+\func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}

 
 

-Returns the home directory for the given user. If the username is empty
-(default value), this function behaves like 
-\helpref{wxGetHomeDir}{wxgethomedir}.
+Find the deepest window at the given mouse position in screen coordinates,
+returning the window if found, or NULL if not.

 
 

-\wxheading{Include files}
+\membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}

 
 

-<wx/utils.h>
+\func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
+
+Find the deepest window at the mouse pointer position, returning the window
+and current pointer position in screen coordinates.

 
 

-\membersection{::wxGetUserName}
+\membersection{::wxGetActiveWindow}\label{wxgetactivewindow}

 
 

-\func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
+\func{wxWindow *}{wxGetActiveWindow}{\void}

 
 

-Copies the user's name (such as ``Julian Smart'') into the buffer {\it
-buf}, of maximum size {\it bufSize}, returning TRUE if successful.
-Under Windows, this returns ``unknown''.
+Gets the currently active window (Windows only).

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

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

 
 

-\membersection{::wxHandleFatalExceptions}\label{wxhandlefatalexceptions}
+\membersection{::wxGetDisplayName}\label{wxgetdisplayname}

 
 

-\func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = TRUE}}
+\func{wxString}{wxGetDisplayName}{\void}

 
 

-If {\it doIt} is TRUE, the fatal exceptions (also known as general protection
-faults under Windows or segmentation violations in the Unix world) will be
-caught and passed to \helpref{wxApp::OnFatalException}{wxapponfatalexception}.
-By default, i.e. before this function is called, they will be handled in the
-normal way which usually just means that the application will be terminated.
-Calling wxHandleFatalExceptions() with {\it doIt} equal to FALSE will restore
-this default behaviour.
+Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.

 
 

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

 
 

-\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
+\membersection{::wxGetMousePosition}\label{wxgetmouseposition}

 
 

-Under Unix (the only supported platform), equivalent to the Unix kill function.
-Returns 0 on success, -1 on failure.
+\func{wxPoint}{wxGetMousePosition}{\void}

 
 

-Tip: sending a signal of 0 to a process returns -1 if the process does not exist.
-It does not raise a signal in the receiving process.
+Returns the mouse position in screen coordinates.

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

-\membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
+\membersection{::wxGetResource}\label{wxgetresource}

 
 

-\func{void}{wxInitAllImageHandlers}{\void}
+\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
+ \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}

 
 

-Initializes all available image handlers. For a list of available handlers,
-see \helpref{wxImage}{wximage}.
+\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
+ \param{float *}{value}, \param{const wxString\& }{file = NULL}}

 
 

-\wxheading{See also}
+\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
+ \param{long *}{value}, \param{const wxString\& }{file = NULL}}

 
 

-\helpref{wxImage}{wximage}, \helpref{wxImageHandler}{wximagehandler}
+\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
+ \param{int *}{value}, \param{const wxString\& }{file = NULL}}

 
 

-\membersection{::wxIsBusy}\label{wxisbusy}
+Gets a resource value from the resource database (for example, WIN.INI, or
+.Xdefaults). If {\it file} is NULL, WIN.INI or .Xdefaults is used,
+otherwise the specified file is used.

 
 

-\func{bool}{wxIsBusy}{\void}
+Under X, if an application class (wxApp::GetClassName) has been defined,
+it is appended to the string /usr/lib/X11/app-defaults/ to try to find
+an applications default file when merging all resource databases.

 
 

-Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
-\helpref{wxEndBusyCursor}{wxendbusycursor} calls.
+The reason for passing the result in an argument is that it
+can be convenient to define a default value, which gets overridden
+if the value exists in the resource file. It saves a separate
+test for that resource's existence, and it also allows
+the overloading of the function for different types.

 
 

-See also \helpref{wxBusyCursor}{wxbusycursor}.
+See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.

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


@@ -1684,16 +2235,6 @@ This function is available under Windows only.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\membersection{::wxNow}\label{wxnow}
-
-\func{wxString}{wxNow}{\void}
-
-Returns a string representing the current date and time.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-

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


@@ -1733,21 +2274,6 @@ uses internally).
 
 <wx/app.h>
 
 
 <wx/app.h>
 

-\membersection{::wxSafeYield}\label{wxsafeyield}
-
-\func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
-
-This function is similar to wxYield, except that it disables the user input to
-all program windows before calling wxYield and re-enables it again
-afterwards. If {\it win} is not NULL, this window will remain enabled, 
-allowing the implementation of some limited user interaction.
-
-Returns the result of the call to \helpref{::wxYield}{wxyield}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-

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


@@ -1763,34 +2289,14 @@ See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\membersection{::wxShell}\label{wxshell}
-
-\func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
-
-Executes a command in an interactive shell window. If no command is
-specified, then just the shell is spawned.
-
-See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxSleep}\label{wxsleep}
-
-\func{void}{wxSleep}{\param{int}{ secs}}
-
-Sleeps for the specified number of seconds.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxStripMenuCodes}
+\membersection{::wxStripMenuCodes}\label{wxstripmenucodes}

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

-\func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
+\func{void}{wxStripMenuCodes}{\param{char *}{in}, \param{char *}{out}}
+
+This function is obsolete, please use 
+\helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} instead.

 
 Strips any menu codes from {\it in} and places the result
 in {\it out} (or returns the new string, in the first form).
 
 Strips any menu codes from {\it in} and places the result
 in {\it out} (or returns the new string, in the first form).


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

-\membersection{::wxToLower}\label{wxtolower}
-
-\func{char}{wxToLower}{\param{char }{ch}}
-
-Converts the character to lower case. This is implemented as a macro for efficiency.
-
-\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{::wxTrace}\label{wxtrace}
-
-\func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
-
-Takes printf-style variable argument syntax. Output
-is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
-
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
-\wxheading{Include files}
-
-<wx/memory.h>
-
-\membersection{::wxTraceLevel}\label{wxtracelevel}
-
-\func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
-
-Takes printf-style variable argument syntax. Output
-is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
-The first argument should be the level at which this information is appropriate.
-It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
-this value.
-
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
-\wxheading{Include files}
-
-<wx/memory.h>
-
-\membersection{::wxUsleep}\label{wxusleep}
-
-\func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
-
-Sleeps for the specified number of milliseconds. Notice that usage of this
-function is encouraged instead of calling usleep(3) directly because the
-standard usleep() function is not MT safe.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-

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


@@ -1894,49 +2339,13 @@ See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfig
 
 <wx/utils.h>
 
 
 <wx/utils.h>
 

-\membersection{::wxYield}\label{wxyield}
-
-\func{bool}{wxYield}{\void}
-
-Yields control to pending messages in the windowing system. This can be useful, for example, when a
-time-consuming process writes to a text window. Without an occasional
-yield, the text window will not be updated properly, and on systems with
-cooperative multitasking, such as Windows 3.1 other processes will not respond.
-
-Caution should be exercised, however, since yielding may allow the
-user to perform actions which are not compatible with the current task.
-Disabling menu items or whole menus during processing can avoid unwanted
-reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
-function.
-
-Note that wxYield will not flush the message logs. This is intentional as
-calling wxYield is usually done to quickly update the screen and popping up a
-message box dialog may be undesirable. If you do wish to flush the log
-messages immediately (otherwise it will be done during the next idle loop
-iteration), call \helpref{wxLog::FlushActive}{wxlogflushactive}.
-
-\wxheading{Include files}
-
-<wx/app.h> or <wx/utils.h>
-
-\membersection{::wxWakeUpIdle}\label{wxwakeupidle}
-
-\func{void}{wxWakeUpIdle}{\void}
-
-This functions wakes up the (internal and platform dependent) idle system, i.e. it
-will force the system to send an idle event even if the system currently {\it is}
- idle and thus would not send any idle event until after some other event would get
-sent. This is also useful for sending events between two threads and is used by
-the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and 
-\helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
-
-\wxheading{Include files}
-
-<wx/app.h>
-
-\section{Macros}\label{macros}
+\section{Byte order macros}\label{macros}

 
 

-These macros are defined in wxWindows.
+The endian-ness issues (that is the difference between big-endian and
+little-endian architectures) are important for the portable programs working
+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.

 
 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
 
 
 \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
 


@@ -1948,8 +2357,9 @@ These macros are defined in wxWindows.
 
 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
 
 
 \func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
 

-This macro will swap the bytes of the {\it value} variable from little
-endian to big endian or vice versa.
+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.

 
 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
 
 
 \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
 


@@ -1963,11 +2373,11 @@ endian to big endian or vice versa.
 
 This macro will swap the bytes of the {\it value} variable from little
 endian to big endian or vice versa if the program is compiled on a
 
 This macro will swap the bytes of the {\it value} variable from little
 endian to big endian or vice versa if the program is compiled on a

-big-endian architecture (such as Sun work stations). If the program has 
+big-endian architecture (such as Sun work stations). If the program has

 been compiled on a little-endian architecture, the value will be unchanged.
 
 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 (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}
 
 
 \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
 


@@ -1981,11 +2391,27 @@ data in little endian (Intel i386) format.
 
 This macro will swap the bytes of the {\it value} variable from little
 endian to big endian or vice versa if the program is compiled on a
 
 This macro will swap the bytes of the {\it value} variable from little
 endian to big endian or vice versa if the program is compiled on a

-little-endian architecture (such as Intel PCs). If the program has 
+little-endian architecture (such as Intel PCs). If the program has

 been compiled on a big-endian architecture, the value will be unchanged.
 
 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{macros}
+
+wxWindows uses its own RTTI ("run-time type identification") system which
+predates the current standard C++ RTTI and so is kept for backwards
+compatribility reasons but also because it allows some things which the
+standard RTTI doesn't directly support (such as creating a class from its
+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
+unless you are thinking of modifying or adding any wxWindows classes.
+
+\wxheading{See also}
+
+\helpref{RTTI overview}{runtimeclassoverview}

 
 \membersection{CLASSINFO}\label{classinfo}
 
 
 \membersection{CLASSINFO}\label{classinfo}
 


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

-\membersection{DECLARE\_ABSTRACT\_CLASS}
+\membersection{DECLARE\_ABSTRACT\_CLASS}\label{declareabstractclass}

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


@@ -2040,7 +2466,7 @@ Example:
 
 <wx/app.h>
 
 
 <wx/app.h>
 

-\membersection{DECLARE\_CLASS}
+\membersection{DECLARE\_CLASS}\label{declareclass}

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


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

-\membersection{DECLARE\_DYNAMIC\_CLASS}
+\membersection{DECLARE\_DYNAMIC\_CLASS}\label{declaredynamicclass}

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


@@ -2077,7 +2503,7 @@ class wxFrame: public wxWindow
 
 <wx/object.h>
 
 
 <wx/object.h>
 

-\membersection{IMPLEMENT\_ABSTRACT\_CLASS}
+\membersection{IMPLEMENT\_ABSTRACT\_CLASS}\label{implementabstractclass}

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


@@ -2099,7 +2525,7 @@ wxCommand::wxCommand(void)
 
 <wx/object.h>
 
 
 <wx/object.h>
 

-\membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
+\membersection{IMPLEMENT\_ABSTRACT\_CLASS2}\label{implementabstractclass2}

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


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

-\membersection{IMPLEMENT\_CLASS}
+\membersection{IMPLEMENT\_CLASS}\label{implementclass}

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


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

-\membersection{IMPLEMENT\_CLASS2}
+\membersection{IMPLEMENT\_CLASS2}\label{implementclass2}

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


@@ -2158,7 +2584,7 @@ same as IMPLEMENT\_ABSTRACT\_CLASS2.
 
 <wx/object.h>
 
 
 <wx/object.h>
 

-\membersection{IMPLEMENT\_DYNAMIC\_CLASS}
+\membersection{IMPLEMENT\_DYNAMIC\_CLASS}\label{implementdynamicclass}

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


@@ -2181,7 +2607,7 @@ wxFrame::wxFrame(void)
 
 <wx/object.h>
 
 
 <wx/object.h>
 

-\membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
+\membersection{IMPLEMENT\_DYNAMIC\_CLASS2}\label{implementdynamicclass2}

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


@@ -2194,26 +2620,9 @@ base classes.
 
 <wx/object.h>
 
 
 <wx/object.h>
 

-\membersection{wxBITMAP}\label{wxbitmapmacro}
-
-\func{}{wxBITMAP}{bitmapName}
-
-This macro loads a bitmap from either application resources (on the platforms
-for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
-avoid using {\tt \#ifdef}s when creating bitmaps.
-
-\wxheading{See also}
-
-\helpref{Bitmaps and icons overview}{wxbitmapoverview}, 
-\helpref{wxICON}{wxiconmacro}
-
-\wxheading{Include files}
-
-<wx/gdicmn.h>
-

 \membersection{wxConstCast}\label{wxconstcast}
 
 \membersection{wxConstCast}\label{wxconstcast}
 

-\func{}{wxConstCast}{ptr, classname}
+\func{classname *}{wxConstCast}{ptr, classname}

 
 This macro expands into {\tt const\_cast<classname *>(ptr)} if the compiler
 supports {\it const\_cast} or into an old, C-style cast, otherwise.
 
 This macro expands into {\tt const\_cast<classname *>(ptr)} if the compiler
 supports {\it const\_cast} or into an old, C-style cast, otherwise.


@@ -2223,6 +2632,13 @@ supports {\it const\_cast} or into an old, C-style cast, otherwise.
 \helpref{wxDynamicCast}{wxdynamiccast}\\
 \helpref{wxStaticCast}{wxstaticcast}
 
 \helpref{wxDynamicCast}{wxdynamiccast}\\
 \helpref{wxStaticCast}{wxstaticcast}
 

+\membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
+
+\func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
+
+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}


@@ -2242,14 +2658,15 @@ In non-debug mode, this is defined as the normal new operator.
 
 \membersection{wxDynamicCast}\label{wxdynamiccast}
 
 
 \membersection{wxDynamicCast}\label{wxdynamiccast}
 

-\func{}{wxDynamicCast}{ptr, classname}
+\func{classname *}{wxDynamicCast}{ptr, classname}

 
 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
 
 This macro returns the pointer {\it ptr} cast to the type {\it classname *} if

-the pointer is of this type (the check is done during the run-time) or NULL
-otherwise. Usage of this macro is preferred over obsoleted wxObject::IsKindOf()
-function.
+the pointer is of this type (the check is done during the run-time) or
+{\tt NULL} otherwise. Usage of this macro is preferred over obsoleted
+wxObject::IsKindOf() function.

 
 

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

 
 Example:
 
 
 Example:
 


@@ -2269,29 +2686,26 @@ Example:
 \wxheading{See also}
 
 \helpref{RTTI overview}{runtimeclassoverview}\\
 \wxheading{See also}
 
 \helpref{RTTI overview}{runtimeclassoverview}\\

+\helpref{wxDynamicCastThis}{wxdynamiccastthis}\\

 \helpref{wxConstCast}{wxconstcast}\\
 \helpref{wxStatiicCast}{wxstaticcast}
 
 \helpref{wxConstCast}{wxconstcast}\\
 \helpref{wxStatiicCast}{wxstaticcast}
 

-\membersection{wxICON}\label{wxiconmacro}
-
-\func{}{wxICON}{iconName}
-
-This macro loads an icon from either application resources (on the platforms
-for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
-avoid using {\tt \#ifdef}s when creating icons.
-
-\wxheading{See also}
+\membersection{wxDynamicCastThis}\label{wxdynamiccastthis}

 
 

-\helpref{Bitmaps and icons overview}{wxbitmapoverview}, 
-\helpref{wxBITMAP}{wxbitmapmacro}
+\func{classname *}{wxDynamicCastThis}{classname}

 
 

-\wxheading{Include files}
+This macro is equivalent to {\tt wxDynamicCast(this, classname)} but the
+latter provokes spurious compilation warnings from some compilers (because it
+tests whether {\tt this} pointer is non {\tt NULL} which is always true), so
+this macro should be used to avoid them.

 
 

-<wx/gdicmn.h>
+\wxheading{See also}
+
+\helpref{wxDynamicCast}{wxdynamiccast}

 
 \membersection{wxStaticCast}\label{wxstaticcast}
 
 
 \membersection{wxStaticCast}\label{wxstaticcast}
 

-\func{}{wxStaticCast}{ptr, classname}
+\func{classname *}{wxStaticCast}{ptr, classname}

 
 This macro checks that the cast is valid in debug mode (an assert failure will
 result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the
 
 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


@@ -2300,42 +2714,9 @@ result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
 \helpref{wxDynamicCast}{wxdynamiccast}\\
 \helpref{wxConstCast}{wxconstcast}
 
 \helpref{wxDynamicCast}{wxdynamiccast}\\
 \helpref{wxConstCast}{wxconstcast}
 

-\membersection{WXTRACE}\label{trace}
-
-\wxheading{Include files}
-
-<wx/object.h>
-
-\func{}{WXTRACE}{formatString, ...}
-
-Calls wxTrace with printf-style variable argument syntax. Output
-is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
-
-This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
-\wxheading{Include files}
-
-<wx/memory.h>
-
-\membersection{WXTRACELEVEL}\label{tracelevel}
-
-\func{}{WXTRACELEVEL}{level, formatString, ...}
-
-Calls wxTraceLevel with printf-style variable argument syntax. Output
-is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
-The first argument should be the level at which this information is appropriate.
-It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
-this value.
-
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
-\wxheading{Include files}
-
-<wx/memory.h>
-
-\section{wxWindows resource functions}\label{resourcefuncs}
+\section{Resource functions}\label{resourcefuncs}

 
 

-\overview{wxWindows resource system}{resourceformats}
+\overview{Resource functions}{resourceformats}

 
 This section details functions for manipulating wxWindows (.WXR) resource
 files and loading user interface elements from resources.
 
 This section details functions for manipulating wxWindows (.WXR) resource
 files and loading user interface elements from resources.


@@ -2354,16 +2735,16 @@ loading from resource data.
 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
 
 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
 
 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp

-\verb$#$defining a name to an integer). Unlikely to be used by an application except
+\tt{#}defining a name to an integer). Unlikely to be used by an application except

 perhaps for implementing resource functionality for interpreted languages.
 
 perhaps for implementing resource functionality for interpreted languages.
 

-\membersection{::wxResourceClear}
+\membersection{::wxResourceClear}\label{wxresourceclear}

 
 \func{void}{wxResourceClear}{\void}
 
 Clears the wxWindows resource table.
 
 
 \func{void}{wxResourceClear}{\void}
 
 Clears the wxWindows resource table.
 

-\membersection{::wxResourceCreateBitmap}
+\membersection{::wxResourceCreateBitmap}\label{wxresourcecreatebitmap}

 
 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
 
 
 \func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
 


@@ -2383,7 +2764,7 @@ then this function can be called as follows:
   wxBitmap *bitmap  = wxResourceCreateBitmap("project_resource");
 \end{verbatim}
 
   wxBitmap *bitmap  = wxResourceCreateBitmap("project_resource");
 \end{verbatim}
 

-\membersection{::wxResourceCreateIcon}
+\membersection{::wxResourceCreateIcon}\label{wxresourcecreateicon}

 
 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
 
 
 \func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
 


@@ -2403,7 +2784,7 @@ then this function can be called as follows:
   wxIcon *icon = wxResourceCreateIcon("project_resource");
 \end{verbatim}
 
   wxIcon *icon = wxResourceCreateIcon("project_resource");
 \end{verbatim}
 

-\membersection{::wxResourceCreateMenuBar}
+\membersection{::wxResourceCreateMenuBar}\label{wxresourcecreatemenubar}

 
 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
 
 
 \func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
 


@@ -2433,7 +2814,7 @@ then this function can be called as follows:
 \end{verbatim}
 
 
 \end{verbatim}
 
 

-\membersection{::wxResourceGetIdentifier}
+\membersection{::wxResourceGetIdentifier}\label{wxresourcegetidentifier}

 
 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
 
 
 \func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
 


@@ -2477,7 +2858,7 @@ a C++ program as follows:
 Each of the contained resources will declare a new C++ variable, and each
 of these variables should be passed to wxResourceParseData.
 
 Each of the contained resources will declare a new C++ variable, and each
 of these variables should be passed to wxResourceParseData.
 

-\membersection{::wxResourceParseFile}
+\membersection{::wxResourceParseFile}\label{wxresourceparsefile}

 
 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
 
 
 \func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
 


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

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

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


@@ -2515,16 +2896,16 @@ load an entire {\tt .wxr file} into a string.
 
 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
 
 
 \membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
 

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

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

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

 
 

-Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system. 
+Makes \tt{#}included XBM or XPM bitmap data known to the wxWindows resource system.

 This is required if other resources will use the bitmap data, since otherwise there
 is no connection between names used in resources, and the global bitmap data.
 
 This is required if other resources will use the bitmap data, since otherwise there
 is no connection between names used in resources, and the global bitmap data.
 

-\membersection{::wxResourceRegisterIconData}
+\membersection{::wxResourceRegisterIconData}\label{wxresourceregistericondata}

 
 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
 
 
 Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
 


@@ -2539,17 +2920,76 @@ standard one (installed by wxWindows in the beginning of the program).
 
 <wx/log.h>
 
 
 <wx/log.h>
 

+\membersection{::wxDebugMsg}\label{wxdebugmsg}
+
+\func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
+
+{\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogdebug} instead!}
+
+Display a debugging message; under Windows, this will appear on the
+debugger command window, and under Unix, it will be written to standard
+error.
+
+The syntax is identical to {\bf printf}: pass a format string and a
+variable list of arguments.
+
+{\bf Tip:} under Windows, if your application crashes before the
+message appears in the debugging window, put a wxYield call after
+each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
+(at least for Watcom C++): preformat your messages and use OutputDebugString
+instead.
+
+This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxError}\label{wxerror}
+
+\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
+
+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}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxFatalError}\label{wxfatalerror}
+
+\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
+
+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}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxLogError}\label{wxlogerror}
 
 \membersection{::wxLogError}\label{wxlogerror}
 

-\func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogError}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}

 
 

-The function to use for error messages, i.e. the messages that must be shown
+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.
 
 \membersection{::wxLogFatalError}\label{wxlogfatalerror}
 
 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{...}{}}
+\func{void}{wxLogFatalError}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogFatalError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}

 
 Like \helpref{wxLogError}{wxlogerror}, but also
 terminates the program with the exit code 3. Using {\it abort()} standard
 
 Like \helpref{wxLogError}{wxlogerror}, but also
 terminates the program with the exit code 3. Using {\it abort()} standard


@@ -2557,16 +2997,20 @@ function also terminates the program with this exit code.
 
 \membersection{::wxLogWarning}\label{wxlogwarning}
 
 
 \membersection{::wxLogWarning}\label{wxlogwarning}
 

-\func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogWarning}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogWarning}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}

 
 For warnings - they are also normally shown to the user, but don't interrupt
 the program work.
 
 \membersection{::wxLogMessage}\label{wxlogmessage}
 
 
 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{...}{}}
+\func{void}{wxLogMessage}{\param{const char *}{formatString}, \param{...}{}}

 
 

-for all normal, informational messages. They also appear in a message box by
+\func{void}{wxVLogMessage}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
+
+For all normal, informational messages. They also appear in a message box by

 default (but it can be changed). Notice that the standard behaviour is to not
 show informational messages if there are any errors later - the logic being
 that the later error messages make the informational messages preceding them
 default (but it can be changed). Notice that the standard behaviour is to not
 show informational messages if there are any errors later - the logic being
 that the later error messages make the informational messages preceding them


@@ -2574,7 +3018,9 @@ meaningless.
 
 \membersection{::wxLogVerbose}\label{wxlogverbose}
 
 
 \membersection{::wxLogVerbose}\label{wxlogverbose}
 

-\func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogVerbose}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogVerbose}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}

 
 For verbose output. Normally, it is suppressed, but
 might be activated if the user wishes to know more details about the program
 
 For verbose output. Normally, it is suppressed, but
 might be activated if the user wishes to know more details about the program


@@ -2582,19 +3028,25 @@ progress (another, but possibly confusing name for the same function is {\bf wxL
 
 \membersection{::wxLogStatus}\label{wxlogstatus}
 
 
 \membersection{::wxLogStatus}\label{wxlogstatus}
 

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

 
 

-\func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxVLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}

 
 

-Messages logged by this function will appear in the statusbar of the {\it
+\func{void}{wxLogStatus}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogStatus}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
+
+Messages logged by these functions will appear in the statusbar of the {\it

 frame} or of the top level application window by default (i.e. when using
 frame} or of the top level application window by default (i.e. when using

-the second version of the function).
+the second version of the functions).

 
 If the target frame doesn't have a statusbar, the message will be lost.
 
 \membersection{::wxLogSysError}\label{wxlogsyserror}
 
 
 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}{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
 system call (API function) failure. It logs the specified message text as well
 
 Mostly used by wxWindows itself, but might be handy for logging errors after
 system call (API function) failure. It logs the specified message text as well


@@ -2609,33 +3061,41 @@ of this function takes the error code explicitly as the first argument.
 
 \membersection{::wxLogDebug}\label{wxlogdebug}
 
 
 \membersection{::wxLogDebug}\label{wxlogdebug}
 

-\func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogDebug}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogDebug}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}

 
 

-The right function for debug output. It only does anything at all in the debug
-mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expands to
+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).
 
 \membersection{::wxLogTrace}\label{wxlogtrace}
 
 nothing in release mode (otherwise).
 
 \membersection{::wxLogTrace}\label{wxlogtrace}
 

-\func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogTrace}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogTrace}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}

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

+\func{void}{wxVLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
+

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

+\func{void}{wxVLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
+

 As {\bf wxLogDebug}, trace functions only do something in debug build and
 expand to nothing in the release one. The reason for making
 it a separate function from it is that usually there are a lot of trace
 messages, so it might make sense to separate them from other debug messages.
 
 The trace messages also usually can be separated into different categories and
 As {\bf wxLogDebug}, trace functions only do something in debug build and
 expand to nothing in the release one. The reason for making
 it a separate function from it is that usually there are a lot of trace
 messages, so it might make sense to separate them from other debug messages.
 
 The trace messages also usually can be separated into different categories and

-the second and third versions of this function only log the message if the 
+the second and third versions of this function only log the message if the

 {\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
 allows to selectively trace only some operations and not others by changing
 the value of the trace mask (possible during the run-time).
 
 For the second function (taking a string mask), the message is logged only if
 {\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
 allows to selectively trace only some operations and not others by changing
 the value of the trace mask (possible during the run-time).
 
 For the second function (taking a string mask), the message is logged only if

-the mask has been previously enabled by the call to 
+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}. The predefined string trace masks
 used by wxWindows are:
 


@@ -2678,8 +3138,8 @@ Returns the error code from the last system call. This function uses
 
 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
 
 
 \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
 

-Returns the error message corresponding to the given system error code. If 
-{\it errCode} is $0$ (default), the last error code (as returned by 
+Returns the error message corresponding to the given system error code. If
+{\it errCode} is $0$ (default), the last error code (as returned by

 \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
 
 \wxheading{See also}
 \helpref{wxSysErrorCode}{wxsyserrorcode}) is used.
 
 \wxheading{See also}


@@ -2687,14 +3147,76 @@ 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}
+
+<wx/object.h>
+
+\func{}{WXTRACE}{formatString, ...}
+
+Calls wxTrace with printf-style variable argument syntax. Output
+is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
+
+This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
+\wxheading{Include files}
+
+<wx/memory.h>
+
+\membersection{WXTRACELEVEL}\label{tracelevel}
+
+\func{}{WXTRACELEVEL}{level, formatString, ...}
+
+Calls wxTraceLevel with printf-style variable argument syntax. Output
+is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
+The first argument should be the level at which this information is appropriate.
+It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
+this value.
+
+This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
+\wxheading{Include files}
+
+<wx/memory.h>
+
+\membersection{::wxTrace}\label{wxtrace}
+
+\func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
+
+Takes printf-style variable argument syntax. Output
+is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
+
+This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
+\wxheading{Include files}
+
+<wx/memory.h>
+
+\membersection{::wxTraceLevel}\label{wxtracelevel}
+
+\func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
+
+Takes printf-style variable argument syntax. Output
+is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
+The first argument should be the level at which this information is appropriate.
+It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
+this value.
+
+This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
+\wxheading{Include files}
+
+<wx/memory.h>
+

 \section{Time functions}\label{timefunctions}
 
 The functions in this section deal with getting the current time and
 starting/stopping the global timers. Please note that the timer functions are
 \section{Time functions}\label{timefunctions}
 
 The functions in this section deal with getting the current time and
 starting/stopping the global timers. Please note that the timer functions are

-deprecated because they work with one global timer only and 
+deprecated because they work with one global timer only and

 \helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
 \helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes

-should be used instead. For retrieving the current time, you may also use 
-\helpref{wxDateTime::Now}{wxdatetimenow} or 
+should be used instead. For retrieving the current time, you may also use
+\helpref{wxDateTime::Now}{wxdatetimenow} or

 \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
 
 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
 \helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
 
 \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}


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

+\membersection{::wxNow}\label{wxnow}
+
+\func{wxString}{wxNow}{\void}
+
+Returns a string representing the current date and time.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxSleep}\label{wxsleep}
+
+\func{void}{wxSleep}{\param{int}{ secs}}
+
+Sleeps for the specified number of seconds.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+

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


@@ -2767,11 +3309,28 @@ See also \helpref{wxTimer}{wxtimer}.
 
 <wx/timer.h>
 
 
 <wx/timer.h>
 

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

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

-Useful macros and functions for error checking and defensive programming. ASSERTs are only
-compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
-builds.
+Useful macros and functions for error checking and defensive programming.
+wxWindows 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
+check failure doesn't generate any user-visible effects then. Finally, the
+compile time assertions don't happen during the run-time but result in the
+compilation error messages if the condition they check fail.

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


@@ -2779,12 +3338,17 @@ builds.
 
 \membersection{::wxOnAssert}\label{wxonassert}
 
 
 \membersection{::wxOnAssert}\label{wxonassert}
 

-\func{void}{wxOnAssert}{\param{const char*}{ fileName}, \param{int}{ lineNumber}, \param{const char*}{ msg = NULL}}
+\func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{msg = NULL}}
+
+This function is called whenever one of debugging macros fails (i.e. condition
+is false in an assertion). It is only defined in the debug mode, in release
+builds the \helpref{wxCHECK}{wxcheck} failures don't result in anything.

 
 

-This function may be redefined to do something non trivial and is called
-whenever one of debugging macros fails (i.e. condition is false in an
-assertion).
-% TODO: this should probably be an overridable in wxApp.
+To override the default behaviour in the debug builds which is to show the user
+a dialog asking whether he wants to abort the program, continue or continue
+ignoring any subsequent assert failures, you may override 
+\helpref{wxApp::OnAssert}{wxapponassert} which is called by this function if
+the global application object exists.

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


@@ -2796,7 +3360,28 @@ debug mode, but nothing will be done in the release build.
 Please note that the condition in wxASSERT() should have no side effects
 because it will not be executed in release mode at all.
 
 Please note that the condition in wxASSERT() should have no side effects
 because it will not be executed in release mode at all.
 

-See also: \helpref{wxASSERT\_MSG}{wxassertmsg}
+\wxheading{See also}
+
+\helpref{wxASSERT\_MSG}{wxassertmsg},\\
+\helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
+
+\membersection{wxASSERT\_MIN\_BITSIZE}\label{wxassertminbitsize}
+
+\func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}}
+
+This macro results in a 
+\helpref{compile time assertion failure}{wxCOMPILE\_TIME\_ASSERT} if the size
+of the given type {\it type} is less than {\it size} bits.
+
+You may use it like this, for example:
+
+\begin{verbatim}
+    // we rely on the int being able to hold values up to 2^32
+    wxASSERT_MIN_BITSIZE(int, 32);
+
+    // can't work with the platforms using UTF-8 for wchar_t
+    wxASSERT_MIN_BITSIZE(wchar_t, 16);
+\end{verbatim}

 
 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
 
 
 \membersection{wxASSERT\_MSG}\label{wxassertmsg}
 


@@ -2804,7 +3389,43 @@ See also: \helpref{wxASSERT\_MSG}{wxassertmsg}
 
 Assert macro with message. An error message will be generated if the condition is FALSE.
 
 
 Assert macro with message. An error message will be generated if the condition is FALSE.
 

-See also: \helpref{wxASSERT}{wxassert}
+\wxheading{See also}
+
+\helpref{wxASSERT}{wxassert},\\
+\helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}
+
+\membersection{wxCOMPILE\_TIME\_ASSERT}\label{wxcompiletimeassert}
+
+\func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}}
+
+Using {\tt wxCOMPILE\_TIME\_ASSERT} results in a compilation error if the
+specified {\it condition| is false. The compiler error message should include
+the {\it msg} identifier - please note that it must be a valid C++ identifier
+and not a string unlike in the other cases.
+
+This macro is mostly useful for testing the expressions involing the 
+{\tt sizeof} operator as they can't be tested by the preprocessor but it is
+sometimes desirable to test them at the compile time.
+
+Note that this macro internally declares a struct whose name it tries to make
+unique by using the {\tt \_\_LINE\_\_} in it but it may still not work if you
+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.
+
+\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}}
+
+This macro is identical to \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} 
+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}.

 
 \membersection{wxFAIL}\label{wxfail}
 
 
 \membersection{wxFAIL}\label{wxfail}
 


@@ -2824,7 +3445,9 @@ This macro is useful for marking unreachable" code areas, for example
 it may be used in the "default:" branch of a switch statement if all possible
 cases are processed above.
 
 it may be used in the "default:" branch of a switch statement if all possible
 cases are processed above.
 

-See also: \helpref{wxFAIL}{wxfail}
+\wxheading{See also}
+
+\helpref{wxFAIL}{wxfail}

 
 \membersection{wxCHECK}\label{wxcheck}
 
 
 \membersection{wxCHECK}\label{wxcheck}
 


@@ -2840,7 +3463,7 @@ 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.
 
 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.
 

-This macro may be only used in non void functions, see also 
+This macro may be only used in non void functions, see also

 \helpref{wxCHECK\_RET}{wxcheckret}.
 
 \membersection{wxCHECK\_RET}\label{wxcheckret}
 \helpref{wxCHECK\_RET}{wxcheckret}.
 
 \membersection{wxCHECK\_RET}\label{wxcheckret}


@@ -2850,15 +3473,15 @@ This macro may be only used in non void functions, see also
 Checks that the condition is true, and returns if not (FAILs with given error
 message in debug mode). This check is done even in release mode.
 
 Checks that the condition is true, and returns if not (FAILs with given error
 message in debug mode). This check is done even in release mode.
 

-This macro should be used in void functions instead of 
+This macro should be used in void functions instead of

 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
 
 \membersection{wxCHECK2}\label{wxcheck2}
 
 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
 
 \helpref{wxCHECK\_MSG}{wxcheckmsg}.
 
 \membersection{wxCHECK2}\label{wxcheck2}
 
 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
 

-Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute 
-{\it operation} if it is not. This is a generalisation of 
+Checks that the condition is true and \helpref{wxFAIL}{wxfail} and execute
+{\it operation} if it is not. This is a generalisation of

 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
 returning from the function must be done when the {\it condition} is false.
 
 \helpref{wxCHECK}{wxcheck} and may be used when something else than just
 returning from the function must be done when the {\it condition} is false.
 


@@ -2868,7 +3491,73 @@ This check is done even in release mode.
 
 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
 
 
 \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
 

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