\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}
-The functions defined in wxWindows are described here.
+The functions and macros defined in wxWindows are described here: 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}{functionwxclipboardopen}\\
+\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}{functionwxdirexists}\\
+\helpref{wxDirSelector}{wxdirselector}\\
+\helpref{wxDisplayDepth}{wxdisplaydepth}\\
+\helpref{wxDisplaySize}{wxdisplaysize}\\
+\helpref{wxDisplaySizeMM}{wxdisplaysizemm}\\
+\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{wxEXPLICIT}{wxexplicit}\\
+\helpref{wxFAIL\_MSG}{wxfailmsg}\\
+\helpref{wxFAIL}{wxfail}\\
+\helpref{wxFatalError}{wxfatalerror}\\
+\helpref{wxFileExists}{functionwxfileexists}\\
+\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{wxGetProcessId}{wxgetprocessid}\\
+\helpref{wxGetResource}{wxgetresource}\\
+\helpref{wxGetSingleChoiceData}{wxgetsinglechoicedata}\\
+\helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex}\\
+\helpref{wxGetSingleChoice}{wxgetsinglechoice}\\
+\helpref{wxGetTempFileName}{wxgettempfilename}\\
+\helpref{wxGetTextFromUser}{wxgettextfromuser}\\
+\helpref{wxGetTopLevelParent}{wxgettoplevelparent}\\
+\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{wxSafeShowMessage}{wxsafeshowmessage}\\
+\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{wxShutdown}{wxshutdown}\\
+\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}
+
+The following constants are defined in wxWindows:
-\section{File functions}\label{filefunctions}
-
-\wxheading{Include files}
-
-<wx/utils.h>
+\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 wxRELEASE\_NUMBER} is the release number
+\end{itemize}
-\wxheading{See also}
+For example, the values or these constants for wxWindows 2.1.15 are 2, 1 and
+15.
-\helpref{wxPathList}{wxpathlist}
+Additionally, {\tt wxVERSION\_STRING} is a user-readable string containing
+the full wxWindows version and {\tt wxVERSION\_NUMBER} is a combination of the
+three version numbers above: for 2.1.15, it is 2115 and it is 2200 for
+wxWindows 2.2.
-\membersection{::wxDirExists}
+\wxheading{Include files}
-\func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
+<wx/version.h> or <wx/defs.h>
-Returns TRUE if the directory exists.
+\membersection{wxCHECK\_VERSION}\label{wxcheckversion}
-\membersection{::wxDos2UnixFilename}
+\func{bool}{wxCHECK\_VERSION}{\param{}{major, minor, release}}
-\func{void}{Dos2UnixFilename}{\param{const wxString\& }{s}}
+This is a macro which evaluates to true if the current wxWindows version is at
+least major.minor.release.
-Converts a DOS to a Unix filename by replacing backslashes with forward
-slashes.
+For example, to test if the program is compiled with wxWindows 2.2 or higher,
+the following can be done:
-\membersection{::wxFileExists}
+\begin{verbatim}
+ wxString s;
+#if wxCHECK_VERSION(2, 2, 0)
+ if ( s.StartsWith("foo") )
+#else // replacement code for old version
+ if ( strncmp(s, "foo", 3) == 0 )
+#endif
+ {
+ ...
+ }
+\end{verbatim}
-\func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
+\section{Application initialization and termination}\label{appinifunctions}
-Returns TRUE if the file exists. It also returns TRUE if the file is
-a directory.
+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{::wxFileNameFromPath}
+\membersection{::wxEntry}\label{wxentry}
-\func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}}
+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{char*}{wxFileNameFromPath}{\param{char* }{path}}
+\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
+ \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
-Returns the filename for a full path. The second form returns a pointer to
-temporary storage that should not be deallocated.
+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.
-\membersection{::wxFindFirstFile}\label{wxfindfirstfile}
+\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
+ \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
-\func{wxString}{wxFindFirstFile}{\param{const char*}{spec}, \param{int}{ flags = 0}}
+wxWindows initialization under Windows (for applications constructed as a DLL).
-This function does directory searching; returns the first file
-that matches the path {\it spec}, or the empty string. Use \helpref{wxFindNextFile}{wxfindnextfile} to
-get the next matching file. Neither will report the current directory "." or the
-parent directory "..".
+\func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
-{\it spec} may contain wildcards.
+wxWindows initialization under Unix.
-{\it flags} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
+\wxheading{Remarks}
-For example:
+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}
- wxString f = wxFindFirstFile("/home/project/*.*");
- while ( !f.IsEmpty() )
- {
- ...
- f = wxFindNextFile();
- }
-\end{verbatim}
-
-\membersection{::wxFindNextFile}\label{wxfindnextfile}
+int CTheApp::ExitInstance()
+{
+ // OnExit isn't called by CleanUp so must be called explicitly.
+ wxTheApp->OnExit();
+ wxApp::CleanUp();
-\func{wxString}{wxFindNextFile}{\void}
+ return CWinApp::ExitInstance();
+}
+\end{verbatim}
-Returns the next file that matches the path passed to \helpref{wxFindFirstFile}{wxfindfirstfile}.
+\wxheading{Include files}
-See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example.
+<wx/app.h>
-\membersection{::wxGetOSDirectory}\label{wxgetosdirectory}
+\membersection{::wxHandleFatalExceptions}\label{wxhandlefatalexceptions}
-\func{wxString}{wxGetOSDirectory}{\void}
+\func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = TRUE}}
-Returns the Windows directory under Windows; on other platforms returns the empty string.
+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}
-Adds some common image format handlers, which, depending on wxWindows
-configuration, can be handlers for BMP (loading) (always installed), GIF
-(loading), PCX (loading), PNM (loading and saving as raw
-rgb), PNG (loading and saving), JPEG (loading and saving), file formats.
+Initializes all available image handlers. For a list of available handlers,
+see \helpref{wxImage}{wximage}.
-See also: \helpref{wxImage}{wximage} \helpref{wxImageHandler}{wximagehandler}
+\wxheading{See also}
-\membersection{::wxIsAbsolutePath}
+\helpref{wxImage}{wximage}, \helpref{wxImageHandler}{wximagehandler}
-\func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
+\wxheading{Include files}
-Returns TRUE if the argument is an absolute filename, i.e. with a slash
-or drive name at the beginning.
+<wx/image.h>
-\membersection{::wxPathOnly}
+\membersection{::wxInitialize}\label{wxinitialize}
-\func{wxString}{wxPathOnly}{\param{const wxString\& }{path}}
+\func{bool}{wxInitialize}{\void}
-Returns the directory part of the filename.
+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.
-\membersection{::wxUnix2DosFilename}
+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.
-\func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}}
+This function may be called several times but
+\helpref{wxUninitialize}{wxuninitialize} must be called for each successful
+call to this function.
-Converts a Unix to a DOS filename by replacing forward
-slashes with backslashes.
+\wxheading{Include files}
-\membersection{::wxConcatFiles}
+<wx/app.h>
-\func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2},
-\param{const wxString\& }{file3}}
+\membersection{::wxSafeYield}\label{wxsafeyield}
-Concatenates {\it file1} and {\it file2} to {\it file3}, returning
-TRUE if successful.
+\func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
-\membersection{::wxCopyFile}
+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.
-\func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
+Returns the result of the call to \helpref{::wxYield}{wxyield}.
-Copies {\it file1} to {\it file2}, returning TRUE if successful.
+\wxheading{Include files}
-\membersection{::wxGetCwd}\label{wxgetcwd}
+<wx/utils.h>
-\func{wxString}{wxGetCwd}{\void}
+\membersection{::wxUninitialize}\label{wxuninitialize}
-Returns a string containing the current (or working) directory.
+\func{void}{wxUninitialize}{\void}
-\membersection{::wxGetWorkingDirectory}
+This function is for use in console (wxBase) programs only. It must be called
+once for each previous successful call to \helpref{wxInitialize}{wxinitialize}.
-\func{wxString}{wxGetWorkingDirectory}{\param{char*}{buf=NULL}, \param{int }{sz=1000}}
+\wxheading{Include files}
-This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.
+<wx/app.h>
-Copies the current working directory into the buffer if supplied, or
-copies the working directory into new storage (which you must delete yourself)
-if the buffer is NULL.
+\membersection{::wxYield}\label{wxyield}
-{\it sz} is the size of the buffer if supplied.
+\func{bool}{wxYield}{\void}
-\membersection{::wxGetTempFileName}
+Calls \helpref{wxApp::Yield}{wxappyield}.
-\func{char*}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char* }{buf=NULL}}
+This function is kept only for backwards compatibility, please use
+\helpref{wxApp::Yield}{wxappyield}method instead in any new code.
-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}.
+\wxheading{Include files}
-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.
+<wx/app.h> or <wx/utils.h>
-It is the application's responsibility to create and delete the file.
+\membersection{::wxWakeUpIdle}\label{wxwakeupidle}
-\membersection{::wxIsWild}\label{wxiswild}
+\func{void}{wxWakeUpIdle}{\void}
-\func{bool}{wxIsWild}{\param{const wxString\& }{pattern}}
+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}.
-Returns TRUE if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}.
+\wxheading{Include files}
-\membersection{::wxMatchWild}\label{wxmatchwild}
+<wx/app.h>
-\func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}}
+\section{Process control functions}\label{processfunctions}
-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}.
+The functions in this section are used to launch or terminate the other
+processes.
-\membersection{::wxMkdir}
+\membersection{::wxExecute}\label{wxexecute}
-\func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}}
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{int }{sync = wxEXEC\_ASYNC}, \param{wxProcess *}{callback = NULL}}
-Makes the directory {\it dir}, returning TRUE if successful.
+\func{long}{wxExecute}{\param{char **}{argv}, \param{int }{flags = wxEXEC\_ASYNC}, \param{wxProcess *}{callback = NULL}}
-{\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.
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
-\membersection{::wxRemoveFile}
+\perlnote{In wxPerl this function only takes the {\tt command} argument,
+and returns a 2-element list {\tt ( status, output )}, where {\tt output} is
+an array reference.}
-\func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}}
-Removes {\it file}, returning TRUE if successful.
+\perlnote{In wxPerl this function only takes the {\tt command} argument,
+and returns a 3-element list {\tt ( status, output, errors )}, where
+{\tt output} and {\tt errors} are array references.}
-\membersection{::wxRenameFile}
+Executes another program in Unix or Windows.
-\func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
+The first form takes a command string, such as {\tt "emacs file.txt"}.
-Renames {\it file1} to {\it file2}, returning TRUE if successful.
+The second form takes an array of values: a command, any number of
+arguments, terminated by NULL.
-\membersection{::wxRmdir}
+The semantics of the third and fourth versions is different from the first two
+and is described in more details below.
-\func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
+If {\it flags} parameter contains {\tt wxEXEC\_ASYNC} flag (the default), flow
+of control immediately returns. If it contains {\tt wxEXEC\_SYNC}, the current
+application waits until the other program has terminated.
-Removes the directory {\it dir}, returning TRUE if successful. Does not work under VMS.
+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}.
-The {\it flags} parameter is reserved for future use.
+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 indicates 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,
+\helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
+the process finishes. Specifying this parameter also allows you to redirect the
+standard input and/or output of the process being launched by calling
+\helpref{Redirect}{wxprocessredirect}. If the child process IO is redirected,
+under Windows the process window is not shown by default (this avoids having to
+flush an unnecessary console for the processes which don't create any windows
+anyhow) but a {\tt wxEXEC\_NOHIDE} flag can be used to prevent this from
+happening, i.e. with this flag the child process window will be shown normally.
-\membersection{::wxSetWorkingDirectory}
+Under Unix the flag {\tt wxEXEC\_MAKE\_GROUP\_LEADER} may be used to ensure
+that the new process is a group leader (this will create a new session if
+needed). Calling \helpref{wxKill}{wxkill} with the argument of -pid where pid
+is the process ID of the new process will kill this process as well as all of
+its children (except those which have started their own session).
-\func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
+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.
-Sets the current working directory, returning TRUE if the operation succeeded.
-Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification.
+See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
+\helpref{Exec sample}{sampleexec}.
-\membersection{::wxSplitPath}\label{wxsplitfunction}
+\wxheading{Parameters}
-\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{const wxString *}{ path}, \param{const wxString *}{ name}, \param{const wxString *}{ ext}}
+\docparam{command}{The command to execute and any parameters to pass to it as a
+single string.}
-This function splits a full file name into components: the path (including possible disk/drive
-specification under Windows), the base name and the extension. Any of the output parameters
-({\it path}, {\it name} or {\it ext}) may be NULL if you are not interested in the value of
-a particular component.
+\docparam{argv}{The command to execute should be the first element of this
+array, any additional ones are the command parameters and the array must be
+terminated with a NULL pointer.}
-wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
-Windows, however it will not consider backslashes as path separators under Unix (where backslash
-is a valid character in a filename).
+\docparam{flags}{Combination of bit masks {\tt wxEXEC\_ASYNC},
+{\tt wxEXEC\_SYNC} and {\tt wxEXEC\_NOHIDE}}
-On entry, {\it fullname} should be non NULL (it may be empty though).
+\docparam{callback}{An optional pointer to \helpref{wxProcess}{wxprocess}}
-On return, {\it path} contains the file path (without the trailing separator), {\it name}
-contains the file name and {\it ext} contains the file extension without leading dot. All
-three of them may be empty if the corresponding component is. The old contents of the
-strings pointed to by these parameters will be overwritten in any case (if the pointers
-are not NULL).
+\wxheading{Include files}
-\membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
+<wx/utils.h>
-\func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
+\membersection{::wxExit}\label{wxexit}
-Copies the given file to {\it stream}. Useful when converting an old application to
-use streams (within the document/view framework, for example).
+\func{void}{wxExit}{\void}
-Use of this function requires the file wx\_doc.h to be included.
+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{wxCloseEvent}{wxcloseevent} and \helpref{wxApp}{wxapp}.
-\membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
+\wxheading{Include files}
-\func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
+<wx/app.h>
-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).
+\membersection{::wxKill}\label{wxkill}
-Use of this function requires the file wx\_doc.h to be included.
+\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}}
-\section{Network functions}\label{networkfunctions}
+Equivalent to the Unix kill function: send the given signal {\it sig} to the
+process with PID {\it pid}. The valid signal values are
-\membersection{::wxGetFullHostName}\label{wxgetfullhostname}
+\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}
-\func{wxString}{wxGetFullHostName}{\void}
+{\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 the FQDN (fully qualified domain host name) or an empty string on
-error.
+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}
-See also: \helpref{wxGetHostName}{wxgethostname}
+\wxheading{See also}
+
+\helpref{wxProcess::Kill}{wxprocesskill},\rtfsp
+\helpref{wxProcess::Exists}{wxprocessexists},\rtfsp
+\helpref{Exec sample}{sampleexec}
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
+\membersection{::wxGetProcessId}\label{wxgetprocessid}
-\func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
+\func{unsigned long}{wxGetProcessId}{\void}
-Copies the user's email address into the supplied buffer, by
-concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
-and \helpref{wxGetUserId}{wxgetuserid}.
+Returns the number uniquely identifying the current process in the system.
-Returns TRUE if successful, FALSE otherwise.
+If an error occurs, $0$ is returned.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxGetHostName}\label{wxgethostname}
-
-\func{wxString}{wxGetHostName}{\void}
-\func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
-
-Copies the current host machine's name into the supplied buffer. Please note
-that the returned name is {\it not} fully qualified, i.e. it does not include
-the domain name.
+\membersection{::wxShell}\label{wxshell}
-Under Windows or NT, this function first looks in the environment
-variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp
-in the {\bf wxWindows} section of the WIN.INI file is tried.
+\func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
-The first variant of this function returns the hostname if successful or an
-empty string otherwise. The second (deprecated) function returns TRUE
-if successful, FALSE otherwise.
+Executes a command in an interactive shell window. If no command is
+specified, then just the shell is spawned.
-See also: \helpref{wxGetFullHostName}{wxgetfullhostname}
+See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
\wxheading{Include files}
<wx/utils.h>
-\section{User identification}\label{useridfunctions}
+\membersection{::wxShutdown}\label{wxshutdown}
-\membersection{::wxGetUserId}\label{wxgetuserid}
+\func{bool}{wxShutdown}{\param{wxShutdownFlags}{flags}}
-\func{wxString}{wxGetUserId}{\void}
-\func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
+This function shuts down or reboots the computer depending on the value of the
+{\it flags}. Please notice that doing this requires the corresponding access
+rights (superuser under Unix, {\tt SE\_SHUTDOWN} privelege under Windows NT)
+and that this function is only implemented under Unix and Win32.
-This function returns the "user id" also known as "login name" under Unix i.e.
-something like "jsmith". It uniquely identifies the current user (on this system).
+\wxheading{Parameters}
-Under Windows or NT, this function first looks in the environment
-variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp
-in the {\bf wxWindows} section of the WIN.INI file is tried.
+\docparam{flags}{Either {\tt wxSHUTDOWN\_POWEROFF} or {\tt wxSHUTDOWN\_REBOOT}}
-The first variant of this function returns the login name if successful or an
-empty string otherwise. The second (deprecated) function returns TRUE
-if successful, FALSE otherwise.
+\wxheading{Returns}
-See also: \helpref{wxGetUserName}{wxgetusername}
+{\tt TRUE} on success, {\tt FALSE} if an error occured.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxGetUserName}\label{wxgetusername}
+\section{Thread functions}\label{threadfunctions}
-\func{wxString}{wxGetUserName}{\void}
-\func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}}
+\wxheading{Include files}
-This function returns the full user name (something like "Mr. John Smith").
+<wx/thread.h>
-Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp
-in the {\bf wxWindows} section of the WIN.INI file. If PenWindows
-is running, the entry {\bf Current} in the section {\bf User} of
-the PENWIN.INI file is used.
+\wxheading{See also}
-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.
+\helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}, \helpref{Multithreading overview}{wxthreadoverview}
-See also: \helpref{wxGetUserId}{wxgetuserid}
+\membersection{::wxMutexGuiEnter}\label{wxmutexguienter}
-\wxheading{Include files}
+\func{void}{wxMutexGuiEnter}{\void}
-<wx/utils.h>
+This function must be called when any thread other than the main GUI thread
+wants to get access to the GUI library. This function will block the execution
+of the calling thread until the main thread (or any other thread holding the
+main GUI lock) leaves the GUI library and no other thread will enter the GUI
+library until the calling thread calls \helpref{::wxMutexGuiLeave()}{wxmutexguileave}.
-\section{String functions}
+Typically, these functions are used like this:
-\membersection{::copystring}
+\begin{verbatim}
+void MyThread::Foo(void)
+{
+ // before doing any GUI calls we must ensure that this thread is the only
+ // one doing it!
-\func{char*}{copystring}{\param{const char* }{s}}
+ wxMutexGuiEnter();
-Makes a copy of the string {\it s} using the C++ new operator, so it can be
-deleted with the {\it delete} operator.
+ // Call GUI here:
+ my_window->DrawSomething();
-\membersection{::wxStringMatch}
+ wxMutexGuiLeave();
+}
+\end{verbatim}
-\func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
- \param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}}
+Note that under GTK, no creation of top-level windows is allowed in any
+thread but the main one.
-Returns TRUE if the substring {\it s1} is found within {\it s2},
-ignoring case if {\it exact} is FALSE. If {\it subString} is FALSE,
-no substring matching is done.
+This function is only defined on platforms which support preemptive
+threads.
-\membersection{::wxStringEq}\label{wxstringeq}
+\membersection{::wxMutexGuiLeave}\label{wxmutexguileave}
-\func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
+\func{void}{wxMutexGuiLeave}{\void}
-A macro defined as:
+See \helpref{::wxMutexGuiEnter()}{wxmutexguienter}.
+
+This function is only defined on platforms which support preemptive
+threads.
+
+\section{File functions}\label{filefunctions}
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\wxheading{See also}
+
+\helpref{wxPathList}{wxpathlist}\\
+\helpref{wxDir}{wxdir}\\
+\helpref{wxFile}{wxfile}\\
+\helpref{wxFileName}{wxfilename}
+
+\membersection{::wxDirExists}\label{functionwxdirexists}
+
+\func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
+
+Returns TRUE if the directory exists.
+
+\membersection{::wxDos2UnixFilename}\label{wxdos2unixfilename}
+
+\func{void}{wxDos2UnixFilename}{\param{wxChar *}{s}}
+
+Converts a DOS to a Unix filename by replacing backslashes with forward
+slashes.
+
+\membersection{::wxFileExists}\label{functionwxfileexists}
+
+\func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
+
+Returns TRUE if the file exists. It also returns TRUE if the file is
+a directory.
+
+\membersection{::wxFileModificationTime}\label{wxfilemodificationtime}
+
+\func{time\_t}{wxFileModificationTime}{\param{const wxString\& }{filename}}
+
+Returns time of last modification of given file.
+
+\membersection{::wxFileNameFromPath}\label{wxfilenamefrompath}
+
+\func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}}
+
+\func{char *}{wxFileNameFromPath}{\param{char *}{path}}
+
+{\bf NB:} This function is obsolete, please use
+\helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
+
+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}}
+
+This function does directory searching; returns the first file
+that matches the path {\it spec}, or the empty string. Use \helpref{wxFindNextFile}{wxfindnextfile} to
+get the next matching file. Neither will report the current directory "." or the
+parent directory "..".
+
+{\it spec} may contain wildcards.
+
+{\it flags} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
+
+For example:
+
+\begin{verbatim}
+ wxString f = wxFindFirstFile("/home/project/*.*");
+ while ( !f.IsEmpty() )
+ {
+ ...
+ f = wxFindNextFile();
+ }
+\end{verbatim}
+
+\membersection{::wxFindNextFile}\label{wxfindnextfile}
+
+\func{wxString}{wxFindNextFile}{\void}
+
+Returns the next file that matches the path passed to \helpref{wxFindFirstFile}{wxfindfirstfile}.
+
+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{::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.
+
+\membersection{::wxPathOnly}\label{wxpathonly}
+
+\func{wxString}{wxPathOnly}{\param{const wxString\& }{path}}
+
+Returns the directory part of the filename.
+
+\membersection{::wxUnix2DosFilename}\label{wxunix2dosfilename}
+
+\func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}}
+
+Converts a Unix to a DOS filename by replacing forward
+slashes with backslashes.
+
+\membersection{::wxConcatFiles}\label{wxconcatfiles}
+
+\func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2},
+\param{const wxString\& }{file3}}
+
+Concatenates {\it file1} and {\it file2} to {\it file3}, returning
+TRUE if successful.
+
+\membersection{::wxCopyFile}\label{wxcopyfile}
+
+\func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = TRUE}}
+
+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 fails in this
+case.
+
+\membersection{::wxGetCwd}\label{wxgetcwd}
+
+\func{wxString}{wxGetCwd}{\void}
+
+Returns a string containing the current (or working) directory.
+
+\membersection{::wxGetWorkingDirectory}\label{wxgetworkingdirectory}
+
+\func{wxString}{wxGetWorkingDirectory}{\param{char *}{buf=NULL}, \param{int }{sz=1000}}
+
+{\bf NB:} This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.
+
+Copies the current working directory into the buffer if supplied, or
+copies the working directory into new storage (which you must delete yourself)
+if the buffer is NULL.
+
+{\it sz} is the size of the buffer if supplied.
+
+\membersection{::wxGetTempFileName}\label{wxgettempfilename}
+
+\func{char *}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char *}{buf=NULL}}
+
+\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.
+
+{\bf NB:} These functions are obsolete, please use\rtfsp
+\helpref{wxFileName::CreateTempFileName}{wxfilenamecreatetempfilename}\rtfsp
+instead.
+
+\membersection{::wxIsWild}\label{wxiswild}
+
+\func{bool}{wxIsWild}{\param{const wxString\& }{pattern}}
+
+Returns TRUE if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}.
+
+\membersection{::wxMatchWild}\label{wxmatchwild}
+
+\func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}}
+
+Returns TRUE if the {\it pattern}\/ matches the {\it text}\/; if {\it
+dot\_special}\/ is TRUE, filenames beginning with a dot are not matched
+with wildcard characters. See \helpref{wxIsWild}{wxiswild}.
+
+\membersection{::wxMkdir}\label{wxmkdir}
+
+\func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}}
+
+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.
+
+\membersection{::wxRemoveFile}\label{wxremovefile}
+
+\func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
+
+Removes {\it file}, returning TRUE if successful.
+
+\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.
+
+\membersection{::wxRmdir}\label{wxrmdir}
+
+\func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
+
+Removes the directory {\it dir}, returning TRUE if successful. Does not work under VMS.
+
+The {\it flags} parameter is reserved for future use.
+
+\membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory}
+
+\func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
+
+Sets the current working directory, returning TRUE if the operation succeeded.
+Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification.
+
+\membersection{::wxSplitPath}\label{wxsplitfunction}
+
+\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
+
+{\bf NB:} This function is obsolete, please use
+\helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
+
+This function splits a full file name into components: the path (including possible disk/drive
+specification under Windows), the base name and the extension. Any of the output parameters
+({\it path}, {\it name} or {\it ext}) may be NULL if you are not interested in the value of
+a particular component.
+
+wxSplitPath() will correctly handle filenames with both DOS and Unix path separators under
+Windows, however it will not consider backslashes as path separators under Unix (where backslash
+is a valid character in a filename).
+
+On entry, {\it fullname} should be non-NULL (it may be empty though).
+
+On return, {\it path} contains the file path (without the trailing separator), {\it name}
+contains the file name and {\it ext} contains the file extension without leading dot. All
+three of them may be empty if the corresponding component is. The old contents of the
+strings pointed to by these parameters will be overwritten in any case (if the pointers
+are not NULL).
+
+\membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
+
+\func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
+
+Copies the given file to {\it stream}. Useful when converting an old application to
+use streams (within the document/view framework, for example).
+
+\wxheading{Include files}
+
+<wx/docview.h>
+
+\membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
+
+\func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
+
+Copies the given stream to the file {\it filename}. Useful when converting an old application to
+use streams (within the document/view framework, for example).
+
+\wxheading{Include files}
+
+<wx/docview.h>
+
+\section{Network, user and OS functions}\label{networkfunctions}
+
+The functions in this section are used to retrieve information about the
+current computer and/or user characteristics.
+
+\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}
+
+\func{wxString}{wxGetFullHostName}{\void}
+
+Returns the FQDN (fully qualified domain host name) or an empty string on
+error.
+
+\wxheading{See also}
+
+\helpref{wxGetHostName}{wxgethostname}
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
+
+\func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
+
+Copies the user's email address into the supplied buffer, by
+concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
+and \helpref{wxGetUserId}{wxgetuserid}.
+
+Returns TRUE if successful, FALSE otherwise.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxGetHomeDir}\label{wxgethomedir}
+
+\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}}
+
+Copies the current host machine's name into the supplied buffer. Please note
+that the returned name is {\it not} fully qualified, i.e. it does not include
+the domain name.
+
+Under Windows or NT, this function first looks in the environment
+variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp
+in the {\bf wxWindows} section of the WIN.INI file is tried.
+
+The first variant of this function returns the hostname if successful or an
+empty string otherwise. The second (deprecated) function returns TRUE
+if successful, FALSE otherwise.
+
+\wxheading{See also}
+
+\helpref{wxGetFullHostName}{wxgetfullhostname}
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxGetUserId}\label{wxgetuserid}
+
+\func{wxString}{wxGetUserId}{\void}
+
+\func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
+
+This function returns the "user id" also known as "login name" under Unix i.e.
+something like "jsmith". It uniquely identifies the current user (on this system).
+
+Under Windows or NT, this function first looks in the environment
+variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp
+in the {\bf wxWindows} section of the WIN.INI file is tried.
+
+The first variant of this function returns the login name if successful or an
+empty string otherwise. The second (deprecated) function returns TRUE
+if successful, FALSE otherwise.
+
+\wxheading{See also}
+
+\helpref{wxGetUserName}{wxgetusername}
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxGetOsDescription}\label{wxgetosdescription}
+
+\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}
+
+\func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}}
+
+This function returns the full user name (something like "Mr. John Smith").
+
+Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp
+in the {\bf wxWindows} section of the WIN.INI file. If PenWindows
+is running, the entry {\bf Current} in the section {\bf User} of
+the PENWIN.INI file is used.
-\begin{verbatim}
-#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
-\end{verbatim}
+The first variant of this function returns the user name if successful or an
+empty string otherwise. The second (deprecated) function returns {\tt TRUE}
+if successful, {\tt FALSE} otherwise.
+
+\wxheading{See also}
+
+\helpref{wxGetUserId}{wxgetuserid}
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\section{String functions}
+
+\membersection{::copystring}\label{copystring}
+
+\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.
-\membersection{::IsEmpty}\label{isempty}
+This function is deprecated, use \helpref{wxString}{wxstring} class instead.
-\func{bool}{IsEmpty}{\param{const char *}{ p}}
+\membersection{::wxIsEmpty}\label{wxisempty}
-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.
+\func{bool}{wxIsEmpty}{\param{const char *}{ p}}
-\membersection{::Stricmp}\label{stricmp}
+Returns {\tt TRUE} if the pointer is either {\tt NULL} or points to an empty
+string, {\tt FALSE} otherwise.
-\func{int}{Stricmp}{\param{const char *}{p1}, \param{const char *}{p2}}
+\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{::Strlen}\label{strlen}
+\membersection{::wxStringMatch}\label{wxstringmatch}
+
+\func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
+ \param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}}
+
+{\bf NB:} This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
+
+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.
+
+\membersection{::wxStringEq}\label{wxstringeq}
+
+\func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
+
+{\bf NB:} This function is obsolete, use \helpref{wxString}{wxstring} instead.
+
+A macro defined as:
+
+\begin{verbatim}
+#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
+\end{verbatim}
+
+\membersection{::wxStrlen}\label{wxstrlen}
-\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
same thing (i.e. returns the length of the string) except that it returns 0 if
-{\it p} is the NULL pointer.
+{\it p} is the {\tt NULL} pointer.
\membersection{::wxGetTranslation}\label{wxgettranslation}
\func{const char *}{wxGetTranslation}{\param{const char * }{str}}
-This function returns the translation of string {\it str} in the current
+This function returns the translation of string {\it str} in the current
\helpref{locale}{wxlocale}. If the string is not found in any of the loaded
-message catalogs (see \helpref{i18n overview}{internationalization}), the
+message catalogs (see \helpref{internationalization overview}{internationalization}), the
original string is returned. In debug build, an error message is logged - this
should help to find the strings which were not yet translated. As this function
is used very often, an alternative syntax is provided: the \_() macro is
defined as wxGetTranslation().
+\membersection{::wxSnprintf}\label{wxsnprintf}
+
+\func{int}{wxSnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{}{...}}
+
+This function replaces the dangerous standard function {\tt sprintf()} and is
+like {\tt snprintf()} available on some platforms. The only difference with
+sprintf() is that an additional argument - buffer size - is taken and the
+buffer is never overflowed.
+
+Returns the number of characters copied to the buffer or -1 if there is not
+enough space.
+
+\wxheading{See also}
+
+\helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}
+
+\membersection{::wxToLower}\label{wxtolower}
+
+\func{char}{wxToLower}{\param{char }{ch}}
+
+Converts the character to lower case. This is implemented as a macro for efficiency.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxToUpper}\label{wxtoupper}
+
+\func{char}{wxToUpper}{\param{char }{ch}}
+
+Converts the character to upper case. This is implemented as a macro for efficiency.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxVsnprintf}\label{wxvsnprintf}
+
+\func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}}
+
+The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list }
+argument instead of arbitrary number of parameters.
+
+\wxheading{See also}
+
+\helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv}
+
\section{Dialog functions}\label{dialogfunctions}
Below are a number of convenience functions for getting input from the
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},
\docparam{currentTip}{The index of the first tip to show - normally this index
is remembered between the 2 program runs.}
-\wxheading{See also:}
+\wxheading{See also}
\helpref{Tips overview}{tipsoverview}
<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 = ""},\\
\param{int}{ x = -1}, \param{int}{ y = -1}}
Pops up a file selector box. In Windows, this is the common file selector
-dialog. In X, this is a file selector box with somewhat less functionality.
+dialog. In X, this is a file selector box with the same functionality.
The path and filename are distinct elements of a full file pathname.
If path is empty, the current directory will be used. If filename is empty,
no default filename will be supplied. The wildcard determines what files
are displayed in the file selector, and file extension supplies a type
extension for the required filename. Flags may be a combination of wxOPEN,
-wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, or 0.
+wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0.
Both the Unix and Windows versions implement a wildcard filter. Typing a
filename containing wildcards (*, ?) in the filename text item, and
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}
Cancel). For example:
\begin{verbatim}
-const wxString& s = wxFileSelector("Choose a file to open");
-if (s)
+wxString filename = wxFileSelector("Choose a file to open");
+if ( !filename.empty() )
{
- ...
+ // work with the file
+ ...
}
+//else: cancelled by user
\end{verbatim}
\wxheading{Include files}
<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}}
+
+Shows the colour selection dialog and returns the colour selected by user or
+invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour
+is valid) if the dialog was cancelled.
+
+\wxheading{Parameters}
+
+\docparam{parent}{The parent window for the colour selection dialog}
+
+\docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
+
+\wxheading{Include files}
+
+<wx/colordlg.h>
+
+\membersection{::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}{
\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.
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}
<wx/textdlg.h>
+\membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
+
+\func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
+ \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL}}
+
+Similar to \helpref{wxGetTextFromUser}{wxgettextfromuser} but the text entered
+in the dialog is not shown on screen but replaced with stars. This is intended
+to be used for entering passwords as the function name implies.
+
+\wxheading{Include files}
+
+<wx/textdlg.h>
+
\membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
\func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
\param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
\param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
-Pop up a dialog box with title set to {\it caption}, message {\it message}, and a
+Pop up a dialog box with title set to {\it caption}, {\it message}, and a
\rtfsp{\it default\_value}. The user may type in text and press OK to return this text,
or press Cancel to return the empty string.
\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>
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
+
\membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
-\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{const wxArrayString\& }{aChoices},\\
+ \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
+
+\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{int}{ n}, \param{const wxString\& }{choices[]},\\
\param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
\param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
-As {\bf wxGetSingleChoice} but returns the index representing the selected string.
-If the user pressed cancel, -1 is returned.
+As {\bf wxGetSingleChoice} but returns the index representing the selected
+string. If the user pressed cancel, -1 is returned.
\wxheading{Include files}
<wx/choicdlg.h>
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
+
\membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
-\func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message}, \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
-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>
+\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},\\
wxYES\_NO or wxOK.}
\twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
\twocolitem{wxCENTRE}{Centres the text.}
-\twocolitem{wxICON\_EXCLAMATION}{Under Windows, displays an exclamation mark symbol.}
-\twocolitem{wxICON\_HAND}{Under Windows, displays a hand symbol.}
-\twocolitem{wxICON\_QUESTION}{Under Windows, displays a question mark symbol.}
-\twocolitem{wxICON\_INFORMATION}{Under Windows, displays an information symbol.}
+\twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
+\twocolitem{wxICON\_HAND}{Displays 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}
The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
...
\end{verbatim}
-{\it message} may contain newline characters, in which case the
-message will be split into separate lines, to cater for large messages.
+{\it message} may contain newline characters, in which case the
+message will be split into separate lines, to cater for large messages.
+
+Under Windows, the native MessageBox function is used unless wxCENTRE
+is specified in the style, in which case a generic function is used.
+This is because the native MessageBox function cannot centre text.
+The symbols are not shown when the generic function is used.
+
+\wxheading{Include files}
+
+<wx/msgdlg.h>
+
+\membersection{::wxShowTip}\label{wxshowtip}
+
+\func{bool}{wxShowTip}{\param{wxWindow *}{parent},
+ \param{wxTipProvider *}{tipProvider},
+ \param{bool }{showAtStartup = TRUE}}
+
+This function shows a "startup tip" to the user.
+
+\docparam{parent}{The parent window for the modal dialog}
+
+\docparam{tipProvider}{An object which is used to get the text of the tips.
+It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
+
+\docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE
+otherwise. This is used as the initial value for "Show tips at startup"
+checkbox which is shown in the tips dialog.}
+
+\wxheading{See also}
+
+\helpref{Tips overview}{tipsoverview}
+
+\wxheading{Include files}
+
+<wx/tipdlg.h>
+
+\section{GDI functions}\label{gdifunctions}
+
+The following are relevant to the GDI (Graphics Device Interface).
+
+\wxheading{Include files}
+
+<wx/gdicmn.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{::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.
-Under Windows, the native MessageBox function is used unless wxCENTRE
-is specified in the style, in which case a generic function is used.
-This is because the native MessageBox function cannot centre text.
-The symbols are not shown when the generic function is used.
+\membersection{::wxDisplayDepth}\label{wxdisplaydepth}
-\wxheading{Include files}
+\func{int}{wxDisplayDepth}{\void}
-<wx/msgdlg.h>
+Returns the depth of the display (a value of 1 denotes a monochrome display).
-\membersection{::wxShowTip}\label{wxshowtip}
+\membersection{::wxDisplaySize}\label{wxdisplaysize}
-\func{bool}{wxShowTip}{\param{wxWindow *}{parent},
- \param{wxTipProvider *}{tipProvider},
- \param{bool }{showAtStartup = TRUE}}
+\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
-This function shows a "startup tip" to the user.
+\func{wxSize}{wxGetDisplaySize}{\void}
-\docparam{parent}{The parent window for the modal dialog}
+Returns the display size in pixels.
-\docparam{tipProvider}{An object which is used to get the text of the tips.
-It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
+\membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}
-\docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE
-otherwise. This is used as the initial value for "Show tips at startup"
-checkbox which is shown in the tips dialog.}
+\func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
-\wxheading{See also:}
+\func{wxSize}{wxGetDisplaySizeMM}{\void}
-\helpref{Tips overview}{tipsoverview}
+Returns the display size in millimeters.
-\wxheading{Include files}
+\membersection{::wxDROP\_ICON}\label{wxdropicon}
-<wx/tipdlg.h>
+\func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
-\section{GDI functions}\label{gdifunctions}
+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.
-The following are relevant to the GDI (Graphics Device Interface).
+This macro should be used with
+\helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
\wxheading{Include files}
-<wx/gdicmn.h>
+<wx/dnd.h>
-\membersection{::wxColourDisplay}
+\membersection{wxICON}\label{wxiconmacro}
-\func{bool}{wxColourDisplay}{\void}
+\func{}{wxICON}{iconName}
-Returns TRUE if the display is colour, FALSE otherwise.
+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.
-\membersection{::wxDisplayDepth}
+\wxheading{See also}
-\func{int}{wxDisplayDepth}{\void}
+\helpref{Bitmaps and icons overview}{wxbitmapoverview},
+\helpref{wxBITMAP}{wxbitmapmacro}
-Returns the depth of the display (a value of 1 denotes a monochrome display).
+\wxheading{Include files}
+
+<wx/gdicmn.h>
\membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
\section{Printer settings}\label{printersettings}
-These routines are obsolete and should no longer be used!
+{\bf NB:} These routines are obsolete and should no longer be used!
The following functions are used to control PostScript printing. Under
Windows, PostScript output can only be sent to a file.
<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}.
-\membersection{::wxGetPrinterFile}
+\membersection{::wxGetPrinterFile}\label{wxgetprinterfile}
\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.
-\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.
-\membersection{::wxGetPrinterOrientation}
+\membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation}
\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.
-\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.
-\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.
-\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}.
-\membersection{::wxSetPrinterFile}
+\membersection{::wxSetPrinterFile}\label{wxsetprinterfile}
\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.
-\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.
-\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.
-\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.
-\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.
-\membersection{::wxSetPrinterTranslation}
+\membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation}
\func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
\section{Clipboard functions}\label{clipsboard}
-These clipboard functions are implemented for Windows only.
+These clipboard functions are implemented for Windows only. The use of these functions
+is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
+class instead.
\wxheading{Include files}
<wx/clipbrd.h>
-\membersection{::wxClipboardOpen}
+\membersection{::wxClipboardOpen}\label{functionwxclipboardopen}
\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.
-\membersection{::wxEmptyClipboard}
+\membersection{::wxEmptyClipboard}\label{wxemptyclipboard}
\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
-the list.
+the list.
{\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
-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}}
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.
-\membersection{::wxIsClipboardFormatAvailable}
+\membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
\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.
-\membersection{::wxRegisterClipboardFormat}
+\membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat}
\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}}
\section{Miscellaneous functions}\label{miscellany}
-\membersection{::wxNewId}
+\membersection{wxEXPLICIT}\label{wxexplicit}
+
+{\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if
+the compiler supports it or nothing otherwise. Thus, it can be used even in the
+code which might have to be compiled with an old compiler without support for
+this language feature but still take advantage of it when it is available.
+
+\membersection{::wxNewId}\label{wxnewid}
\func{long}{wxNewId}{\void}
<wx/utils.h>
-\membersection{::wxRegisterId}
+\membersection{::wxRegisterId}\label{wxregisterid}
\func{void}{wxRegisterId}{\param{long}{ id}}
<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}
Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
called by the application.
-See also helpref{wxDDEInitialize}{wxddeinitialize}.
+See also \helpref{wxDDEInitialize}{wxddeinitialize}.
\wxheading{Include files}
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>
-\membersection{::wxDebugMsg}\label{wxdebugmsg}
-
-\func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
-
-{\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogoverview} 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}
-
-\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
-
-Gets the physical size of the display in pixels.
-
-\wxheading{Include files}
-
-<wx/gdicmn.h>
-
\membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
<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}
+\membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}
-Changes the cursor back to the original cursor, for all windows in the application.
-Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
+\func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
-See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
+Find a menu item identifier associated with the given frame's menu bar.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxError}\label{wxerror}
+\membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
-\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
+\func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
-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}.
+{\bf NB:} This function is obsolete, please use
+\helpref{wxWindow::FindWindowByLabel}{wxwindowfindwindowbylabel} instead.
+
+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{::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}}
-
-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.
-
-If {\it sync} is FALSE (the default), flow of control immediately returns.
-If TRUE, the current application waits until the other program has terminated.
+\membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
-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 simples case by
-calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
+\func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
-For asynchronous execution, however, the return value is the process id and
-zero value indicates that the command could not be executed.
+{\bf NB:} This function is obsolete, please use
+\helpref{wxWindow::FindWindowByName}{wxwindowfindwindowbyname} instead.
-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.
+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.
-See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}.
+If no such named window is found, {\bf wxFindWindowByLabel} is called.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxExit}\label{wxexit}
+\membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
-\func{void}{wxExit}{\void}
+\func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
-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}.
+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/app.h>
+\func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
-\membersection{::wxFatalError}\label{wxfatalerror}
+Find the deepest window at the mouse pointer position, returning the window
+and current pointer position in screen coordinates.
-\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
+\membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
-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}.
+\func{wxWindow *}{wxGetActiveWindow}{\void}
+
+Gets the currently active window (Windows only).
\wxheading{Include files}
-<wx/utils.h>
+<wx/windows.h>
-\membersection{::wxFindMenuItemId}
+\membersection{::wxGetDisplayName}\label{wxgetdisplayname}
-\func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
+\func{wxString}{wxGetDisplayName}{\void}
-Find a menu item identifier associated with the given frame's menu bar.
+Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxFindWindowByLabel}
+\membersection{::wxGetMousePosition}\label{wxgetmouseposition}
-\func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
+\func{wxPoint}{wxGetMousePosition}{\void}
-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.
+Returns the mouse position in screen coordinates.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
+\membersection{::wxGetResource}\label{wxgetresource}
-\func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
+\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
+ \param{const wxString\& *}{value}, \param{const wxString\& }{file = 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.
+\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
+ \param{float *}{value}, \param{const wxString\& }{file = NULL}}
-If no such named window is found, {\bf wxFindWindowByLabel} is called.
+\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
+ \param{long *}{value}, \param{const wxString\& }{file = NULL}}
-\wxheading{Include files}
+\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
+ \param{int *}{value}, \param{const wxString\& }{file = NULL}}
-<wx/utils.h>
+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.
-\membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
+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.
-\func{wxWindow *}{wxGetActiveWindow}{\void}
+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.
-Gets the currently active window (Windows only).
+See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
\wxheading{Include files}
-<wx/windows.h>
+<wx/utils.h>
-\membersection{::wxGetDisplayName}\label{wxgetdisplayname}
+\membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
-\func{wxString}{wxGetDisplayName}{\void}
+\func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}
-Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
+Returns the first top level parent of the given window, or in other words, the
+frame or dialog containing it, or {\tt NULL}.
\wxheading{Include files}
-<wx/utils.h>
+<wx/window.h>
-\membersection{::wxGetHomeDir}
+\membersection{::wxLoadUserResource}\label{wxloaduserresource}
-\func{wxString}{wxGetHomeDir}{\param{const wxString\& }{buf}}
+\func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
-Fills the buffer with a string representing the user's home directory (Unix only).
+Loads a user-defined Windows resource as a string. If the resource is found, the function creates
+a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
-\wxheading{Include files}
+The resource must be defined in the {\tt .rc} file using the following syntax:
-<wx/utils.h>
+\begin{verbatim}
+myResource TEXT file.ext
+\end{verbatim}
-\membersection{::wxGetHostName}
+where {\tt file.ext} is a file that the resource compiler can find.
-\func{bool}{wxGetHostName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
+One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
+cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
+using \helpref{wxResourceParseString}{wxresourceparsestring}.
-Copies the host name of the machine the program is running on into the
-buffer {\it buf}, of maximum size {\it bufSize}, returning TRUE if
-successful. Under Unix, this will return a machine name. Under Windows,
-this returns ``windows''.
+This function is available under Windows only.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
-
-\func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
+\membersection{::wxPostDelete}\label{wxpostdelete}
-Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
+\func{void}{wxPostDelete}{\param{wxObject *}{object}}
-If {\it resetTimer} is TRUE (the default), the timer is reset to zero
-by this call.
+Tells the system to delete the specified object when
+all other events have been processed. In some environments, it is
+necessary to use this instead of deleting a frame directly with the
+delete operator, because some GUIs will still send events to a deleted window.
-See also \helpref{wxTimer}{wxtimer}.
+Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
\wxheading{Include files}
-<wx/timer.h>
+<wx/utils.h>
-\membersection{::wxGetFreeMemory}\label{wxgetfreememory}
+\membersection{::wxPostEvent}\label{wxpostevent}
-\func{long}{wxGetFreeMemory}{\void}
+\func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
-Returns the amount of free memory in Kbytes under environments which
-support it, and -1 if not supported. Currently, returns a positive value
-under Windows, and -1 under Unix.
+In a GUI application, this function posts {\it event} to the specified {\it dest}
+object using \helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
+Otherwise, it dispatches {\it event} immediately using
+\helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent}.
+See the respective documentation for details (and caveats).
\wxheading{Include files}
-<wx/utils.h>
+<wx/app.h>
-\membersection{::wxGetMousePosition}
+\membersection{::wxSetDisplayName}\label{wxsetdisplayname}
-\func{void}{wxGetMousePosition}{\param{int* }{x}, \param{int* }{y}}
+\func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
-Returns the mouse position in screen coordinates.
+Under X only, sets the current display name. This is the X host and display name such
+as ``colonsay:0.0", and the function indicates which display should be used for creating
+windows from this point on. Setting the display within an application allows multiple
+displays to be used.
+
+See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxGetOsVersion}
+\membersection{::wxStripMenuCodes}\label{wxstripmenucodes}
-\func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
+\func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
-Gets operating system version information.
+\func{void}{wxStripMenuCodes}{\param{char *}{in}, \param{char *}{out}}
-\begin{twocollist}\itemsep=0pt
-\twocolitemruled{Platform}{Return tyes}
-\twocolitem{Macintosh}{Return value is wxMACINTOSH.}
-\twocolitem{GTK}{Return value is wxGTK, {\it major} is 1, {\it minor} is 0. (for GTK 1.0.X) }
-\twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
-\twocolitem{OS/2}{Return value is wxOS2\_PM.}
-\twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
-\twocolitem{Windows NT}{Return value is wxWINDOWS\_NT, {\it major} is 3, {\it minor} is 1.}
-\twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 3, {\it minor} is 1.}
-\twocolitem{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}
+{\bf NB:} 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).
+
+Menu codes include \& (mark the next character with an underline
+as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxGetResource}\label{wxgetresource}
+\membersection{::wxWriteResource}\label{wxwriteresource}
-\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
+\func{bool}{wxWriteResource}{\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}{wxWriteResource}{\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}{wxWriteResource}{\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}}
+\func{bool}{wxWriteResource}{\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
+Writes a resource value into 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.
+Under X, the resource databases are cached until the internal function
+\rtfsp{\bf wxFlushResources} is called automatically on exit, when
+all updated resource databases are written to their files.
-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.
+Note that it is considered bad manners to write to the .Xdefaults
+file under Unix, although the WIN.INI file is fair game under Windows.
-See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
+See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxGetUserId}
+\section{Byte order macros}\label{byteordermacros}
-\func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
+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.
-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''.
+\membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
-\wxheading{Include files}
+\func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
-<wx/utils.h>
+\func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
-\membersection{::wxGetUserName}
+\func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
-\func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
+\func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
-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''.
+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.
-\wxheading{Include files}
+\membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
-<wx/utils.h>
+\func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
-\membersection{::wxKill}\label{wxkill}
+\func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
-\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}}
+\func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
-Under Unix (the only supported platform), equivalent to the Unix kill function.
-Returns 0 on success, -1 on failure.
+\func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
-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.
+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
+been compiled on a little-endian architecture, the value will be unchanged.
-\wxheading{Include files}
+Use these macros to read data from and write data to a file that stores
+data in little-endian (for example Intel i386) format.
-<wx/utils.h>
+\membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
-\membersection{::wxIsBusy}\label{wxisbusy}
+\func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
-\func{bool}{wxIsBusy}{\void}
+\func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
-Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
-\helpref{wxEndBusyCursor}{wxendbusycursor} calls.
+\func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
-See also \helpref{wxBusyCursor}{wxbusycursor}.
+\func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
-\wxheading{Include files}
+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
+been compiled on a big-endian architecture, the value will be unchanged.
-<wx/utils.h>
+Use these macros to read data from and write data to a file that stores
+data in big-endian format.
-\membersection{::wxLoadUserResource}\label{wxloaduserresource}
+\section{RTTI functions}\label{rttimacros}
-\func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
+wxWindows uses its own RTTI ("run-time type identification") system which
+predates the current standard C++ RTTI and so is kept for backwards
+compatibility reasons but also because it allows some things which the
+standard RTTI doesn't directly support (such as creating a class from its
+name).
-Loads a user-defined Windows resource as a string. If the resource is found, the function creates
-a new character array and copies the data into it. A pointer to this data is returned. If unsuccessful, NULL is returned.
+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.
-The resource must be defined in the {\tt .rc} file using the following syntax:
+\wxheading{See also}
-\begin{verbatim}
-myResource TEXT file.ext
-\end{verbatim}
+\helpref{RTTI overview}{runtimeclassoverview}
-where {\tt file.ext} is a file that the resource compiler can find.
+\membersection{CLASSINFO}\label{classinfo}
-One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
-cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
-using \helpref{wxResourceParseString}{wxresourceparsestring}.
+\func{wxClassInfo *}{CLASSINFO}{className}
-This function is available under Windows only.
+Returns a pointer to the wxClassInfo object associated with this class.
\wxheading{Include files}
-<wx/utils.h>
-
-\membersection{::wxNow}\label{wxnow}
-
-\func{wxString}{wxNow}{\void}
-
-Returns a string representing the current date and time.
+<wx/object.h>
-\wxheading{Include files}
+\membersection{DECLARE\_ABSTRACT\_CLASS}\label{declareabstractclass}
-<wx/utils.h>
+\func{}{DECLARE\_ABSTRACT\_CLASS}{className}
-\membersection{::wxPostDelete}\label{wxpostdelete}
+Used inside a class declaration to declare that the class should be
+made known to the class hierarchy, but objects of this class cannot be created
+dynamically. The same as DECLARE\_CLASS.
-\func{void}{wxPostDelete}{\param{wxObject *}{object}}
+Example:
-Tells the system to delete the specified object when
-all other events have been processed. In some environments, it is
-necessary to use this instead of deleting a frame directly with the
-delete operator, because some GUIs will still send events to a deleted window.
+\begin{verbatim}
+class wxCommand: public wxObject
+{
+ DECLARE_ABSTRACT_CLASS(wxCommand)
-Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
+ private:
+ ...
+ public:
+ ...
+};
+\end{verbatim}
\wxheading{Include files}
-<wx/utils.h>
+<wx/object.h>
-\membersection{::wxPostEvent}\label{wxpostevent}
+\membersection{DECLARE\_APP}\label{declareapp}
-\func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
+\func{}{DECLARE\_APP}{className}
+
+This is used in headers to create a forward declaration of the wxGetApp function implemented
+by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
-This function posts the event to the specified {\it dest} object. The
-difference between sending an event and posting it is that in the first case
-the event is processed before the function returns (in wxWindows, event sending
-is done with \helpref{ProcessEvent}{wxevthandlerprocessevent} function), but in
-the second, the function returns immediately and the event will be processed
-sometime later - usually during the next even loop iteration.
+Example:
-Note that a copy of the {\it event} is made by the function, so the original
-copy can be deleted as soon as function returns. This function can also be used
-to send events between different threads safely.
+\begin{verbatim}
+ DECLARE_APP(MyApp)
+\end{verbatim}
\wxheading{Include files}
<wx/app.h>
-\membersection{::wxSafeYield}\label{wxsafeyield}
-
-\func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
+\membersection{DECLARE\_CLASS}\label{declareclass}
-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.
+\func{}{DECLARE\_CLASS}{className}
-Returns the result of the call to \helpref{::wxYield}{wxyield}.
+Used inside a class declaration to declare that the class should be
+made known to the class hierarchy, but objects of this class cannot be created
+dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
\wxheading{Include files}
-<wx/utils.h>
+<wx/object.h>
-\membersection{::wxSetDisplayName}\label{wxsetdisplayname}
+\membersection{DECLARE\_DYNAMIC\_CLASS}\label{declaredynamicclass}
-\func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
+\func{}{DECLARE\_DYNAMIC\_CLASS}{className}
-Under X only, sets the current display name. This is the X host and display name such
-as ``colonsay:0.0", and the function indicates which display should be used for creating
-windows from this point on. Setting the display within an application allows multiple
-displays to be used.
+Used inside a class declaration to declare that the objects of this class should be dynamically
+creatable from run-time type information.
-See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
+Example:
+
+\begin{verbatim}
+class wxFrame: public wxWindow
+{
+ DECLARE_DYNAMIC_CLASS(wxFrame)
+
+ private:
+ const wxString\& frameTitle;
+ public:
+ ...
+};
+\end{verbatim}
\wxheading{Include files}
-<wx/utils.h>
+<wx/object.h>
-\membersection{::wxShell}\label{wxshell}
+\membersection{IMPLEMENT\_ABSTRACT\_CLASS}\label{implementabstractclass}
-\func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
+\func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
-Executes a command in an interactive shell window. If no command is
-specified, then just the shell is spawned.
+Used in a C++ implementation file to complete the declaration of
+a class that has run-time type information. The same as IMPLEMENT\_CLASS.
+
+Example:
-See also \helpref{wxExecute}{wxexecute}.
+\begin{verbatim}
+IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
+
+wxCommand::wxCommand(void)
+{
+...
+}
+\end{verbatim}
\wxheading{Include files}
-<wx/utils.h>
+<wx/object.h>
-\membersection{::wxSleep}\label{wxsleep}
+\membersection{IMPLEMENT\_ABSTRACT\_CLASS2}\label{implementabstractclass2}
-\func{void}{wxSleep}{\param{int}{ secs}}
+\func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
-Sleeps for the specified number of seconds.
+Used in a C++ implementation file to complete the declaration of
+a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
\wxheading{Include files}
-<wx/utils.h>
-
-\membersection{::wxStripMenuCodes}
-
-\func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
-
-\func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
+<wx/object.h>
-Strips any menu codes from {\it in} and places the result
-in {\it out} (or returns the new string, in the first form).
+\membersection{IMPLEMENT\_APP}\label{implementapp}
-Menu codes include \& (mark the next character with an underline
-as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows).
+\func{}{IMPLEMENT\_APP}{className}
-\wxheading{Include files}
+This is used in the application class implementation file to make the application class known to
+wxWindows for dynamic construction. You use this instead of
-<wx/utils.h>
+Old form:
-\membersection{::wxStartTimer}\label{wxstarttimer}
+\begin{verbatim}
+ MyApp myApp;
+\end{verbatim}
-\func{void}{wxStartTimer}{\void}
+New form:
-Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
+\begin{verbatim}
+ IMPLEMENT_APP(MyApp)
+\end{verbatim}
-See also \helpref{wxTimer}{wxtimer}.
+See also \helpref{DECLARE\_APP}{declareapp}.
\wxheading{Include files}
-<wx/timer.h>
+<wx/app.h>
-\membersection{::wxToLower}\label{wxtolower}
+\membersection{IMPLEMENT\_CLASS}\label{implementclass}
-\func{char}{wxToLower}{\param{char }{ch}}
+\func{}{IMPLEMENT\_CLASS}{className, baseClassName}
-Converts the character to lower case. This is implemented as a macro for efficiency.
+Used in a C++ implementation file to complete the declaration of
+a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
\wxheading{Include files}
-<wx/utils.h>
+<wx/object.h>
-\membersection{::wxToUpper}\label{wxtoupper}
+\membersection{IMPLEMENT\_CLASS2}\label{implementclass2}
-\func{char}{wxToUpper}{\param{char }{ch}}
+\func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
-Converts the character to upper case. This is implemented as a macro for efficiency.
+Used in a C++ implementation file to complete the declaration of a
+class that has run-time type information and two base classes. The
+same as IMPLEMENT\_ABSTRACT\_CLASS2.
\wxheading{Include files}
-<wx/utils.h>
+<wx/object.h>
-\membersection{::wxTrace}\label{wxtrace}
+\membersection{IMPLEMENT\_DYNAMIC\_CLASS}\label{implementdynamicclass}
-\func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
+\func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
-Takes printf-style variable argument syntax. Output
-is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
+Used in a C++ implementation file to complete the declaration of
+a class that has run-time type information, and whose instances
+can be created dynamically.
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+Example:
-\wxheading{Include files}
+\begin{verbatim}
+IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
-<wx/memory.h>
+wxFrame::wxFrame(void)
+{
+...
+}
+\end{verbatim}
-\membersection{::wxTraceLevel}\label{wxtracelevel}
+\wxheading{Include files}
-\func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
+<wx/object.h>
-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.
+\membersection{IMPLEMENT\_DYNAMIC\_CLASS2}\label{implementdynamicclass2}
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+\func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
-\wxheading{Include files}
+Used in a C++ implementation file to complete the declaration of
+a class that has run-time type information, and whose instances
+can be created dynamically. Use this for classes derived from two
+base classes.
-<wx/memory.h>
+\wxheading{Include files}
-\membersection{::wxUsleep}\label{wxusleep}
+<wx/object.h>
-\func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
+\membersection{wxConstCast}\label{wxconstcast}
-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.
+\func{classname *}{wxConstCast}{ptr, classname}
-\wxheading{Include files}
+This macro expands into {\tt const\_cast<classname *>(ptr)} if the compiler
+supports {\it const\_cast} or into an old, C-style cast, otherwise.
-<wx/utils.h>
+\wxheading{See also}
-\membersection{::wxWriteResource}\label{wxwriteresource}
+\helpref{wxDynamicCast}{wxdynamiccast}\\
+\helpref{wxStaticCast}{wxstaticcast}
-\func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{const wxString\& }{value}, \param{const wxString\& }{file = NULL}}
+\membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
-\func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{float }{value}, \param{const wxString\& }{file = NULL}}
+\func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
-\func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{long }{value}, \param{const wxString\& }{file = NULL}}
+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.
-\func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{int }{value}, \param{const wxString\& }{file = NULL}}
+\membersection{WXDEBUG\_NEW}\label{debugnew}
-Writes a resource value into 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{}{WXDEBUG\_NEW}{arg}
-Under X, the resource databases are cached until the internal function
-\rtfsp{\bf wxFlushResources} is called automatically on exit, when
-all updated resource databases are written to their files.
+This is defined in debug mode to be call the redefined new operator
+with filename and line number arguments. The definition is:
-Note that it is considered bad manners to write to the .Xdefaults
-file under Unix, although the WIN.INI file is fair game under Windows.
+\begin{verbatim}
+#define WXDEBUG_NEW new(__FILE__,__LINE__)
+\end{verbatim}
-See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfigbase}.
+In non-debug mode, this is defined as the normal new operator.
\wxheading{Include files}
-<wx/utils.h>
+<wx/object.h>
-\membersection{::wxYield}\label{wxyield}
+\membersection{wxDynamicCast}\label{wxdynamiccast}
-\func{bool}{wxYield}{\void}
+\func{classname *}{wxDynamicCast}{ptr, classname}
-Yields control to pending messages in the windowing system. This can be useful, for example, when a
-time-consuming process writes to a text window. Without an occasional
-yield, the text window will not be updated properly, and (since Windows
-multitasking is cooperative) other processes will not respond.
+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
+{\tt NULL} otherwise. Usage of this macro is preferred over obsoleted
+wxObject::IsKindOf() function.
-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.
+The {\it ptr} argument may be {\tt NULL}, in which case {\tt NULL} will be
+returned.
-\wxheading{Include files}
+Example:
-<wx/app.h> or <wx/utils.h>
+\begin{verbatim}
+ wxWindow *win = wxWindow::FindFocus();
+ wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
+ if ( text )
+ {
+ // a text control has the focus...
+ }
+ else
+ {
+ // no window has the focus or it is not a text control
+ }
+\end{verbatim}
-\section{Macros}\label{macros}
+\wxheading{See also}
-These macros are defined in wxWindows.
+\helpref{RTTI overview}{runtimeclassoverview}\\
+\helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
+\helpref{wxConstCast}{wxconstcast}\\
+\helpref{wxStatiicCast}{wxstaticcast}
-\membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
+\membersection{wxDynamicCastThis}\label{wxdynamiccastthis}
-\func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}}
+\func{classname *}{wxDynamicCastThis}{classname}
-\func{wxUint32}{wxUINT32\_SWAP\_ALWAYS}{\param{wxUint32 }{value}}
+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.
-\func{wxInt16}{wxINT16\_SWAP\_ALWAYS}{\param{wxInt16 }{value}}
+\wxheading{See also}
-\func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
+\helpref{wxDynamicCast}{wxdynamiccast}
-This macro will swap the bytes of the {\it value} variable from little
-endian to big endian or vice versa.
+\membersection{wxStaticCast}\label{wxstaticcast}
-\membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
+\func{classname *}{wxStaticCast}{ptr, classname}
-\func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}}
+This macro checks that the cast is valid in debug mode (an assert failure will
+result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the
+result of executing an equivalent of {\tt static\_cast<classname *>(ptr)}.
-\func{wxUint32}{wxUINT32\_SWAP\_ON\_BE}{\param{wxUint32 }{value}}
+\helpref{wxDynamicCast}{wxdynamiccast}\\
+\helpref{wxConstCast}{wxconstcast}
-\func{wxInt16}{wxINT16\_SWAP\_ON\_BE}{\param{wxInt16 }{value}}
+\section{Resource functions}\label{resourcefuncs}
-\func{wxUint16}{wxUINT16\_SWAP\_ON\_BE}{\param{wxUint16 }{value}}
+\overview{Resource functions}{resourceformats}
-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
-been compiled on a little-endian architecture, the value will be unchanged.
+This section details functions for manipulating wxWindows (.WXR) resource
+files and loading user interface elements from resources.
-Use these macros to read data from and write data to a file that stores
-data in little endian (Intel i386) format.
+\normalbox{Please note that this use of the word `resource' is different from that used when talking
+about initialisation file resource reading and writing, using such functions
+as wxWriteResource and wxGetResource. It is just an unfortunate clash of terminology.}
-\membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
+\helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
-\func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}}
+See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
+loading from resource data.
-\func{wxUint32}{wxUINT32\_SWAP\_ON\_LE}{\param{wxUint32 }{value}}
+\membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
-\func{wxInt16}{wxINT16\_SWAP\_ON\_LE}{\param{wxInt16 }{value}}
+\func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
-\func{wxUint16}{wxUINT16\_SWAP\_ON\_LE}{\param{wxUint16 }{value}}
+Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
+{\tt\#}defining a name to an integer). Unlikely to be used by an application except
+perhaps for implementing resource functionality for interpreted languages.
-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
-been compiled on a big-endian architecture, the value will be unchanged.
+\membersection{::wxResourceClear}\label{wxresourceclear}
-Use these macros to read data from and write data to a file that stores
-data in big endian format.
+\func{void}{wxResourceClear}{\void}
-\membersection{CLASSINFO}\label{classinfo}
+Clears the wxWindows resource table.
-\func{wxClassInfo *}{CLASSINFO}{className}
+\membersection{::wxResourceCreateBitmap}\label{wxresourcecreatebitmap}
-Returns a pointer to the wxClassInfo object associated with this class.
+\func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
-\wxheading{Include files}
+Creates a new bitmap from a file, static data, or Windows resource, given a valid
+wxWindows bitmap resource identifier. For example, if the .WXR file contains
+the following:
-<wx/object.h>
+\begin{verbatim}
+static const wxString\& project_resource = "bitmap(name = 'project_resource',\
+ bitmap = ['project', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
+ bitmap = ['project.xpm', wxBITMAP_TYPE_XPM, 'X']).";
+\end{verbatim}
-\membersection{DECLARE\_ABSTRACT\_CLASS}
+then this function can be called as follows:
-\func{}{DECLARE\_ABSTRACT\_CLASS}{className}
+\begin{verbatim}
+ wxBitmap *bitmap = wxResourceCreateBitmap("project_resource");
+\end{verbatim}
-Used inside a class declaration to declare that the class should be
-made known to the class hierarchy, but objects of this class cannot be created
-dynamically. The same as DECLARE\_CLASS.
+\membersection{::wxResourceCreateIcon}\label{wxresourcecreateicon}
-Example:
+\func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
-\begin{verbatim}
-class wxCommand: public wxObject
-{
- DECLARE_ABSTRACT_CLASS(wxCommand)
+Creates a new icon from a file, static data, or Windows resource, given a valid
+wxWindows icon resource identifier. For example, if the .WXR file contains
+the following:
- private:
- ...
- public:
- ...
-};
+\begin{verbatim}
+static const wxString\& project_resource = "icon(name = 'project_resource',\
+ icon = ['project', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
+ icon = ['project', wxBITMAP_TYPE_XBM_DATA, 'X']).";
\end{verbatim}
-\wxheading{Include files}
-
-<wx/object.h>
+then this function can be called as follows:
-\membersection{DECLARE\_APP}\label{declareapp}
+\begin{verbatim}
+ wxIcon *icon = wxResourceCreateIcon("project_resource");
+\end{verbatim}
-\func{}{DECLARE\_APP}{className}
+\membersection{::wxResourceCreateMenuBar}\label{wxresourcecreatemenubar}
-This is used in headers to create a forward declaration of the wxGetApp function implemented
-by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
+\func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
-Example:
+Creates a new menu bar given a valid wxWindows menubar resource
+identifier. For example, if the .WXR file contains the following:
\begin{verbatim}
- DECLARE_APP(MyApp)
+static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
+ menu = \
+ [\
+ ['&File', 1, '', \
+ ['&Open File', 2, 'Open a file'],\
+ ['&Save File', 3, 'Save a file'],\
+ [],\
+ ['E&xit', 4, 'Exit program']\
+ ],\
+ ['&Help', 5, '', \
+ ['&About', 6, 'About this program']\
+ ]\
+ ]).";
\end{verbatim}
-\wxheading{Include files}
+then this function can be called as follows:
-<wx/app.h>
+\begin{verbatim}
+ wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
+\end{verbatim}
-\membersection{DECLARE\_CLASS}
-\func{}{DECLARE\_CLASS}{className}
+\membersection{::wxResourceGetIdentifier}\label{wxresourcegetidentifier}
-Used inside a class declaration to declare that the class should be
-made known to the class hierarchy, but objects of this class cannot be created
-dynamically. The same as DECLARE\_ABSTRACT\_CLASS.
+\func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
-\wxheading{Include files}
+Used for retrieving the integer value associated with an identifier.
+A zero value indicates that the identifier was not found.
-<wx/object.h>
+See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
-\membersection{DECLARE\_DYNAMIC\_CLASS}
+\membersection{::wxResourceParseData}\label{wxresourcedata}
-\func{}{DECLARE\_DYNAMIC\_CLASS}{className}
+\func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
-Used inside a class declaration to declare that the objects of this class should be dynamically
-createable from run-time type information.
+Parses a string containing one or more wxWindows resource objects. If
+the resource objects are global static data that are included into the
+C++ program, then this function must be called for each variable
+containing the resource data, to make it known to wxWindows.
-Example:
+{\it resource} should contain data in the following form:
\begin{verbatim}
-class wxFrame: public wxWindow
-{
- DECLARE_DYNAMIC_CLASS(wxFrame)
+dialog(name = 'dialog1',
+ style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
+ title = 'Test dialog box',
+ x = 312, y = 234, width = 400, height = 300,
+ modal = 0,
+ control = [1000, wxStaticBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
+ [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
+ control = [1001, wxTextCtrl, '', 'wxTE_MULTILINE', 'text3',
+ 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
+ [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
+ [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
+\end{verbatim}
- private:
- const wxString\& frameTitle;
- public:
- ...
-};
+This function will typically be used after including a {\tt .wxr} file into
+a C++ program as follows:
+
+\begin{verbatim}
+#include "dialog1.wxr"
\end{verbatim}
-\wxheading{Include files}
+Each of the contained resources will declare a new C++ variable, and each
+of these variables should be passed to wxResourceParseData.
-<wx/object.h>
+\membersection{::wxResourceParseFile}\label{wxresourceparsefile}
-\membersection{IMPLEMENT\_ABSTRACT\_CLASS}
+\func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
-\func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
+Parses a file containing one or more wxWindows resource objects
+in C++-compatible syntax. Use this function to dynamically load
+wxWindows resource data.
-Used in a C++ implementation file to complete the declaration of
-a class that has run-time type information. The same as IMPLEMENT\_CLASS.
+\membersection{::wxResourceParseString}\label{wxresourceparsestring}
-Example:
+\func{bool}{wxResourceParseString}{\param{char *}{s}, \param{wxResourceTable *}{table = NULL}}
-\begin{verbatim}
-IMPLEMENT_ABSTRACT_CLASS(wxCommand, wxObject)
+Parses a string containing one or more wxWindows resource objects. If
+the resource objects are global static data that are included into the
+C++ program, then this function must be called for each variable
+containing the resource data, to make it known to wxWindows.
-wxCommand::wxCommand(void)
-{
-...
-}
+{\it resource} should contain data with the following form:
+
+\begin{verbatim}
+dialog(name = 'dialog1',
+ style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
+ title = 'Test dialog box',
+ x = 312, y = 234, width = 400, height = 300,
+ modal = 0,
+ control = [1000, wxStaticBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
+ [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
+ control = [1001, wxTextCtrl, '', 'wxTE_MULTILINE', 'text3',
+ 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
+ [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
+ [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
\end{verbatim}
-\wxheading{Include files}
+This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
+load an entire {\tt .wxr file} into a string.
-<wx/object.h>
+\membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
-\membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
+\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char *}{xbm\_data}, \param{int }{width},
+\param{int }{height}, \param{wxResourceTable *}{table = NULL}}
-\func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
+\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char **}{xpm\_data}}
-Used in a C++ implementation file to complete the declaration of
-a class that has run-time type information and two base classes. The same as IMPLEMENT\_CLASS2.
+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.
-\wxheading{Include files}
+\membersection{::wxResourceRegisterIconData}\label{wxresourceregistericondata}
-<wx/object.h>
+Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
-\membersection{IMPLEMENT\_APP}\label{implementapp}
+\section{Log functions}\label{logfunctions}
-\func{}{IMPLEMENT\_APP}{className}
+These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
+further information. The functions use (implicitly) the currently active log
+target, so their descriptions here may not apply if the log target is not the
+standard one (installed by wxWindows in the beginning of the program).
-This is used in the application class implementation file to make the application class known to
-wxWindows for dynamic construction. You use this instead of
+\wxheading{Include files}
-Old form:
+<wx/log.h>
-\begin{verbatim}
- MyApp myApp;
-\end{verbatim}
+\membersection{::wxDebugMsg}\label{wxdebugmsg}
-New form:
+\func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
-\begin{verbatim}
- IMPLEMENT_APP(MyApp)
-\end{verbatim}
+{\bf NB:} This function is now obsolete, replaced by \helpref{Log
+functions}{logfunctions} and \helpref{wxLogDebug}{wxlogdebug} in particular.
-See also \helpref{DECLARE\_APP}{declareapp}.
+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.
\wxheading{Include files}
-<wx/app.h>
+<wx/utils.h>
-\membersection{IMPLEMENT\_CLASS}
+\membersection{::wxError}\label{wxerror}
-\func{}{IMPLEMENT\_CLASS}{className, baseClassName}
+\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
-Used in a C++ implementation file to complete the declaration of
-a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLASS.
+{\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
+instead.
+
+Displays {\it msg} and continues. This writes to standard error under
+Unix, and pops up a message box under Windows. Used for internal
+wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
\wxheading{Include files}
-<wx/object.h>
+<wx/utils.h>
-\membersection{IMPLEMENT\_CLASS2}
+\membersection{::wxFatalError}\label{wxfatalerror}
-\func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
+\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
-Used in a C++ implementation file to complete the declaration of a
-class that has run-time type information and two base classes. The
-same as IMPLEMENT\_ABSTRACT\_CLASS2.
+{\bf NB:} This function is now obsolete, please use
+\helpref{wxLogFatalError}{wxlogfatalerror} instead.
+
+Displays {\it msg} and exits. This writes to standard error under Unix,
+and pops up a message box under Windows. Used for fatal internal
+wxWindows errors. See also \helpref{wxError}{wxerror}.
\wxheading{Include files}
-<wx/object.h>
+<wx/utils.h>
-\membersection{IMPLEMENT\_DYNAMIC\_CLASS}
+\membersection{::wxLogError}\label{wxlogerror}
-\func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
+\func{void}{wxLogError}{\param{const char *}{formatString}, \param{...}{}}
-Used in a C++ implementation file to complete the declaration of
-a class that has run-time type information, and whose instances
-can be created dynamically.
+\func{void}{wxVLogError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
-Example:
+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.
-\begin{verbatim}
-IMPLEMENT_DYNAMIC_CLASS(wxFrame, wxWindow)
+\membersection{::wxLogFatalError}\label{wxlogfatalerror}
-wxFrame::wxFrame(void)
-{
-...
-}
-\end{verbatim}
+\func{void}{wxLogFatalError}{\param{const char *}{formatString}, \param{...}{}}
-\wxheading{Include files}
+\func{void}{wxVLogFatalError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
-<wx/object.h>
+Like \helpref{wxLogError}{wxlogerror}, but also
+terminates the program with the exit code 3. Using {\it abort()} standard
+function also terminates the program with this exit code.
-\membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
+\membersection{::wxLogWarning}\label{wxlogwarning}
-\func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
+\func{void}{wxLogWarning}{\param{const char *}{formatString}, \param{...}{}}
-Used in a C++ implementation file to complete the declaration of
-a class that has run-time type information, and whose instances
-can be created dynamically. Use this for classes derived from two
-base classes.
+\func{void}{wxVLogWarning}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
-\wxheading{Include files}
+For warnings - they are also normally shown to the user, but don't interrupt
+the program work.
-<wx/object.h>
+\membersection{::wxLogMessage}\label{wxlogmessage}
-\membersection{wxBITMAP}\label{wxbitmapmacro}
+\func{void}{wxLogMessage}{\param{const char *}{formatString}, \param{...}{}}
-\func{}{wxBITMAP}{bitmapName}
+\func{void}{wxVLogMessage}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
-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.
+For all normal, informational messages. They also appear in a message box by
+default (but it can be changed). Notice that the standard behaviour is to not
+show informational messages if there are any errors later - the logic being
+that the later error messages make the informational messages preceding them
+meaningless.
-\wxheading{See also}
+\membersection{::wxLogVerbose}\label{wxlogverbose}
-\helpref{Bitmaps and icons overview}{wxbitmapoverview},
-\helpref{wxICON}{wxiconmacro}
+\func{void}{wxLogVerbose}{\param{const char *}{formatString}, \param{...}{}}
-\wxheading{Include files}
+\func{void}{wxVLogVerbose}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
-<wx/gdicmn.h>
+For verbose output. Normally, it is suppressed, but
+might be activated if the user wishes to know more details about the program
+progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
-\membersection{WXDEBUG\_NEW}\label{debugnew}
+\membersection{::wxLogStatus}\label{wxlogstatus}
-\func{}{WXDEBUG\_NEW}{arg}
+\func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{...}{}}
-This is defined in debug mode to be call the redefined new operator
-with filename and line number arguments. The definition is:
+\func{void}{wxVLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
-\begin{verbatim}
-#define WXDEBUG_NEW new(__FILE__,__LINE__)
-\end{verbatim}
+\func{void}{wxLogStatus}{\param{const char *}{formatString}, \param{...}{}}
-In non-debug mode, this is defined as the normal new operator.
+\func{void}{wxVLogStatus}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
-\wxheading{Include files}
+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
+the second version of the functions).
-<wx/object.h>
+If the target frame doesn't have a statusbar, the message will be lost.
-\membersection{wxDynamicCast}\label{wxdynamiccast}
+\membersection{::wxLogSysError}\label{wxlogsyserror}
-\func{}{wxDynamicCast}{ptr, classname}
+\func{void}{wxLogSysError}{\param{const char *}{formatString}, \param{...}{}}
-This macro returns the pointer {\it ptr} cast to the type {\it classname *} if
-the pointer is of this type (the check is done during the run-time) or NULL
-otherwise. Usage of this macro is prefered over obsoleted wxObject::IsKindOf()
-function.
+\func{void}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
-The {\it ptr} argument may be NULL, in which case NULL will be returned.
+Mostly used by wxWindows itself, but might be handy for logging errors after
+system call (API function) failure. It logs the specified message text as well
+as the last system error code ({\it errno} or {\it ::GetLastError()} depending
+on the platform) and the corresponding error message. The second form
+of this function takes the error code explicitly as the first argument.
-Example:
+\wxheading{See also}
-\begin{verbatim}
- wxWindow *win = wxWindow::FindFocus();
- wxTextCtrl *text = wxDynamicCast(win, wxTextCtrl);
- if ( text )
- {
- // a text control has the focus...
- }
- else
- {
- // no window has the focus or it's not a text control
- }
-\end{verbatim}
+\helpref{wxSysErrorCode}{wxsyserrorcode},
+\helpref{wxSysErrorMsg}{wxsyserrormsg}
-\wxheading{See also}
+\membersection{::wxLogDebug}\label{wxlogdebug}
-\helpref{RTTI overview}{runtimeclassoverview}
+\func{void}{wxLogDebug}{\param{const char *}{formatString}, \param{...}{}}
-\membersection{wxICON}\label{wxiconmacro}
+\func{void}{wxVLogDebug}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
-\func{}{wxICON}{iconName}
+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).
-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.
+\membersection{::wxLogTrace}\label{wxlogtrace}
-\wxheading{See also}
+\func{void}{wxLogTrace}{\param{const char *}{formatString}, \param{...}{}}
-\helpref{Bitmaps and icons overview}{wxbitmapoverview},
-\helpref{wxBITMAP}{wxbitmapmacro}
+\func{void}{wxVLogTrace}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
-\wxheading{Include files}
+\func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
-<wx/gdicmn.h>
+\func{void}{wxVLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
-\membersection{WXTRACE}\label{trace}
+\func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}
-\wxheading{Include files}
+\func{void}{wxVLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
-<wx/object.h>
+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.
-\func{}{WXTRACE}{formatString, ...}
+The trace messages also usually can be separated into different categories and
+the second and third versions of this function only log the message if the
+{\it mask} which it has is currently enabled in \helpref{wxLog}{wxlog}. This
+allows to selectively trace only some operations and not others by changing
+the value of the trace mask (possible during the run-time).
-Calls wxTrace with printf-style variable argument syntax. Output
-is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
+For the second function (taking a string mask), the message is logged only if
+the mask has been previously enabled by the call to
+\helpref{AddTraceMask}{wxlogaddtracemask}. The predefined string trace masks
+used by wxWindows are:
-This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+\begin{itemize}\itemsep=0pt
+\item wxTRACE\_MemAlloc: trace memory allocation (new/delete)
+\item wxTRACE\_Messages: trace window messages/X callbacks
+\item wxTRACE\_ResAlloc: trace GDI resource allocation
+\item wxTRACE\_RefCount: trace various ref counting operations
+\item wxTRACE\_OleCalls: trace OLE method calls (Win32 only)
+\end{itemize}
-\wxheading{Include files}
+The third version of the function only logs the message if all the bit
+corresponding to the {\it mask} are set in the wxLog trace mask which can be
+set by \helpref{SetTraceMask}{wxlogsettracemask}. This version is less
+flexible than the previous one because it doesn't allow defining the user
+trace masks easily - this is why it is deprecated in favour of using string
+trace masks.
-<wx/memory.h>
+\begin{itemize}\itemsep=0pt
+\item wxTraceMemAlloc: trace memory allocation (new/delete)
+\item wxTraceMessages: trace window messages/X callbacks
+\item wxTraceResAlloc: trace GDI resource allocation
+\item wxTraceRefCount: trace various ref counting operations
+\item wxTraceOleCalls: trace OLE method calls (Win32 only)
+\end{itemize}
-\membersection{WXTRACELEVEL}\label{tracelevel}
+\membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
-\func{}{WXTRACELEVEL}{level, formatString, ...}
+\func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}
-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 shows a message to the user in a safe way and should be safe to
+call even before the application has been initialized or if it is currently in
+some other strange state (for example, about to crash). Under Windows this
+function shows a message box using a native dialog instead of
+\helpref{wxMessageBox}{wxmessagebox} (which might be unsafe to call), elsewhere
+it simply prints the message to the standard output using the title as prefix.
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+\wxheading{Parameters}
-\wxheading{Include files}
+\docparam{title}{The title of the message box shown to the user or the prefix
+of the message string}
-<wx/memory.h>
+\docparam{text}{The text to show to the user}
-\section{wxWindows resource functions}\label{resourcefuncs}
+\wxheading{See also}
-\overview{wxWindows resource system}{resourceformats}
+\helpref{wxLogFatalError}{wxlogfatalerror}
-This section details functions for manipulating wxWindows (.WXR) resource
-files and loading user interface elements from resources.
+\wxheading{Include files}
-\normalbox{Please note that this use of the word `resource' is different from that used when talking
-about initialisation file resource reading and writing, using such functions
-as wxWriteResource and wxGetResource. It's just an unfortunate clash of terminology.}
+<wx/log.h>
-\helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
+\membersection{::wxSysErrorCode}\label{wxsyserrorcode}
-See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
-loading from resource data.
+\func{unsigned long}{wxSysErrorCode}{\void}
-{\bf Warning:} this needs updating for wxWindows 2.
+Returns the error code from the last system call. This function uses
+{\tt errno} on Unix platforms and {\tt GetLastError} under Win32.
-\membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
+\wxheading{See also}
-\func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
+\helpref{wxSysErrorMsg}{wxsyserrormsg},
+\helpref{wxLogSysError}{wxlogsyserror}
-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
-perhaps for implementing resource functionality for interpreted languages.
+\membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
-\membersection{::wxResourceClear}
+\func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
-\func{void}{wxResourceClear}{\void}
+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.
-Clears the wxWindows resource table.
+\wxheading{See also}
-\membersection{::wxResourceCreateBitmap}
+\helpref{wxSysErrorCode}{wxsyserrorcode},
+\helpref{wxLogSysError}{wxlogsyserror}
-\func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
+\membersection{WXTRACE}\label{trace}
-Creates a new bitmap from a file, static data, or Windows resource, given a valid
-wxWindows bitmap resource identifier. For example, if the .WXR file contains
-the following:
+\wxheading{Include files}
-\begin{verbatim}
-static const wxString\& aiai_resource = "bitmap(name = 'aiai_resource',\
- bitmap = ['aiai', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
- bitmap = ['aiai.xpm', wxBITMAP_TYPE_XPM, 'X']).";
-\end{verbatim}
+<wx/object.h>
-then this function can be called as follows:
+\func{}{WXTRACE}{formatString, ...}
-\begin{verbatim}
- wxBitmap *bitmap = wxResourceCreateBitmap("aiai_resource");
-\end{verbatim}
+{\bf NB:} This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-\membersection{::wxResourceCreateIcon}
+Calls wxTrace with printf-style variable argument syntax. Output
+is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
-\func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
+\wxheading{Include files}
-Creates a new icon from a file, static data, or Windows resource, given a valid
-wxWindows icon resource identifier. For example, if the .WXR file contains
-the following:
+<wx/memory.h>
-\begin{verbatim}
-static const wxString\& aiai_resource = "icon(name = 'aiai_resource',\
- icon = ['aiai', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
- icon = ['aiai', wxBITMAP_TYPE_XBM_DATA, 'X']).";
-\end{verbatim}
+\membersection{WXTRACELEVEL}\label{tracelevel}
-then this function can be called as follows:
+\func{}{WXTRACELEVEL}{level, formatString, ...}
-\begin{verbatim}
- wxIcon *icon = wxResourceCreateIcon("aiai_resource");
-\end{verbatim}
+{\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-\membersection{::wxResourceCreateMenuBar}
+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.
-\func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
+\wxheading{Include files}
-Creates a new menu bar given a valid wxWindows menubar resource
-identifier. For example, if the .WXR file contains the following:
+<wx/memory.h>
-\begin{verbatim}
-static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
- menu = \
- [\
- ['&File', 1, '', \
- ['&Open File', 2, 'Open a file'],\
- ['&Save File', 3, 'Save a file'],\
- [],\
- ['E&xit', 4, 'Exit program']\
- ],\
- ['&Help', 5, '', \
- ['&About', 6, 'About this program']\
- ]\
- ]).";
-\end{verbatim}
+\membersection{::wxTrace}\label{wxtrace}
-then this function can be called as follows:
+\func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
-\begin{verbatim}
- wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
-\end{verbatim}
+{\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+Takes printf-style variable argument syntax. Output
+is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
-\membersection{::wxResourceGetIdentifier}
+\wxheading{Include files}
-\func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
+<wx/memory.h>
-Used for retrieving the integer value associated with an identifier.
-A zero value indicates that the identifier was not found.
+\membersection{::wxTraceLevel}\label{wxtracelevel}
-See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
+\func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
-\membersection{::wxResourceParseData}\label{wxresourcedata}
+{\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-\func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
+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.
-Parses a string containing one or more wxWindows resource objects. If
-the resource objects are global static data that are included into the
-C++ program, then this function must be called for each variable
-containing the resource data, to make it known to wxWindows.
+\wxheading{Include files}
-{\it resource} should contain data in the following form:
+<wx/memory.h>
-\begin{verbatim}
-dialog(name = 'dialog1',
- style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
- title = 'Test dialog box',
- x = 312, y = 234, width = 400, height = 300,
- modal = 0,
- control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
- [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
- control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',
- 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
- [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
- [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
-\end{verbatim}
+\section{Time functions}\label{timefunctions}
-This function will typically be used after including a {\tt .wxr} file into
-a C++ program as follows:
+The functions in this section deal with getting the current time and
+starting/stopping the global timers. Please note that the timer functions are
+deprecated because they work with one global timer only and
+\helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
+should be used instead. For retrieving the current time, you may also use
+\helpref{wxDateTime::Now}{wxdatetimenow} or
+\helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
-\begin{verbatim}
-#include "dialog1.wxr"
-\end{verbatim}
+\membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
-Each of the contained resources will declare a new C++ variable, and each
-of these variables should be passed to wxResourceParseData.
+\func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
-\membersection{::wxResourceParseFile}
+Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
-\func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
+If {\it resetTimer} is TRUE (the default), the timer is reset to zero
+by this call.
-Parses a file containing one or more wxWindows resource objects
-in C++-compatible syntax. Use this function to dynamically load
-wxWindows resource data.
+See also \helpref{wxTimer}{wxtimer}.
-\membersection{::wxResourceParseString}\label{wxresourceparsestring}
+\wxheading{Include files}
-\func{bool}{wxResourceParseString}{\param{const wxString\& }{resource}, \param{wxResourceTable *}{table = NULL}}
+<wx/timer.h>
-Parses a string containing one or more wxWindows resource objects. If
-the resource objects are global static data that are included into the
-C++ program, then this function must be called for each variable
-containing the resource data, to make it known to wxWindows.
+\membersection{::wxGetLocalTime}\label{wxgetlocaltime}
-{\it resource} should contain data with the following form:
+\func{long}{wxGetLocalTime}{\void}
-\begin{verbatim}
-static const wxString\& dialog1 = "dialog(name = 'dialog1',\
- style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',\
- title = 'Test dialog box',\
- x = 312, y = 234, width = 400, height = 300,\
- modal = 0,\
- control = [wxGroupBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,\
- [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],\
- control = [wxMultiText, 'Multitext', 'wxVERTICAL_LABEL', 'multitext3',\
- 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',\
- [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],\
- [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).";
-\end{verbatim}
+Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
-This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
-load an entire {\tt .wxr file} into a string.
+\wxheading{See also}
-\membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
+\helpref{wxDateTime::Now}{wxdatetimenow}
-\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& }{xbm\_data}, \param{int }{width},
-\param{int }{height}, \param{wxResourceTable *}{table = NULL}}
+\wxheading{Include files}
-\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{const wxString\& *}{xpm\_data}}
+<wx/timer.h>
-Makes \verb$#$included XBM or XPM bitmap data known to the wxWindows resource system.
-This is required if other resources will use the bitmap data, since otherwise there
-is no connection between names used in resources, and the global bitmap data.
+\membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
-\membersection{::wxResourceRegisterIconData}
+\func{wxLongLong}{wxGetLocalTimeMillis}{\void}
-Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
+Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
-\section{Log functions}\label{logfunctions}
+\wxheading{See also}
-These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for
-further information.
+\helpref{wxDateTime::Now}{wxdatetimenow},\\
+\helpref{wxLongLong}{wxlonglong}
\wxheading{Include files}
-<wx/log.h>
-
-\membersection{::wxLogError}\label{wxlogerror}
+<wx/timer.h>
-\func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
+\membersection{::wxGetUTCTime}\label{wxgetutctime}
-The function to use for error messages, i.e. the
-messages that must be shown to the user. The default processing is to pop up a
-message box to inform the user about it.
+\func{long}{wxGetUTCTime}{\void}
-\membersection{::wxLogFatalError}\label{wxlogfatalerror}
+Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
-\func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
+\wxheading{See also}
-Like \helpref{wxLogError}{wxlogerror}, but also
-terminates the program with the exit code 3. Using {\it abort()} standard
-function also terminates the program with this exit code.
+\helpref{wxDateTime::Now}{wxdatetimenow}
-\membersection{::wxLogWarning}\label{wxlogwarning}
+\wxheading{Include files}
-\func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
+<wx/timer.h>
-For warnings - they are also normally shown to the
-user, but don't interrupt the program work.
+\membersection{::wxNow}\label{wxnow}
-\membersection{::wxLogMessage}\label{wxlogmessage}
+\func{wxString}{wxNow}{\void}
-\func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
+Returns a string representing the current date and time.
-for all normal, informational messages. They also
-appear in a message box by default (but it can be changed). Notice
-that the standard behaviour is to not show informational messages if there are
-any errors later - the logic being that the later error messages make the
-informational messages preceding them meaningless.
+\wxheading{Include files}
-\membersection{::wxLogVerbose}\label{wxlogverbose}
+<wx/utils.h>
-\func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
+\membersection{::wxSleep}\label{wxsleep}
-For verbose output. Normally, it's suppressed, but
-might be activated if the user wishes to know more details about the program
-progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}).
+\func{void}{wxSleep}{\param{int}{ secs}}
-\membersection{::wxLogStatus}\label{wxlogstatus}
+Sleeps for the specified number of seconds.
-\func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
+\wxheading{Include files}
-For status messages - they will go into the status
-bar of the active or specified (as the first argument) \helpref{wxFrame}{wxframe} if it has one.
+<wx/utils.h>
-\membersection{::wxLogSysError}\label{wxlogsyserror}
+\membersection{::wxStartTimer}\label{wxstarttimer}
-\func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxStartTimer}{\void}
-Mostly used by wxWindows itself, but might be
-handy for logging errors after system call (API function) failure. It logs the
-specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending
-on the platform) and the corresponding error
-message. The second form of this function takes the error code explitly as the
-first argument.
+Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
-\membersection{::wxLogDebug}\label{wxlogdebug}
+See also \helpref{wxTimer}{wxtimer}.
-\func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
+\wxheading{Include files}
-The right function for debug output. It only
-does anything at all in the debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined)
-and expands to nothing in release mode (otherwise).
+<wx/timer.h>
-\membersection{::wxLogTrace}\label{wxlogtrace}
+\membersection{::wxUsleep}\label{wxusleep}
-\func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
-\func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char*}{ formatString}, \param{...}{}}
+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.
-As {\bf wxLogDebug}, only does something in debug
-build. The reason for making it a separate function from it is that usually
-there are a lot of trace messages, so it might make sense to separate them
-from other debug messages which would be flooded in them. Moreover, the second
-version of this function takes a trace mask as the first argument which allows
-to further restrict the amount of messages generated. The value of {\it mask} can be:
+\wxheading{Include files}
-\begin{itemize}\itemsep=0pt
-\item wxTraceMemAlloc: trace memory allocation (new/delete)
-\item wxTraceMessages: trace window messages/X callbacks
-\item wxTraceResAlloc: trace GDI resource allocation
-\item wxTraceRefCount: trace various ref counting operations
-\end{itemize}
+<wx/utils.h>
\section{Debugging macros and functions}\label{debugmacros}
-Useful macros and functins 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}
\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 *}{cond}, \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}
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}{wxcompiletimeassert} 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}
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 involving 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}
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}
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}
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}}
-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.
\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.
+\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.
+
projects / wxWidgets.git / blobdiff