\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}
-The functions and macros defined in wxWindows are described here.
+The functions and macros defined in wxWindows are described here: you can
+either look up a function using the alphabetical listing of them or find it in
+the corresponding topic.
+
+\section{Alphabetical functions and macros list}
+
+\helpref{CLASSINFO}{classinfo}\\
+\helpref{copystring}{copystring}\\
+\helpref{DECLARE\_ABSTRACT\_CLASS}{declareabstractclass}\\
+\helpref{DECLARE\_APP}{declareapp}\\
+\helpref{DECLARE\_CLASS}{declareclass}\\
+\helpref{DECLARE\_DYNAMIC\_CLASS}{declaredynamicclass}\\
+\helpref{IMPLEMENT\_ABSTRACT\_CLASS2}{implementabstractclass2}\\
+\helpref{IMPLEMENT\_ABSTRACT\_CLASS}{implementabstractclass}\\
+\helpref{IMPLEMENT\_APP}{implementapp}\\
+\helpref{IMPLEMENT\_CLASS2}{implementclass2}\\
+\helpref{IMPLEMENT\_CLASS}{implementclass}\\
+\helpref{IMPLEMENT\_DYNAMIC\_CLASS2}{implementdynamicclass2}\\
+\helpref{IMPLEMENT\_DYNAMIC\_CLASS}{implementdynamicclass}\\
+\helpref{WXDEBUG\_NEW}{debugnew}\\
+\helpref{WXTRACELEVEL}{tracelevel}\\
+\helpref{WXTRACE}{trace}\\
+\helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}\\
+\helpref{wxASSERT\_MSG}{wxassertmsg}\\
+\helpref{wxASSERT}{wxassert}\\
+\helpref{wxBITMAP}{wxbitmapmacro}\\
+\helpref{wxBeginBusyCursor}{wxbeginbusycursor}\\
+\helpref{wxBell}{wxbell}\\
+\helpref{wxCHECK2\_MSG}{wxcheck2msg}\\
+\helpref{wxCHECK2}{wxcheck2}\\
+\helpref{wxCHECK\_MSG}{wxcheckmsg}\\
+\helpref{wxCHECK\_RET}{wxcheckret}\\
+\helpref{wxCHECK\_VERSION}{wxcheckversion}\\
+\helpref{wxCHECK}{wxcheck}\\
+\helpref{wxClientDisplayRect}{wxclientdisplayrect}\\
+\helpref{wxClipboardOpen}{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{wxLL}{wxll}\\
+\helpref{wxLongLongFmtSpec}{wxlonglongfmtspec}\\
+\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}
\begin{itemize}\itemsep=0pt
\item {\tt wxMAJOR\_VERSION} is the major version of wxWindows
\item {\tt wxMINOR\_VERSION} is the minor version of wxWindows
-\item {\tt wxRELASE\_NUMBER} is the release number
+\item {\tt wxRELEASE\_NUMBER} is the release number
\end{itemize}
For example, the values or these constants for wxWindows 2.1.15 are 2, 1 and
}
\end{verbatim}
-\section{Thread functions}\label{threadfunctions}
+\section{Application initialization and termination}\label{appinifunctions}
-\wxheading{Include files}
+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.
-<wx/thread.h>
+\membersection{::wxEntry}\label{wxentry}
-\wxheading{See also}
+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.
-\helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}, \helpref{Multithreading overview}{wxthreadoverview}
+\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
+ \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
-\membersection{::wxMutexGuiEnter}\label{wxmutexguienter}
+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}{wxMutexGuiEnter}{\void}
+\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
+ \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
-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}.
+wxWindows initialization under Windows (for applications constructed as a DLL).
-Typically, these functions are used like this:
+\func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
-\begin{verbatim}
-void MyThread::Foo(void)
-{
- // before doing any GUI calls we must ensure that this thread is the only
- // one doing it!
+wxWindows initialization under Unix.
- wxMutexGuiEnter();
+\wxheading{Remarks}
- // Call GUI here:
- my_window->DrawSomething();
+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:
- wxMutexGuiLeave();
+\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}
-Note that under GTK, no creation of top-level windows is allowed in any
-thread but the main one.
-
-This function is only defined on platforms which support preemptive
-threads.
+\wxheading{Include files}
-\membersection{::wxMutexGuiLeave}\label{wxmutexguileave}
+<wx/app.h>
-\func{void}{wxMutexGuiLeave}{\void}
+\membersection{::wxHandleFatalExceptions}\label{wxhandlefatalexceptions}
-See \helpref{::wxMutexGuiEnter()}{wxmutexguienter}.
+\func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = TRUE}}
-This function is only defined on platforms which support preemptive
-threads.
+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.
-\section{File functions}\label{filefunctions}
+\membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
-\wxheading{Include files}
+\func{void}{wxInitAllImageHandlers}{\void}
-<wx/utils.h>
+Initializes all available image handlers. For a list of available handlers,
+see \helpref{wxImage}{wximage}.
\wxheading{See also}
-\helpref{wxPathList}{wxpathlist}, \helpref{wxDir}{wxdir}, \helpref{wxFile}{wxfile}
+\helpref{wxImage}{wximage}, \helpref{wxImageHandler}{wximagehandler}
-\membersection{::wxDirExists}
+\wxheading{Include files}
-\func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
+<wx/image.h>
-Returns TRUE if the directory exists.
+\membersection{::wxInitialize}\label{wxinitialize}
-\membersection{::wxDos2UnixFilename}
+\func{bool}{wxInitialize}{\void}
-\func{void}{wxDos2UnixFilename}{\param{wxChar *}{s}}
+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.
-Converts a DOS to a Unix filename by replacing backslashes with forward
-slashes.
+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.
-\membersection{::wxFileExists}
+This function may be called several times but
+\helpref{wxUninitialize}{wxuninitialize} must be called for each successful
+call to this function.
-\func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
+\wxheading{Include files}
-Returns TRUE if the file exists. It also returns TRUE if the file is
-a directory.
+<wx/app.h>
-\membersection{::wxFileModificationTime}\label{wxfilemodificationtime}
+\membersection{::wxSafeYield}\label{wxsafeyield}
-\func{time\_t}{wxFileModificationTime}{\param{const wxString\& }{filename}}
+\func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}, \param{bool}{
+ onlyIfNeeded = FALSE}}
-Returns time of last modification of given file.
+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.
-\membersection{::wxFileNameFromPath}
+Returns the result of the call to \helpref{::wxYield}{wxyield}.
-\func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}}
+\wxheading{Include files}
-\func{char*}{wxFileNameFromPath}{\param{char* }{path}}
+<wx/utils.h>
-Returns the filename for a full path. The second form returns a pointer to
-temporary storage that should not be deallocated.
+\membersection{::wxUninitialize}\label{wxuninitialize}
-\membersection{::wxFindFirstFile}\label{wxfindfirstfile}
+\func{void}{wxUninitialize}{\void}
-\func{wxString}{wxFindFirstFile}{\param{const char*}{spec}, \param{int}{ flags = 0}}
+This function is for use in console (wxBase) programs only. It must be called
+once for each previous successful call to \helpref{wxInitialize}{wxinitialize}.
-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 "..".
+\wxheading{Include files}
-{\it spec} may contain wildcards.
+<wx/app.h>
-{\it flags} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
+\membersection{::wxYield}\label{wxyield}
-For example:
+\func{bool}{wxYield}{\void}
-\begin{verbatim}
- wxString f = wxFindFirstFile("/home/project/*.*");
- while ( !f.IsEmpty() )
- {
- ...
- f = wxFindNextFile();
- }
-\end{verbatim}
+Calls \helpref{wxApp::Yield}{wxappyield}.
-\membersection{::wxFindNextFile}\label{wxfindnextfile}
+This function is kept only for backwards compatibility. Please use
+the \helpref{wxApp::Yield}{wxappyield} method instead in any new code.
-\func{wxString}{wxFindNextFile}{\void}
+\wxheading{Include files}
-Returns the next file that matches the path passed to \helpref{wxFindFirstFile}{wxfindfirstfile}.
+<wx/app.h> or <wx/utils.h>
-See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example.
+\membersection{::wxWakeUpIdle}\label{wxwakeupidle}
-\membersection{::wxGetDiskSpace}\label{wxgetdiskspace}
+\func{void}{wxWakeUpIdle}{\void}
-\func{bool}{wxGetDiskSpace}{\param{const wxString\& }{path}, \path{wxLongLong }{*total = NULL}, \path{wxLongLong }{*free = NULL}}
+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}.
-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{Include files}
-\wxheading{Returns}
+<wx/app.h>
-{\tt TRUE} on success, {\tt FALSE} if an error occured (for example, the
-directory doesn't exist).
+\section{Process control functions}\label{processfunctions}
-\wxheading{Portability}
+The functions in this section are used to launch or terminate the other
+processes.
-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.
+\membersection{::wxExecute}\label{wxexecute}
-This function first appeared in wxWindows 2.3.2.
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{int }{sync = wxEXEC\_ASYNC}, \param{wxProcess *}{callback = NULL}}
-\membersection{::wxGetOSDirectory}\label{wxgetosdirectory}
+\func{long}{wxExecute}{\param{char **}{argv}, \param{int }{flags = wxEXEC\_ASYNC}, \param{wxProcess *}{callback = NULL}}
-\func{wxString}{wxGetOSDirectory}{\void}
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
-Returns the Windows directory under Windows; on other platforms returns the empty string.
+\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.}
-\membersection{::wxIsAbsolutePath}
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}}
-\func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
+\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.}
-Returns TRUE if the argument is an absolute filename, i.e. with a slash
-or drive name at the beginning.
+Executes another program in Unix or Windows.
-\membersection{::wxPathOnly}
+The first form takes a command string, such as {\tt "emacs file.txt"}.
-\func{wxString}{wxPathOnly}{\param{const wxString\& }{path}}
+The second form takes an array of values: a command, any number of
+arguments, terminated by NULL.
-Returns the directory part of the filename.
+The semantics of the third and fourth versions is different from the first two
+and is described in more details below.
-\membersection{::wxUnix2DosFilename}
+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.
-\func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}}
+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}.
-Converts a Unix to a DOS filename by replacing forward
-slashes with backslashes.
+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.
-\membersection{::wxConcatFiles}
+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.
+
+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}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2},
-\param{const wxString\& }{file3}}
+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.
-Concatenates {\it file1} and {\it file2} to {\it file3}, returning
-TRUE if successful.
+See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
+\helpref{Exec sample}{sampleexec}.
-\membersection{::wxCopyFile}
+\wxheading{Parameters}
-\func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = TRUE}}
+\docparam{command}{The command to execute and any parameters to pass to it as a
+single string.}
-Copies {\it file1} to {\it file2}, returning TRUE if successful. If
-{\it overwrite} parameter is TRUE (default), the destination file is overwritten
-if it exists, but if {\it overwrite} is FALSE, the functions failes in this
-case.
+\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.}
-\membersection{::wxGetCwd}\label{wxgetcwd}
+\docparam{flags}{Combination of bit masks {\tt wxEXEC\_ASYNC},
+{\tt wxEXEC\_SYNC} and {\tt wxEXEC\_NOHIDE}}
-\func{wxString}{wxGetCwd}{\void}
+\docparam{callback}{An optional pointer to \helpref{wxProcess}{wxprocess}}
-Returns a string containing the current (or working) directory.
+\wxheading{Include files}
-\membersection{::wxGetWorkingDirectory}
+<wx/utils.h>
-\func{wxString}{wxGetWorkingDirectory}{\param{char*}{buf=NULL}, \param{int }{sz=1000}}
+\membersection{::wxExit}\label{wxexit}
-This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.
+\func{void}{wxExit}{\void}
-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.
+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}.
-{\it sz} is the size of the buffer if supplied.
+\wxheading{Include files}
-\membersection{::wxGetTempFileName}
+<wx/app.h>
-\func{char*}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char* }{buf=NULL}}
+\membersection{::wxKill}\label{wxkill}
-\func{bool}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{wxString\& }{buf}}
+\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}}
-Makes a temporary filename based on {\it prefix}, opens and closes the file,
-and places the name in {\it buf}. If {\it buf} is NULL, new store
-is allocated for the temporary filename using {\it new}.
+Equivalent to the Unix kill function: send the given signal {\it sig} to the
+process with PID {\it pid}. The valid signal values are
-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.
+\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}
-It is the application's responsibility to create and delete the file.
+{\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.
-\membersection{::wxIsWild}\label{wxiswild}
-
-\func{bool}{wxIsWild}{\param{const wxString\& }{pattern}}
-
-Returns TRUE if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}.
+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:
-\membersection{::wxMatchWild}\label{wxmatchwild}
+\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}
-\func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}}
+\wxheading{See also}
-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}.
+\helpref{wxProcess::Kill}{wxprocesskill},\rtfsp
+\helpref{wxProcess::Exists}{wxprocessexists},\rtfsp
+\helpref{Exec sample}{sampleexec}
-\membersection{::wxMkdir}
+\wxheading{Include files}
-\func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}}
+<wx/utils.h>
-Makes the directory {\it dir}, returning TRUE if successful.
+\membersection{::wxGetProcessId}\label{wxgetprocessid}
-{\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{unsigned long}{wxGetProcessId}{\void}
-\membersection{::wxRemoveFile}
+Returns the number uniquely identifying the current process in the system.
-\func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
+If an error occurs, $0$ is returned.
-Removes {\it file}, returning TRUE if successful.
+\wxheading{Include files}
-\membersection{::wxRenameFile}
+<wx/utils.h>
-\func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
+\membersection{::wxShell}\label{wxshell}
-Renames {\it file1} to {\it file2}, returning TRUE if successful.
+\func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
-\membersection{::wxRmdir}
+Executes a command in an interactive shell window. If no command is
+specified, then just the shell is spawned.
-\func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
+See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
-Removes the directory {\it dir}, returning TRUE if successful. Does not work under VMS.
+\wxheading{Include files}
-The {\it flags} parameter is reserved for future use.
+<wx/utils.h>
-\membersection{::wxSetWorkingDirectory}
+\membersection{::wxShutdown}\label{wxshutdown}
-\func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
+\func{bool}{wxShutdown}{\param{wxShutdownFlags}{flags}}
-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.
+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.
-\membersection{::wxSplitPath}\label{wxsplitfunction}
+\wxheading{Parameters}
-\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
+\docparam{flags}{Either {\tt wxSHUTDOWN\_POWEROFF} or {\tt wxSHUTDOWN\_REBOOT}}
-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.
+\wxheading{Returns}
-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).
+{\tt TRUE} on success, {\tt FALSE} if an error occured.
-On entry, {\it fullname} should be non-NULL (it may be empty though).
+\wxheading{Include files}
-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).
+<wx/utils.h>
-\membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
+\section{Thread functions}\label{threadfunctions}
-\func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
+\wxheading{Include files}
-Copies the given file to {\it stream}. Useful when converting an old application to
-use streams (within the document/view framework, for example).
+<wx/thread.h>
-Use of this function requires the file wx\_doc.h to be included.
+\wxheading{See also}
-\membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
+\helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}, \helpref{Multithreading overview}{wxthreadoverview}
-\func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
+\membersection{::wxMutexGuiEnter}\label{wxmutexguienter}
-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).
+\func{void}{wxMutexGuiEnter}{\void}
-Use of this function requires the file wx\_doc.h to be included.
+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{Network functions}\label{networkfunctions}
+Typically, these functions are used like this:
-\membersection{::wxGetFullHostName}\label{wxgetfullhostname}
+\begin{verbatim}
+void MyThread::Foo(void)
+{
+ // before doing any GUI calls we must ensure that this thread is the only
+ // one doing it!
-\func{wxString}{wxGetFullHostName}{\void}
+ wxMutexGuiEnter();
-Returns the FQDN (fully qualified domain host name) or an empty string on
-error.
+ // Call GUI here:
+ my_window->DrawSomething();
-\wxheading{See also}
+ wxMutexGuiLeave();
+}
+\end{verbatim}
-\helpref{wxGetHostName}{wxgethostname}
+Note that under GTK, no creation of top-level windows is allowed in any
+thread but the main one.
-\wxheading{Include files}
+This function is only defined on platforms which support preemptive
+threads.
-<wx/utils.h>
+\membersection{::wxMutexGuiLeave}\label{wxmutexguileave}
-\membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
+\func{void}{wxMutexGuiLeave}{\void}
-\func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
+See \helpref{::wxMutexGuiEnter()}{wxmutexguienter}.
-Copies the user's email address into the supplied buffer, by
-concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
-and \helpref{wxGetUserId}{wxgetuserid}.
+This function is only defined on platforms which support preemptive
+threads.
-Returns TRUE if successful, FALSE otherwise.
+\section{File functions}\label{filefunctions}
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxGetHostName}\label{wxgethostname}
+\wxheading{See also}
-\func{wxString}{wxGetHostName}{\void}
+\helpref{wxPathList}{wxpathlist}\\
+\helpref{wxDir}{wxdir}\\
+\helpref{wxFile}{wxfile}\\
+\helpref{wxFileName}{wxfilename}
-\func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
+\membersection{::wxDirExists}\label{functionwxdirexists}
-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.
+\func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
-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.
+Returns TRUE if the directory exists.
-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.
+\membersection{::wxDos2UnixFilename}\label{wxdos2unixfilename}
-\wxheading{See also}
+\func{void}{wxDos2UnixFilename}{\param{wxChar *}{s}}
-\helpref{wxGetFullHostName}{wxgetfullhostname}
+Converts a DOS to a Unix filename by replacing backslashes with forward
+slashes.
-\wxheading{Include files}
+\membersection{::wxFileExists}\label{functionwxfileexists}
-<wx/utils.h>
+\func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
-\section{User identification}\label{useridfunctions}
+Returns TRUE if the file exists. It also returns TRUE if the file is
+a directory.
-\membersection{::wxGetUserId}\label{wxgetuserid}
+\membersection{::wxFileModificationTime}\label{wxfilemodificationtime}
-\func{wxString}{wxGetUserId}{\void}
+\func{time\_t}{wxFileModificationTime}{\param{const wxString\& }{filename}}
-\func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
+Returns time of last modification of given file.
-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).
+\membersection{::wxFileNameFromPath}\label{wxfilenamefrompath}
-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.
+\func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}}
-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.
+\func{char *}{wxFileNameFromPath}{\param{char *}{path}}
-\wxheading{See also}
+{\bf NB:} This function is obsolete, please use
+\helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
-\helpref{wxGetUserName}{wxgetusername}
+Returns the filename for a full path. The second form returns a pointer to
+temporary storage that should not be deallocated.
-\wxheading{Include files}
+\membersection{::wxFindFirstFile}\label{wxfindfirstfile}
-<wx/utils.h>
+\func{wxString}{wxFindFirstFile}{\param{const char *}{spec}, \param{int}{ flags = 0}}
-\membersection{::wxGetUserName}\label{wxgetusername}
+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{wxString}{wxGetUserName}{\void}
+{\it spec} may contain wildcards.
-\func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}}
+{\it flags} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
-This function returns the full user name (something like "Mr. John Smith").
+For example:
-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}
+ wxString f = wxFindFirstFile("/home/project/*.*");
+ while ( !f.IsEmpty() )
+ {
+ ...
+ f = wxFindNextFile();
+ }
+\end{verbatim}
-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.
+\membersection{::wxFindNextFile}\label{wxfindnextfile}
-\wxheading{See also}
+\func{wxString}{wxFindNextFile}{\void}
-\helpref{wxGetUserId}{wxgetuserid}
+Returns the next file that matches the path passed to \helpref{wxFindFirstFile}{wxfindfirstfile}.
-\wxheading{Include files}
+See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example.
-<wx/utils.h>
+\membersection{::wxGetDiskSpace}\label{wxgetdiskspace}
-\section{String functions}
+\func{bool}{wxGetDiskSpace}{\param{const wxString\& }{path}, \param{wxLongLong }{*total = NULL}, \param{wxLongLong }{*free = NULL}}
-\membersection{::copystring}
+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.
-\func{char*}{copystring}{\param{const char* }{s}}
+\wxheading{Returns}
-Makes a copy of the string {\it s} using the C++ new operator, so it can be
-deleted with the {\it delete} operator.
+{\tt TRUE} on success, {\tt FALSE} if an error occured (for example, the
+directory doesn't exist).
-\membersection{::wxIsEmpty}\label{wxisempty}
+\wxheading{Portability}
-\func{bool}{wxIsEmpty}{\param{const char *}{ p}}
+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.
-Returns {\tt TRUE} if the pointer is either {\tt NULL} or points to an empty
-string, {\tt FALSE} otherwise.
+This function first appeared in wxWindows 2.3.2.
-\membersection{::wxStricmp}\label{wxstricmp}
+\membersection{::wxGetOSDirectory}\label{wxgetosdirectory}
-\func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}}
+\func{wxString}{wxGetOSDirectory}{\void}
-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.
+Returns the Windows directory under Windows; on other platforms returns the empty string.
-This function complements the standard C function {\it strcmp()} which performs
-case-sensitive comparison.
+\membersection{::wxIsAbsolutePath}\label{wxisabsolutepath}
-\membersection{::wxStringMatch}
+\func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
-\func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
- \param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}}
+Returns TRUE if the argument is an absolute filename, i.e. with a slash
+or drive name at the beginning.
-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{::wxPathOnly}\label{wxpathonly}
-This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
+\func{wxString}{wxPathOnly}{\param{const wxString\& }{path}}
-\membersection{::wxStringEq}\label{wxstringeq}
+Returns the directory part of the filename.
-\func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
+\membersection{::wxUnix2DosFilename}\label{wxunix2dosfilename}
-A macro defined as:
+\func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}}
-\begin{verbatim}
-#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
-\end{verbatim}
+Converts a Unix to a DOS filename by replacing forward
+slashes with backslashes.
-This function is obsolete, use \helpref{wxString}{wxstring} instead.
+\membersection{::wxConcatFiles}\label{wxconcatfiles}
-\membersection{::wxStrlen}\label{wxstrlen}
+\func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2},
+\param{const wxString\& }{file3}}
-\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 {\tt NULL} pointer.
+Concatenates {\it file1} and {\it file2} to {\it file3}, returning
+TRUE if successful.
-\membersection{::wxGetTranslation}\label{wxgettranslation}
+\membersection{::wxCopyFile}\label{wxcopyfile}
-\func{const char *}{wxGetTranslation}{\param{const char * }{str}}
+\func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = TRUE}}
-This function returns the translation of string {\it str} in the current
-\helpref{locale}{wxlocale}. If the string is not found in any of the loaded
-message catalogs (see \helpref{internationalization overview}{internationalization}), the
-original string is returned. In debug build, an error message is logged - this
-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().
+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{::wxSnprintf}\label{wxsnprintf}
+\membersection{::wxGetCwd}\label{wxgetcwd}
-\func{int}{wxSnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{}{...}}
+\func{wxString}{wxGetCwd}{\void}
-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 a string containing the current (or working) directory.
-Returns the number of characters copied to the buffer or -1 if there is not
-enough space.
+\membersection{::wxGetWorkingDirectory}\label{wxgetworkingdirectory}
-\wxheading{See also}
+\func{wxString}{wxGetWorkingDirectory}{\param{char *}{buf=NULL}, \param{int }{sz=1000}}
-\helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}
+{\bf NB:} This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.
-\membersection{::wxVsnprintf}\label{wxvsnprintf}
+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.
-\func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argptr}}
+{\it sz} is the size of the buffer if supplied.
-The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list}
-argument instead of arbitrary number of parameters.
+\membersection{::wxGetTempFileName}\label{wxgettempfilename}
-\wxheading{See also}
+\func{char *}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char *}{buf=NULL}}
-\helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv}
+\func{bool}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{wxString\& }{buf}}
-\section{Dialog functions}\label{dialogfunctions}
+%% 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.
-Below are a number of convenience functions for getting input from the
-user or displaying messages. Note that in these functions the last three
-parameters are optional. However, it is recommended to pass a parent frame
-parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
-the front when the dialog box is popped up.
+\membersection{::wxIsWild}\label{wxiswild}
-\membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider}
+\func{bool}{wxIsWild}{\param{const wxString\& }{pattern}}
-\func{wxTipProvider *}{wxCreateFileTipProvider}{\param{const wxString\& }{filename},
- \param{size\_t }{currentTip}}
+Returns TRUE if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}.
-This function creates a \helpref{wxTipProvider}{wxtipprovider} which may be
-used with \helpref{wxShowTip}{wxshowtip}.
+\membersection{::wxMatchWild}\label{wxmatchwild}
-\docparam{filename}{The name of the file containing the tips, one per line}
-\docparam{currentTip}{The index of the first tip to show - normally this index
-is remembered between the 2 program runs.}
+\func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}}
-\wxheading{See also}
+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}.
-\helpref{Tips overview}{tipsoverview}
+\membersection{::wxMkdir}\label{wxmkdir}
-\wxheading{Include files}
+\func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}}
-<wx/tipdlg.h>
+Makes the directory {\it dir}, returning TRUE if successful.
-\membersection{::wxFileSelector}\label{wxfileselector}
+{\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{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\
- \param{const wxString\& }{default\_filename = ""}, \param{const wxString\& }{default\_extension = ""},\\
- \param{const wxString\& }{wildcard = ``*.*''}, \param{int }{flags = 0}, \param{wxWindow *}{parent = ""},\\
- \param{int}{ x = -1}, \param{int}{ y = -1}}
+\membersection{::wxRemoveFile}\label{wxremovefile}
-Pops up a file selector box. In Windows, this is the common file selector
-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, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0.
+\func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
-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.
+Removes {\it file}, returning TRUE if successful.
-The wildcard may be a specification for multiple types of file
-with a description for each, such as:
+\membersection{::wxRenameFile}\label{wxrenamefile}
-\begin{verbatim}
- "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
-\end{verbatim}
+\func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
-The application must check for an empty return value (the user pressed
-Cancel). For example:
+Renames {\it file1} to {\it file2}, returning TRUE if successful.
-\begin{verbatim}
-const wxString& s = wxFileSelector("Choose a file to open");
-if (s)
-{
- ...
-}
-\end{verbatim}
+\membersection{::wxRmdir}\label{wxrmdir}
-\wxheading{Include files}
+\func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
-<wx/filedlg.h>
+Removes the directory {\it dir}, returning TRUE if successful. Does not work under VMS.
-\membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
+The {\it flags} parameter is reserved for future use.
-\func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
+\membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory}
-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.
+\func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
-\wxheading{Parameters}
+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.
-\docparam{parent}{The parent window for the colour selection dialog}
+\membersection{::wxSplitPath}\label{wxsplitfunction}
-\docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
+\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
-\wxheading{Include files}
+{\bf NB:} This function is obsolete, please use
+\helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
-<wx/colordlg.h>
+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.
-\membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
+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).
-\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}}
+On entry, {\it fullname} should be non-NULL (it may be empty though).
-\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}}
+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).
-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.
+\membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
-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}.
+\func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
-If {\it centre} is TRUE, the message text (which may include new line
-characters) is centred; if FALSE, the message is left-justified.
+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/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.}
+<wx/docview.h>
-\membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
+\membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
-\func{long}{wxGetNumberFromUser}{
- \param{const wxString\& }{message},
- \param{const wxString\& }{prompt},
- \param{const wxString\& }{caption},
- \param{long }{value},
- \param{long }{min = 0},
- \param{long }{max = 100},
- \param{wxWindow *}{parent = NULL},
- \param{const wxPoint\& }{pos = wxDefaultPosition}}
+\func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
-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.
+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).
-The number entered must be in the range {\it min}..{\it max} (both of which
-should be positive) and {\it value} is the initial value of it. If the user
-enters an invalid value or cancels the dialog, the function will return -1.
+\wxheading{Include files}
-Dialog is centered on its {\it parent} unless an explicit position is given in
-{\it pos}.
+<wx/docview.h>
-\wxheading{Include files}
+\section{Network, user and OS functions}\label{networkfunctions}
-<wx/textdlg.h>
+The functions in this section are used to retrieve information about the
+current computer and/or user characteristics.
-\membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
+\membersection{::wxGetFreeMemory}\label{wxgetfreememory}
-\func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
- \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL}}
+\func{long}{wxGetFreeMemory}{\void}
-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.
+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/textdlg.h>
+<wx/utils.h>
-\membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
+\membersection{::wxGetFullHostName}\label{wxgetfullhostname}
-\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}}
+\func{wxString}{wxGetFullHostName}{\void}
-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.
+Returns the FQDN (fully qualified domain host name) or an empty string on
+error.
-If {\it centre} is TRUE, the message text (which may include new line characters)
-is centred; if FALSE, the message is left-justified.
+\wxheading{See also}
+
+\helpref{wxGetHostName}{wxgethostname}
\wxheading{Include files}
-<wx/textdlg.h>
+<wx/utils.h>
-\membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
+\membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
-\func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
- \param{int }{nsel}, \param{int *}{selection},
- \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{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
-Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
-listbox. The user may choose one or more item(s) and press OK or Cancel.
+Copies the user's email address into the supplied buffer, by
+concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
+and \helpref{wxGetUserId}{wxgetuserid}.
-The number of initially selected choices, and array of the selected indices,
-are passed in; this array will contain the user selections on exit, with
-the function returning the number of selections. {\it selection} must be
-as big as the number of choices, in case all are selected.
+Returns TRUE if successful, FALSE otherwise.
-If Cancel is pressed, -1 is returned.
+\wxheading{Include files}
-{\it choices} is an array of {\it n} strings for the listbox.
+<wx/utils.h>
-If {\it centre} is TRUE, the message text (which may include new line characters)
-is centred; if FALSE, the message is left-justified.
+\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/choicdlg.h>
+<wx/utils.h>
-\membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
+\membersection{::wxGetHostName}\label{wxgethostname}
-\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}}
+\func{wxString}{wxGetHostName}{\void}
-\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{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
-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.
+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.
-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}.
+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.
-If {\it centre} is TRUE, the message text (which may include new line
-characters) is centred; if FALSE, the message is left-justified.
+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/choicdlg.h>
+<wx/utils.h>
-\perlnote{In wxPerl there is just an array reference in place of {\tt n}
-and {\tt choices}.}
+\membersection{::wxGetUserId}\label{wxgetuserid}
-\membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
+\func{wxString}{wxGetUserId}{\void}
-\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{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
-\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}}
+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).
-As {\bf wxGetSingleChoice} but returns the index representing the selected
-string. If the user pressed cancel, -1 is returned.
+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/choicdlg.h>
+<wx/utils.h>
-\perlnote{In wxPerl there is just an array reference in place of {\tt n}
-and {\tt choices}.}
+\membersection{::wxGetOsDescription}\label{wxgetosdescription}
-\membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
+\func{wxString}{wxGetOsDescription}{\void}
-\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}}
+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}.
-\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}}
+\wxheading{See also}
-As {\bf wxGetSingleChoice} but takes an array of client data 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}!
+\helpref{::wxGetOsVersion}{wxgetosversion}
\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.}
+<wx/utils.h>
-\membersection{::wxMessageBox}\label{wxmessagebox}
+\membersection{::wxGetOsVersion}\label{wxgetosversion}
-\func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
- \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
+\func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
-General purpose message dialog. {\it style} may be a bit list of the
-following identifiers:
+Gets operating system version information.
\begin{twocollist}\itemsep=0pt
-\twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
-wxCANCEL.}
-\twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
-wxYES\_NO or wxOK.}
-\twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
-\twocolitem{wxCENTRE}{Centres the text.}
-\twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
-\twocolitem{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.}
+\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}
-The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
+\wxheading{See also}
-For example:
+\helpref{::wxGetOsDescription}{wxgetosdescription}
-\begin{verbatim}
- ...
- int answer = wxMessageBox("Quit program?", "Confirm",
- wxYES_NO | wxCANCEL, main_frame);
- if (answer == wxYES)
- delete main_frame;
- ...
-\end{verbatim}
+\wxheading{Include files}
-{\it message} may contain newline characters, in which case the
-message will be split into separate lines, to cater for large messages.
+<wx/utils.h>
-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{::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/msgdlg.h>
+<wx/utils.h>
-\membersection{::wxShowTip}\label{wxshowtip}
+\membersection{::wxGetUserName}\label{wxgetusername}
-\func{bool}{wxShowTip}{\param{wxWindow *}{parent},
- \param{wxTipProvider *}{tipProvider},
- \param{bool }{showAtStartup = TRUE}}
+\func{wxString}{wxGetUserName}{\void}
-This function shows a "startup tip" to the user.
+\func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}}
-\docparam{parent}{The parent window for the modal dialog}
+This function returns the full user name (something like "Mr. John Smith").
-\docparam{tipProvider}{An object which is used to get the text of the tips.
-It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
+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.
-\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.}
+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{Tips overview}{tipsoverview}
+\helpref{wxGetUserId}{wxgetuserid}
\wxheading{Include files}
-<wx/tipdlg.h>
+<wx/utils.h>
-\section{GDI functions}\label{gdifunctions}
+\section{String functions}
-The following are relevant to the GDI (Graphics Device Interface).
+\membersection{::copystring}\label{copystring}
-\wxheading{Include files}
+\func{char *}{copystring}{\param{const char *}{s}}
-<wx/gdicmn.h>
+Makes a copy of the string {\it s} using the C++ new operator, so it can be
+deleted with the {\it delete} operator.
-\membersection{::wxClientDisplayRect}
+This function is deprecated, use \helpref{wxString}{wxstring} class instead.
-\func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
-\param{int *}{width}, \param{int *}{height}}
+\membersection{::wxIsEmpty}\label{wxisempty}
-\func{wxRect}{wxGetClientDisplayRect}{\void}
+\func{bool}{wxIsEmpty}{\param{const char *}{ p}}
-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.
+Returns {\tt TRUE} if the pointer is either {\tt NULL} or points to an empty
+string, {\tt FALSE} otherwise.
-\membersection{::wxColourDisplay}
+\membersection{::wxStricmp}\label{wxstricmp}
-\func{bool}{wxColourDisplay}{\void}
+\func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}}
-Returns TRUE if the display is colour, FALSE otherwise.
+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.
-\membersection{::wxDisplayDepth}
+This function complements the standard C function {\it strcmp()} which performs
+case-sensitive comparison.
-\func{int}{wxDisplayDepth}{\void}
+\membersection{::wxStringMatch}\label{wxstringmatch}
-Returns the depth of the display (a value of 1 denotes a monochrome display).
+\func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
+ \param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}}
-\membersection{::wxDisplaySize}
+{\bf NB:} This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
-\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
+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.
-\func{wxSize}{wxGetDisplaySize}{\void}
+\membersection{::wxStringEq}\label{wxstringeq}
-Returns the display size in pixels.
+\func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
-\membersection{::wxDisplaySizeMM}
+{\bf NB:} This function is obsolete, use \helpref{wxString}{wxstring} instead.
-\func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
+A macro defined as:
-\func{wxSize}{wxGetDisplaySizeMM}{\void}
+\begin{verbatim}
+#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
+\end{verbatim}
-Returns the display size in millimeters.
+\membersection{::wxStrlen}\label{wxstrlen}
-\membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
+\func{size\_t}{wxStrlen}{\param{const char *}{ p}}
-\func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
- \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
+This is a safe version of standard function {\it strlen()}: it does exactly the
+same thing (i.e. returns the length of the string) except that it returns 0 if
+{\it p} is the {\tt NULL} pointer.
-Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
-makes it into a placeable metafile by prepending a header containing the given
-bounding box. The bounding box may be obtained from a device context after drawing
-into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
-
-In addition to adding the placeable metafile header, this function adds
-the equivalent of the following code to the start of the metafile data:
+\membersection{::wxGetTranslation}\label{wxgettranslation}
-\begin{verbatim}
- SetMapMode(dc, MM_ANISOTROPIC);
- SetWindowOrg(dc, minX, minY);
- SetWindowExt(dc, maxX - minX, maxY - minY);
-\end{verbatim}
+\func{const char *}{wxGetTranslation}{\param{const char * }{str}}
-This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
+This function returns the translation of string {\it str} in the current
+\helpref{locale}{wxlocale}. If the string is not found in any of the loaded
+message catalogs (see \helpref{internationalization overview}{internationalization}), the
+original string is returned. In debug build, an error message is logged - this
+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().
-Placeable metafiles may be imported by many Windows applications, and can be
-used in RTF (Rich Text Format) files.
+\membersection{::wxSnprintf}\label{wxsnprintf}
-{\it scale} allows the specification of scale for the metafile.
+\func{int}{wxSnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{}{...}}
-This function is only available under Windows.
+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.
-\membersection{::wxSetCursor}\label{wxsetcursor}
+Returns the number of characters copied to the buffer or -1 if there is not
+enough space.
-\func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
+\wxheading{See also}
-Globally sets the cursor; only has an effect in Windows and GTK.
-See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
+\helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}
-\section{Printer settings}\label{printersettings}
+\membersection{::wxToLower}\label{wxtolower}
-These routines are obsolete and should no longer be used!
+\func{char}{wxToLower}{\param{char }{ch}}
-The following functions are used to control PostScript printing. Under
-Windows, PostScript output can only be sent to a file.
+Converts the character to lower case. This is implemented as a macro for efficiency.
\wxheading{Include files}
-<wx/dcps.h>
+<wx/utils.h>
-\membersection{::wxGetPrinterCommand}
+\membersection{::wxToUpper}\label{wxtoupper}
-\func{wxString}{wxGetPrinterCommand}{\void}
+\func{char}{wxToUpper}{\param{char }{ch}}
-Gets the printer command used to print a file. The default is {\tt lpr}.
+Converts the character to upper case. This is implemented as a macro for efficiency.
-\membersection{::wxGetPrinterFile}
+\wxheading{Include files}
-\func{wxString}{wxGetPrinterFile}{\void}
+<wx/utils.h>
-Gets the PostScript output filename.
+\membersection{::wxVsnprintf}\label{wxvsnprintf}
-\membersection{::wxGetPrinterMode}
+\func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}}
-\func{int}{wxGetPrinterMode}{\void}
+The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list }
+argument instead of arbitrary number of parameters.
-Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
-The default is PS\_PREVIEW.
+\wxheading{See also}
-\membersection{::wxGetPrinterOptions}
+\helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv}
-\func{wxString}{wxGetPrinterOptions}{\void}
+\section{Dialog functions}\label{dialogfunctions}
-Gets the additional options for the print command (e.g. specific printer). The default is nothing.
+Below are a number of convenience functions for getting input from the
+user or displaying messages. Note that in these functions the last three
+parameters are optional. However, it is recommended to pass a parent frame
+parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
+the front when the dialog box is popped up.
-\membersection{::wxGetPrinterOrientation}
+\membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
-\func{int}{wxGetPrinterOrientation}{\void}
+\func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
-Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
+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.
-\membersection{::wxGetPrinterPreviewCommand}
+See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
-\func{wxString}{wxGetPrinterPreviewCommand}{\void}
+\wxheading{Include files}
-Gets the command used to view a PostScript file. The default depends on the platform.
+<wx/utils.h>
-\membersection{::wxGetPrinterScaling}
+\membersection{::wxBell}\label{wxbell}
-\func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
+\func{void}{wxBell}{\void}
-Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
+Ring the system bell.
-\membersection{::wxGetPrinterTranslation}
+\wxheading{Include files}
-\func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
+<wx/utils.h>
-Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
+\membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider}
-\membersection{::wxSetPrinterCommand}
+\func{wxTipProvider *}{wxCreateFileTipProvider}{\param{const wxString\& }{filename},
+ \param{size\_t }{currentTip}}
-\func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
+This function creates a \helpref{wxTipProvider}{wxtipprovider} which may be
+used with \helpref{wxShowTip}{wxshowtip}.
-Sets the printer command used to print a file. The default is {\tt lpr}.
+\docparam{filename}{The name of the file containing the tips, one per line}
+\docparam{currentTip}{The index of the first tip to show - normally this index
+is remembered between the 2 program runs.}
-\membersection{::wxSetPrinterFile}
+\wxheading{See also}
-\func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
+\helpref{Tips overview}{tipsoverview}
-Sets the PostScript output filename.
+\wxheading{Include files}
-\membersection{::wxSetPrinterMode}
+<wx/tipdlg.h>
-\func{void}{wxSetPrinterMode}{\param{int }{mode}}
+\membersection{::wxDirSelector}\label{wxdirselector}
-Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
-The default is PS\_PREVIEW.
+\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}}
-\membersection{::wxSetPrinterOptions}
+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.
-\func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
+The application must check for an empty return value (if the user pressed
+Cancel). For example:
-Sets the additional options for the print command (e.g. specific printer). The default is nothing.
+\begin{verbatim}
+const wxString& dir = wxDirSelector("Choose a folder");
+if ( !dir.empty() )
+{
+ ...
+}
+\end{verbatim}
-\membersection{::wxSetPrinterOrientation}
+\wxheading{Include files}
-\func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
+<wx/dirdlg.h>
-Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
+\membersection{::wxFileSelector}\label{wxfileselector}
-\membersection{::wxSetPrinterPreviewCommand}
+\func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\
+ \param{const wxString\& }{default\_filename = ""}, \param{const wxString\& }{default\_extension = ""},\\
+ \param{const wxString\& }{wildcard = ``*.*''}, \param{int }{flags = 0}, \param{wxWindow *}{parent = ""},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1}}
-\func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
+Pops up a file selector box. In Windows, this is the common file selector
+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, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0.
-Sets the command used to view a PostScript file. The default depends on the platform.
+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.
-\membersection{::wxSetPrinterScaling}
+The wildcard may be a specification for multiple types of file
+with a description for each, such as:
-\func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
+\begin{verbatim}
+ "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
+\end{verbatim}
-Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
+The application must check for an empty return value (the user pressed
+Cancel). For example:
-\membersection{::wxSetPrinterTranslation}
+\begin{verbatim}
+wxString filename = wxFileSelector("Choose a file to open");
+if ( !filename.empty() )
+{
+ // work with the file
+ ...
+}
+//else: cancelled by user
+\end{verbatim}
-\func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
+\wxheading{Include files}
-Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
+<wx/filedlg.h>
-\section{Clipboard functions}\label{clipsboard}
+\membersection{::wxEndBusyCursor}\label{wxendbusycursor}
-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.
+\func{void}{wxEndBusyCursor}{\void}
-\wxheading{Include files}
+Changes the cursor back to the original cursor, for all windows in the application.
+Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
-<wx/clipbrd.h>
+See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
-\membersection{::wxClipboardOpen}
+\wxheading{Include files}
-\func{bool}{wxClipboardOpen}{\void}
+<wx/utils.h>
-Returns TRUE if this application has already opened the clipboard.
+\membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
-\membersection{::wxCloseClipboard}
+\func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
-\func{bool}{wxCloseClipboard}{\void}
+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.
-Closes the clipboard to allow other applications to use it.
+\wxheading{Parameters}
-\membersection{::wxEmptyClipboard}
+\docparam{parent}{The parent window for the colour selection dialog}
-\func{bool}{wxEmptyClipboard}{\void}
+\docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
-Empties the clipboard.
+\wxheading{Include files}
-\membersection{::wxEnumClipboardFormats}
+<wx/colordlg.h>
-\func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
+\membersection{::wxGetFontFromUser}\label{wxgetfontfromuser}
-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.
+\func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}}
-{\it dataFormat} specifies a known format. If this parameter is zero,
-the function returns the first format in the list.
+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.
-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.
+\wxheading{Parameters}
-Before it enumerates the formats function, an application must open the clipboard by using the
-wxOpenClipboard function.
+\docparam{parent}{The parent window for the font selection dialog}
-\membersection{::wxGetClipboardData}
+\docparam{fontInit}{If given, this will be the font initially selected in the dialog.}
-\func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
+\wxheading{Include files}
-Gets data from the clipboard.
+<wx/fontdlg.h>
-{\it dataFormat} may be one of:
-\begin{itemize}\itemsep=0pt
-\item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
-\item wxCF\_BITMAP: returns a new wxBitmap.
-\end{itemize}
+\membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
-The clipboard must have previously been opened for this call to succeed.
+\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}}
-\membersection{::wxGetClipboardFormatName}
+\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}}
-\func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
+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.
-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.
+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}.
-\membersection{::wxIsClipboardFormatAvailable}
+If {\it centre} is TRUE, the message text (which may include new line
+characters) is centred; if FALSE, the message is left-justified.
-\func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
+\wxheading{Include files}
-Returns TRUE if the given data format is available on the clipboard.
+<wx/choicdlg.h>
-\membersection{::wxOpenClipboard}
+\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.}
-\func{bool}{wxOpenClipboard}{\void}
+\membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
-Opens the clipboard for passing data to it or getting data from it.
+\func{long}{wxGetNumberFromUser}{
+ \param{const wxString\& }{message},
+ \param{const wxString\& }{prompt},
+ \param{const wxString\& }{caption},
+ \param{long }{value},
+ \param{long }{min = 0},
+ \param{long }{max = 100},
+ \param{wxWindow *}{parent = NULL},
+ \param{const wxPoint\& }{pos = wxDefaultPosition}}
-\membersection{::wxRegisterClipboardFormat}
+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.
-\func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
+The number entered must be in the range {\it min}..{\it max} (both of which
+should be positive) and {\it value} is the initial value of it. If the user
+enters an invalid value or cancels the dialog, the function will return -1.
-Registers the clipboard data format name and returns an identifier.
+Dialog is centered on its {\it parent} unless an explicit position is given in
+{\it pos}.
-\membersection{::wxSetClipboardData}
+\wxheading{Include files}
-\func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
+<wx/textdlg.h>
-Passes data to the clipboard.
+\membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
-{\it dataFormat} may be one of:
+\func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
+ \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL}}
-\begin{itemize}\itemsep=0pt
-\item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
-\item wxCF\_BITMAP: {\it data} is a wxBitmap.
-\item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
-\item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
-\end{itemize}
+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.
-The clipboard must have previously been opened for this call to succeed.
+\wxheading{Include files}
-\section{Miscellaneous functions}\label{miscellany}
+<wx/textdlg.h>
-\membersection{::wxDROP\_ICON}\label{wxdropicon}
+\membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
-\func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
+\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}}
-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.
+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.
-This macro should be used with
-\helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
+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/dnd.h>
+<wx/textdlg.h>
-\membersection{::wxNewId}
+\membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
-\func{long}{wxNewId}{\void}
+\func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+ \param{int }{nsel}, \param{int *}{selection},
+ \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
-Generates an integer identifier unique to this run of the program.
+Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
+listbox. The user may choose one or more item(s) and press OK or Cancel.
+
+The number of initially selected choices, and array of the selected indices,
+are passed in; this array will contain the user selections on exit, with
+the function returning the number of selections. {\it selection} must be
+as big as the number of choices, in case all are selected.
+
+If Cancel is pressed, -1 is returned.
+
+{\it choices} is an array of {\it n} strings for the listbox.
+
+If {\it centre} is TRUE, the message text (which may include new line characters)
+is centred; if FALSE, the message is left-justified.
\wxheading{Include files}
-<wx/utils.h>
+<wx/choicdlg.h>
-\membersection{::wxRegisterId}
+\membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
-\func{void}{wxRegisterId}{\param{long}{ id}}
+\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}}
-Ensures that ids subsequently generated by {\bf NewId} do not clash with
-the given {\bf id}.
+\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}}
+
+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.
+
+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/utils.h>
+<wx/choicdlg.h>
-\membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
-\func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
+\membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
-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.
+\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}}
-See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
+\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{int}{ n}, \param{const wxString\& }{choices[]},\\
+ \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
+
+As {\bf wxGetSingleChoice} but returns the index representing the selected
+string. If the user pressed cancel, -1 is returned.
\wxheading{Include files}
-<wx/utils.h>
+<wx/choicdlg.h>
-\membersection{::wxBell}
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
-\func{void}{wxBell}{\void}
+\membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
-Ring the system bell.
+\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}}
-\wxheading{Include files}
+\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}}
-<wx/utils.h>
+As {\bf wxGetSingleChoice} but takes an array of client data 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}!
-\membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
+\wxheading{Include files}
-\func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
+<wx/choicdlg.h>
-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.
+\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{::wxDDECleanUp}\label{wxddecleanup}
+\membersection{::wxIsBusy}\label{wxisbusy}
-\func{void}{wxDDECleanUp}{\void}
+\func{bool}{wxIsBusy}{\void}
-Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
-called by the application.
+Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
+\helpref{wxEndBusyCursor}{wxendbusycursor} calls.
-See also \helpref{wxDDEInitialize}{wxddeinitialize}.
+See also \helpref{wxBusyCursor}{wxbusycursor}.
\wxheading{Include files}
-<wx/dde.h>
+<wx/utils.h>
-\membersection{::wxDDEInitialize}\label{wxddeinitialize}
+\membersection{::wxMessageBox}\label{wxmessagebox}
-\func{void}{wxDDEInitialize}{\void}
+\func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
+ \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
-Initializes the DDE system. May be called multiple times without harm.
+General purpose message dialog. {\it style} may be a bit list of the
+following identifiers:
-This no longer needs to be called by the application: it will be called
-by wxWindows if necessary.
+\begin{twocollist}\itemsep=0pt
+\twocolitem{wxYES\_NO}{Puts Yes and No buttons on the message box. May be combined with
+wxCANCEL.}
+\twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with
+wxYES\_NO or wxOK.}
+\twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.}
+\twocolitem{wxCENTRE}{Centres the text.}
+\twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.}
+\twocolitem{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}
-See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
-\helpref{wxDDECleanUp}{wxddecleanup}.
+The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
+
+For example:
+
+\begin{verbatim}
+ ...
+ int answer = wxMessageBox("Quit program?", "Confirm",
+ wxYES_NO | wxCANCEL, main_frame);
+ if (answer == wxYES)
+ delete main_frame;
+ ...
+\end{verbatim}
+
+{\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/dde.h>
+<wx/msgdlg.h>
+
+\membersection{::wxShowTip}\label{wxshowtip}
-\membersection{::wxDebugMsg}\label{wxdebugmsg}
+\func{bool}{wxShowTip}{\param{wxWindow *}{parent},
+ \param{wxTipProvider *}{tipProvider},
+ \param{bool }{showAtStartup = TRUE}}
-\func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
+This function shows a "startup tip" to the user. The return value is the
+state of the ``Show tips at startup'' checkbox.
-{\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogdebug} instead!}
+\docparam{parent}{The parent window for the modal dialog}
-Display a debugging message; under Windows, this will appear on the
-debugger command window, and under Unix, it will be written to standard
-error.
+\docparam{tipProvider}{An object which is used to get the text of the tips.
+It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
-The syntax is identical to {\bf printf}: pass a format string and a
-variable list of arguments.
+\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.}
-{\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{See also}
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+\helpref{Tips overview}{tipsoverview}
\wxheading{Include files}
-<wx/utils.h>
-
-\membersection{::wxDisplaySize}
+<wx/tipdlg.h>
-\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
+\section{GDI functions}\label{gdifunctions}
-Gets the physical size of the display in pixels.
+The following are relevant to the GDI (Graphics Device Interface).
\wxheading{Include files}
<wx/gdicmn.h>
-\membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
-
-\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
-
-This function enables or disables all top level windows. It is used by
-\helpref{::wxSafeYield}{wxsafeyield}.
+\membersection{wxBITMAP}\label{wxbitmapmacro}
-\wxheading{Include files}
+\func{}{wxBITMAP}{bitmapName}
-<wx/utils.h>
+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.
-\membersection{::wxEntry}\label{wxentry}
+\wxheading{See also}
-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.
+\helpref{Bitmaps and icons overview}{wxbitmapoverview},
+\helpref{wxICON}{wxiconmacro}
-\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
- \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
+\wxheading{Include files}
-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.
+<wx/gdicmn.h>
-\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
- \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
+\membersection{::wxClientDisplayRect}\label{wxclientdisplayrect}
-wxWindows initialization under Windows (for applications constructed as a DLL).
+\func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
+\param{int *}{width}, \param{int *}{height}}
-\func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
+\func{wxRect}{wxGetClientDisplayRect}{\void}
-wxWindows initialization under Unix.
+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.
-\wxheading{Remarks}
+\membersection{::wxColourDisplay}\label{wxcolourdisplay}
-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:
+\func{bool}{wxColourDisplay}{\void}
-\begin{verbatim}
-int CTheApp::ExitInstance()
-{
- // OnExit isn't called by CleanUp so must be called explicitly.
- wxTheApp->OnExit();
- wxApp::CleanUp();
+Returns TRUE if the display is colour, FALSE otherwise.
- return CWinApp::ExitInstance();
-}
-\end{verbatim}
+\membersection{::wxDisplayDepth}\label{wxdisplaydepth}
-\wxheading{Include files}
+\func{int}{wxDisplayDepth}{\void}
-<wx/app.h>
+Returns the depth of the display (a value of 1 denotes a monochrome display).
-\membersection{::wxEndBusyCursor}\label{wxendbusycursor}
+\membersection{::wxDisplaySize}\label{wxdisplaysize}
-\func{void}{wxEndBusyCursor}{\void}
+\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
-Changes the cursor back to the original cursor, for all windows in the application.
-Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
+\func{wxSize}{wxGetDisplaySize}{\void}
-See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
+Returns the display size in pixels.
-\wxheading{Include files}
+\membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}
-<wx/utils.h>
+\func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
-\membersection{::wxError}\label{wxerror}
+\func{wxSize}{wxGetDisplaySizeMM}{\void}
-\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
+Returns the display size in millimeters.
-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}.
+\membersection{::wxDROP\_ICON}\label{wxdropicon}
-\wxheading{Include files}
+\func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
-<wx/utils.h>
+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.
-\membersection{::wxExecute}\label{wxexecute}
+This macro should be used with
+\helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
+\wxheading{Include files}
-\func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
+<wx/dnd.h>
-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
+\membersection{wxICON}\label{wxiconmacro}
-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}}
+\func{}{wxICON}{iconName}
-Executes another program in Unix or Windows.
+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.
-The first form takes a command string, such as {\tt "emacs file.txt"}.
+\wxheading{See also}
-The second form takes an array of values: a command, any number of
-arguments, terminated by NULL.
+\helpref{Bitmaps and icons overview}{wxbitmapoverview},
+\helpref{wxBITMAP}{wxbitmapmacro}
-The semantics of the third and fourth versions is different from the first two
-and is described in more details below.
+\wxheading{Include files}
-If {\it sync} is FALSE (the default), flow of control immediately returns.
-If TRUE, the current application waits until the other program has terminated.
+<wx/gdicmn.h>
-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}.
+\membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
-For asynchronous execution, however, the return value is the process id and
-zero value indicates that the command could not be executed. As an added
-complication, the return value of $-1$ in this case indicattes that we didn't
-launch a new process, but connected to the running one (this can only happen in
-case of using DDE under Windows for command execution). In particular, in this,
-and only this, case the calling code will not get the notification about
-process termination.
+\func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
+ \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
-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.
+Given a filename for an existing, valid metafile (as constructed using \helpref{wxMetafileDC}{wxmetafiledc})
+makes it into a placeable metafile by prepending a header containing the given
+bounding box. The bounding box may be obtained from a device context after drawing
+into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY.
-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.
+In addition to adding the placeable metafile header, this function adds
+the equivalent of the following code to the start of the metafile data:
-See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
-\helpref{Exec sample}{sampleexec}.
+\begin{verbatim}
+ SetMapMode(dc, MM_ANISOTROPIC);
+ SetWindowOrg(dc, minX, minY);
+ SetWindowExt(dc, maxX - minX, maxY - minY);
+\end{verbatim}
-\wxheading{Include files}
+This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
-<wx/utils.h>
+Placeable metafiles may be imported by many Windows applications, and can be
+used in RTF (Rich Text Format) files.
-\membersection{::wxExit}\label{wxexit}
+{\it scale} allows the specification of scale for the metafile.
-\func{void}{wxExit}{\void}
+This function is only available under Windows.
-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}.
+\membersection{::wxSetCursor}\label{wxsetcursor}
-\wxheading{Include files}
+\func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
-<wx/app.h>
+Globally sets the cursor; only has an effect in Windows and GTK.
+See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
-\membersection{::wxFatalError}\label{wxfatalerror}
+\section{Printer settings}\label{printersettings}
-\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
+{\bf NB:} These routines are obsolete and should no longer be used!
-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}.
+The following functions are used to control PostScript printing. Under
+Windows, PostScript output can only be sent to a file.
\wxheading{Include files}
-<wx/utils.h>
+<wx/dcps.h>
-\membersection{::wxFindMenuItemId}
+\membersection{::wxGetPrinterCommand}\label{wxgetprintercommand}
-\func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
+\func{wxString}{wxGetPrinterCommand}{\void}
-Find a menu item identifier associated with the given frame's menu bar.
+Gets the printer command used to print a file. The default is {\tt lpr}.
-\wxheading{Include files}
+\membersection{::wxGetPrinterFile}\label{wxgetprinterfile}
-<wx/utils.h>
+\func{wxString}{wxGetPrinterFile}{\void}
-\membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
+Gets the PostScript output filename.
-\func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
+\membersection{::wxGetPrinterMode}\label{wxgetprintermode}
-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.
+\func{int}{wxGetPrinterMode}{\void}
-\wxheading{Include files}
+Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
+The default is PS\_PREVIEW.
-<wx/utils.h>
+\membersection{::wxGetPrinterOptions}\label{wxgetprinteroptions}
-\membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
+\func{wxString}{wxGetPrinterOptions}{\void}
-\func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
+Gets the additional options for the print command (e.g. specific printer). The default is nothing.
-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.
+\membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation}
-If no such named window is found, {\bf wxFindWindowByLabel} is called.
+\func{int}{wxGetPrinterOrientation}{\void}
-\wxheading{Include files}
+Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
-<wx/utils.h>
+\membersection{::wxGetPrinterPreviewCommand}\label{wxgetprinterpreviewcommand}
-\membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
+\func{wxString}{wxGetPrinterPreviewCommand}{\void}
-\func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
+Gets the command used to view a PostScript file. The default depends on the platform.
-Find the deepest window at the given mouse position in screen coordinates,
-returning the window if found, or NULL if not.
+\membersection{::wxGetPrinterScaling}\label{wxgetprinterscaling}
-\membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
+\func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
-\func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
+Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
-Find the deepest window at the mouse pointer position, returning the window
-and current pointer position in screen coordinates.
+\membersection{::wxGetPrinterTranslation}\label{wxgetprintertranslation}
-\membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
+\func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
-\func{wxWindow *}{wxGetActiveWindow}{\void}
+Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
-Gets the currently active window (Windows only).
+\membersection{::wxSetPrinterCommand}\label{wxsetprintercommand}
-\wxheading{Include files}
+\func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
-<wx/windows.h>
+Sets the printer command used to print a file. The default is {\tt lpr}.
-\membersection{::wxGetDisplayName}\label{wxgetdisplayname}
+\membersection{::wxSetPrinterFile}\label{wxsetprinterfile}
-\func{wxString}{wxGetDisplayName}{\void}
+\func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
-Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
+Sets the PostScript output filename.
-\wxheading{Include files}
+\membersection{::wxSetPrinterMode}\label{wxsetprintermode}
-<wx/utils.h>
+\func{void}{wxSetPrinterMode}{\param{int }{mode}}
-\membersection{::wxGetHomeDir}\label{wxgethomedir}
+Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
+The default is PS\_PREVIEW.
-\func{wxString}{wxGetHomeDir}{\void}
+\membersection{::wxSetPrinterOptions}\label{wxsetprinteroptions}
-Return the (current) user's home directory.
+\func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
-\wxheading{See also}
+Sets the additional options for the print command (e.g. specific printer). The default is nothing.
-\helpref{wxGetUserHome}{wxgetuserhome}
+\membersection{::wxSetPrinterOrientation}\label{wxsetprinterorientation}
-\wxheading{Include files}
+\func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
-<wx/utils.h>
+Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
-\membersection{::wxGetFreeMemory}\label{wxgetfreememory}
+\membersection{::wxSetPrinterPreviewCommand}\label{wxsetprinterpreviewcommand}
-\func{long}{wxGetFreeMemory}{\void}
+\func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
-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.
+Sets the command used to view a PostScript file. The default depends on the platform.
-\wxheading{Include files}
+\membersection{::wxSetPrinterScaling}\label{wxsetprinterscaling}
-<wx/utils.h>
+\func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
-\membersection{::wxGetMousePosition}\label{wxgetmouseposition}
+Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
-\func{wxPoint}{wxGetMousePosition}{\void}
+\membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation}
-Returns the mouse position in screen coordinates.
+\func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
-\wxheading{Include files}
+Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
-<wx/utils.h>
+\section{Clipboard functions}\label{clipsboard}
-\membersection{::wxGetOsDescription}\label{wxgetosdescription}
+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.
-\func{wxString}{wxGetOsDescription}{\void}
+\wxheading{Include files}
-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}.
+<wx/clipbrd.h>
-\wxheading{See also}
+\membersection{::wxClipboardOpen}\label{functionwxclipboardopen}
-\helpref{::wxGetOsVersion}{wxgetosversion}
+\func{bool}{wxClipboardOpen}{\void}
-\wxheading{Include files}
+Returns TRUE if this application has already opened the clipboard.
-<wx/utils.h>
+\membersection{::wxCloseClipboard}\label{wxcloseclipboard}
-\membersection{::wxGetOsVersion}\label{wxgetosversion}
+\func{bool}{wxCloseClipboard}{\void}
-\func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
+Closes the clipboard to allow other applications to use it.
-Gets operating system version information.
+\membersection{::wxEmptyClipboard}\label{wxemptyclipboard}
-\begin{twocollist}\itemsep=0pt
-\twocolitemruled{Platform}{Return types}
-\twocolitem{Macintosh}{Return value is wxMACINTOSH.}
-\twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }
-\twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
-\twocolitem{OS/2}{Return value is wxOS2\_PM.}
-\twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
-\twocolitem{Windows NT/2000}{Return value is wxWINDOWS\_NT, version is returned in {\it major} and {\it minor}}
-\twocolitem{Windows 98}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 1 or greater.}
-\twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 0.}
-\twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
-\twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
-\end{twocollist}
+\func{bool}{wxEmptyClipboard}{\void}
-\wxheading{See also}
+Empties the clipboard.
-\helpref{::wxGetOsDescription}{wxgetosdescription}
+\membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}
-\wxheading{Include files}
+\func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
-<wx/utils.h>
+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.
-\membersection{::wxGetResource}\label{wxgetresource}
+{\it dataFormat} specifies a known format. If this parameter is zero,
+the function returns the first format in the list.
-\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
+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.
-\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{float *}{value}, \param{const wxString\& }{file = NULL}}
+Before it enumerates the formats function, an application must open the clipboard by using the
+wxOpenClipboard function.
-\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{long *}{value}, \param{const wxString\& }{file = NULL}}
+\membersection{::wxGetClipboardData}\label{wxgetclipboarddata}
-\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{int *}{value}, \param{const wxString\& }{file = NULL}}
+\func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
-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.
+Gets data from the clipboard.
-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.
+{\it dataFormat} may be one of:
-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.
+\begin{itemize}\itemsep=0pt
+\item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
+\item wxCF\_BITMAP: returns a new wxBitmap.
+\end{itemize}
-See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
+The clipboard must have previously been opened for this call to succeed.
-\wxheading{Include files}
+\membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}
-<wx/utils.h>
+\func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
-\membersection{::wxGetUserId}
+Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
+length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
-\func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
+\membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
-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''.
+\func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
-\wxheading{Include files}
+Returns TRUE if the given data format is available on the clipboard.
-<wx/utils.h>
+\membersection{::wxOpenClipboard}\label{wxopenclipboard}
-\membersection{::wxGetUserHome}\label{wxgetuserhome}
+\func{bool}{wxOpenClipboard}{\void}
-\func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
+Opens the clipboard for passing data to it or getting data from it.
-Returns the home directory for the given user. If the username is empty
-(default value), this function behaves like
-\helpref{wxGetHomeDir}{wxgethomedir}.
+\membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat}
-\wxheading{Include files}
+\func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
-<wx/utils.h>
+Registers the clipboard data format name and returns an identifier.
-\membersection{::wxGetUserName}
+\membersection{::wxSetClipboardData}\label{wxsetclipboarddata}
-\func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
+\func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
-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''.
+Passes data to the clipboard.
-\wxheading{Include files}
+{\it dataFormat} may be one of:
-<wx/utils.h>
+\begin{itemize}\itemsep=0pt
+\item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
+\item wxCF\_BITMAP: {\it data} is a wxBitmap.
+\item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
+\item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
+\end{itemize}
-\membersection{::wxHandleFatalExceptions}\label{wxhandlefatalexceptions}
+The clipboard must have previously been opened for this call to succeed.
-\func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = TRUE}}
+\section{Miscellaneous functions}\label{miscellany}
-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{wxEXPLICIT}\label{wxexplicit}
-\membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
+{\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.
-\func{void}{wxInitAllImageHandlers}{\void}
+\membersection{wxLL}\label{wxll}
-Initializes all available image handlers. For a list of available handlers,
-see \helpref{wxImage}{wximage}.
+\func{wxLongLong\_t}{wxLL}{\param{}{number}}
-\wxheading{See also}
+This macro is defined for the platforms with a native 64 bit integer type and
+allows to define 64 bit compile time constants:
-\helpref{wxImage}{wximage}, \helpref{wxImageHandler}{wximagehandler}
+\begin{verbatim}
+ #ifdef wxLongLong_t
+ wxLongLong_t ll = wxLL(0x1234567890abcdef);
+ #endif
+\end{verbatim}
\wxheading{Include files}
-<wx/image.h>
+<wx/longlong.h>
-\membersection{::wxInitialize}\label{wxinitialize}
+\membersection{wxLongLongFmtSpec}\label{wxlonglongfmtspec}
-\func{bool}{wxInitialize}{\void}
+This macro is defined to contain the {\tt printf()} format specifier using
+which 64 bit integer numbers (i.e. those of type {\tt wxLongLong\_t}) can be
+printed. Example of using it:
-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.
+\begin{verbatim}
+ #ifdef wxLongLong_t
+ wxLongLong_t ll = wxLL(0x1234567890abcdef);
+ printf("Long long = %" wxLongLongFmtSpec "x\n", ll);
+ #endif
+\end{verbatim}
-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.
+\wxheading{See also}
-This function may be called several times but
-\helpref{wxUninitialize}{wxuninitialize} must be called for each successful
-call to this function.
+\helpref{wxLL}{wxll}
\wxheading{Include files}
-<wx/app.h>
-
-\membersection{::wxIsBusy}\label{wxisbusy}
+<wx/longlong.h>
-\func{bool}{wxIsBusy}{\void}
+\membersection{::wxNewId}\label{wxnewid}
-Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
-\helpref{wxEndBusyCursor}{wxendbusycursor} calls.
+\func{long}{wxNewId}{\void}
-See also \helpref{wxBusyCursor}{wxbusycursor}.
+Generates an integer identifier unique to this run of the program.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxKill}\label{wxkill}
+\membersection{::wxRegisterId}\label{wxregisterid}
-\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}}
+\func{void}{wxRegisterId}{\param{long}{ id}}
-Equivalent to the Unix kill function: send the given signal {\it sig} to the
-process with PID {\it pid}. The valud signal values are
+Ensures that ids subsequently generated by {\bf NewId} do not clash with
+the given {\bf id}.
-\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}
+\wxheading{Include files}
-{\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.
+<wx/utils.h>
-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:
+\membersection{::wxDDECleanUp}\label{wxddecleanup}
-\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}
+\func{void}{wxDDECleanUp}{\void}
-\wxheading{See also}
+Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
+called by the application.
-\helpref{wxProcess::Kill}{wxprocesskill},\rtfsp
-\helpref{wxProcess::Exists}{wxprocessexists},\rtfsp
-\helpref{Exec sample}{sampleexec}
+See also \helpref{wxDDEInitialize}{wxddeinitialize}.
\wxheading{Include files}
-<wx/utils.h>
+<wx/dde.h>
-\membersection{::wxLoadUserResource}\label{wxloaduserresource}
+\membersection{::wxDDEInitialize}\label{wxddeinitialize}
-\func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
+\func{void}{wxDDEInitialize}{\void}
-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.
+Initializes the DDE system. May be called multiple times without harm.
-The resource must be defined in the {\tt .rc} file using the following syntax:
+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},
+\helpref{wxDDECleanUp}{wxddecleanup}.
+
+\wxheading{Include files}
-\begin{verbatim}
-myResource TEXT file.ext
-\end{verbatim}
+<wx/dde.h>
-where {\tt file.ext} is a file that the resource compiler can find.
+\membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
-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{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
-This function is available under Windows only.
+This function enables or disables all top level windows. It is used by
+\helpref{::wxSafeYield}{wxsafeyield}.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxNow}\label{wxnow}
+\membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}
-\func{wxString}{wxNow}{\void}
+\func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
-Returns a string representing the current date and time.
+Find a menu item identifier associated with the given frame's menu bar.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxPostDelete}\label{wxpostdelete}
+\membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
-\func{void}{wxPostDelete}{\param{wxObject *}{object}}
+\func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
-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.
+{\bf NB:} This function is obsolete, please use
+\helpref{wxWindow::FindWindowByLabel}{wxwindowfindwindowbylabel} instead.
-Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} 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{::wxPostEvent}\label{wxpostevent}
+\membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
-\func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
+\func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
-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.
+{\bf NB:} This function is obsolete, please use
+\helpref{wxWindow::FindWindowByName}{wxwindowfindwindowbyname} instead.
-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. As this function makes a
-copy of the event, the event needs to have a fully implemented Clone() method,
-which may not be the case for all event in wxWindows.
+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{AddPendingEvent}{wxevthandleraddpendingevent} (which this function
-uses internally).
+If no such named window is found, {\bf wxFindWindowByLabel} is called.
\wxheading{Include files}
-<wx/app.h>
-
-\membersection{::wxSafeYield}\label{wxsafeyield}
+<wx/utils.h>
-\func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
+\membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
-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{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
-Returns the result of the call to \helpref{::wxYield}{wxyield}.
+Find the deepest window at the given mouse position in screen coordinates,
+returning the window if found, or NULL if not.
-\wxheading{Include files}
+\membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
-<wx/utils.h>
+\func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
-\membersection{::wxSetDisplayName}\label{wxsetdisplayname}
+Find the deepest window at the mouse pointer position, returning the window
+and current pointer position in screen coordinates.
-\func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
+\membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
-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.
+\func{wxWindow *}{wxGetActiveWindow}{\void}
-See also \helpref{wxGetDisplayName}{wxgetdisplayname}.
+Gets the currently active window (Windows only).
\wxheading{Include files}
-<wx/utils.h>
-
-\membersection{::wxShell}\label{wxshell}
+<wx/windows.h>
-\func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
+\membersection{::wxGetDisplayName}\label{wxgetdisplayname}
-Executes a command in an interactive shell window. If no command is
-specified, then just the shell is spawned.
+\func{wxString}{wxGetDisplayName}{\void}
-See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
+Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxSleep}\label{wxsleep}
+\membersection{::wxGetMousePosition}\label{wxgetmouseposition}
-\func{void}{wxSleep}{\param{int}{ secs}}
+\func{wxPoint}{wxGetMousePosition}{\void}
-Sleeps for the specified number of seconds.
+Returns the mouse position in screen coordinates.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxStripMenuCodes}
-
-\func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
+\membersection{::wxGetResource}\label{wxgetresource}
-\func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
+\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
+ \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
-Strips any menu codes from {\it in} and places the result
-in {\it out} (or returns the new string, in the first form).
+\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
+ \param{float *}{value}, \param{const wxString\& }{file = NULL}}
-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{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{::wxToLower}\label{wxtolower}
+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{char}{wxToLower}{\param{char }{ch}}
+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.
-Converts the character to lower case. This is implemented as a macro for efficiency.
+See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxToUpper}\label{wxtoupper}
+\membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
-\func{char}{wxToUpper}{\param{char }{ch}}
+\func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}
-Converts the character to upper case. This is implemented as a macro for efficiency.
+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{::wxTrace}\label{wxtrace}
+\membersection{::wxLoadUserResource}\label{wxloaduserresource}
-\func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
+\func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
-Takes printf-style variable argument syntax. Output
-is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
+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 resource must be defined in the {\tt .rc} file using the following syntax:
+
+\begin{verbatim}
+myResource TEXT file.ext
+\end{verbatim}
+
+where {\tt file.ext} is a file that the resource compiler can find.
+
+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}.
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+This function is available under Windows only.
\wxheading{Include files}
-<wx/memory.h>
+<wx/utils.h>
-\membersection{::wxTraceLevel}\label{wxtracelevel}
+\membersection{::wxPostDelete}\label{wxpostdelete}
-\func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
+\func{void}{wxPostDelete}{\param{wxObject *}{object}}
-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.
+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.
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead.
\wxheading{Include files}
-<wx/memory.h>
-
-\membersection{::wxTrap}\label{wxtrap}
+<wx/utils.h>
-\func{void}{wxTrap}{\void}
+\membersection{::wxPostEvent}\label{wxpostevent}
-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.
+\func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
-In release mode this function does nothing.
+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/debug.h>
+<wx/app.h>
-\membersection{::wxUninitialize}\label{wxuninitialize}
+\membersection{::wxSetDisplayName}\label{wxsetdisplayname}
-\func{void}{wxUninitialize}{\void}
+\func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
-This function is for use in console (wxBase) programs only. It must be called
-once for each previous successful call to \helpref{wxInitialize}{wxinitialize}.
+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/app.h>
+<wx/utils.h>
-\membersection{::wxUsleep}\label{wxusleep}
+\membersection{::wxStripMenuCodes}\label{wxstripmenucodes}
-\func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
+\func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
-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{void}{wxStripMenuCodes}{\param{char *}{in}, \param{char *}{out}}
+
+{\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{::wxYield}\label{wxyield}
-
-\func{bool}{wxYield}{\void}
-
-Yields control to pending messages in the windowing system. This can be useful, for example, when a
-time-consuming process writes to a text window. Without an occasional
-yield, the text window will not be updated properly, and on systems with
-cooperative multitasking, such as Windows 3.1 other processes will not respond.
-
-Caution should be exercised, however, since yielding may allow the
-user to perform actions which are not compatible with the current task.
-Disabling menu items or whole menus during processing can avoid unwanted
-reentrance of code: see \helpref{::wxSafeYield}{wxsafeyield} for a better
-function.
-
-Note that wxYield will not flush the message logs. This is intentional as
-calling wxYield is usually done to quickly update the screen and popping up a
-message box dialog may be undesirable. If you do wish to flush the log
-messages immediately (otherwise it will be done during the next idle loop
-iteration), call \helpref{wxLog::FlushActive}{wxlogflushactive}.
-
-\wxheading{Include files}
-
-<wx/app.h> or <wx/utils.h>
-
-\membersection{::wxWakeUpIdle}\label{wxwakeupidle}
-
-\func{void}{wxWakeUpIdle}{\void}
-
-This functions wakes up the (internal and platform dependent) idle system, i.e. it
-will force the system to send an idle event even if the system currently {\it is}
- idle and thus would not send any idle event until after some other event would get
-sent. This is also useful for sending events between two threads and is used by
-the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and
-\helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
-
-\wxheading{Include files}
-
-<wx/app.h>
-
-\section{Macros}\label{macros}
+\section{Byte order macros}\label{byteordermacros}
-These macros are defined in wxWindows.
+The endian-ness issues (that is the difference between big-endian and
+little-endian architectures) are important for the portable programs working
+with the external binary data (for example, data files or data coming from
+network) which is usually in some fixed, platform-independent format. The
+macros are helpful for transforming the data to the correct format.
\membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
\func{wxUint16}{wxUINT16\_SWAP\_ALWAYS}{\param{wxUint16 }{value}}
-This macro will swap the bytes of the {\it value} variable from little
-endian to big endian or vice versa.
+These macros will swap the bytes of the {\it value} variable from little
+endian to big endian or vice versa unconditionally, i.e. independently of the
+current platform.
\membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe}
been compiled on a little-endian architecture, the value will be unchanged.
Use these macros to read data from and write data to a file that stores
-data in little endian (Intel i386) format.
+data in little-endian (for example Intel i386) format.
\membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle}
been compiled on a big-endian architecture, the value will be unchanged.
Use these macros to read data from and write data to a file that stores
-data in big endian format.
+data in big-endian format.
+
+\section{RTTI functions}\label{rttimacros}
+
+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).
+
+The standard C++ RTTI can be used in the user code without any problems and in
+general you shouldn't need to use the functions and the macros in this section
+unless you are thinking of modifying or adding any wxWindows classes.
+
+\wxheading{See also}
+
+\helpref{RTTI overview}{runtimeclassoverview}
\membersection{CLASSINFO}\label{classinfo}
<wx/object.h>
-\membersection{DECLARE\_ABSTRACT\_CLASS}
+\membersection{DECLARE\_ABSTRACT\_CLASS}\label{declareabstractclass}
\func{}{DECLARE\_ABSTRACT\_CLASS}{className}
<wx/app.h>
-\membersection{DECLARE\_CLASS}
+\membersection{DECLARE\_CLASS}\label{declareclass}
\func{}{DECLARE\_CLASS}{className}
<wx/object.h>
-\membersection{DECLARE\_DYNAMIC\_CLASS}
+\membersection{DECLARE\_DYNAMIC\_CLASS}\label{declaredynamicclass}
\func{}{DECLARE\_DYNAMIC\_CLASS}{className}
DECLARE_DYNAMIC_CLASS(wxFrame)
private:
- const wxString\& frameTitle;
+ const wxString& frameTitle;
public:
...
};
<wx/object.h>
-\membersection{IMPLEMENT\_ABSTRACT\_CLASS}
+\membersection{IMPLEMENT\_ABSTRACT\_CLASS}\label{implementabstractclass}
\func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
<wx/object.h>
-\membersection{IMPLEMENT\_ABSTRACT\_CLASS2}
+\membersection{IMPLEMENT\_ABSTRACT\_CLASS2}\label{implementabstractclass2}
\func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
<wx/app.h>
-\membersection{IMPLEMENT\_CLASS}
+\membersection{IMPLEMENT\_CLASS}\label{implementclass}
\func{}{IMPLEMENT\_CLASS}{className, baseClassName}
<wx/object.h>
-\membersection{IMPLEMENT\_CLASS2}
+\membersection{IMPLEMENT\_CLASS2}\label{implementclass2}
\func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
<wx/object.h>
-\membersection{IMPLEMENT\_DYNAMIC\_CLASS}
+\membersection{IMPLEMENT\_DYNAMIC\_CLASS}\label{implementdynamicclass}
\func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
<wx/object.h>
-\membersection{IMPLEMENT\_DYNAMIC\_CLASS2}
+\membersection{IMPLEMENT\_DYNAMIC\_CLASS2}\label{implementdynamicclass2}
\func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
<wx/object.h>
-\membersection{wxBITMAP}\label{wxbitmapmacro}
-
-\func{}{wxBITMAP}{bitmapName}
-
-This macro loads a bitmap from either application resources (on the platforms
-for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
-avoid using {\tt \#ifdef}s when creating bitmaps.
-
-\wxheading{See also}
-
-\helpref{Bitmaps and icons overview}{wxbitmapoverview},
-\helpref{wxICON}{wxiconmacro}
-
-\wxheading{Include files}
-
-<wx/gdicmn.h>
-
\membersection{wxConstCast}\label{wxconstcast}
\func{classname *}{wxConstCast}{ptr, classname}
\helpref{wxDynamicCast}{wxdynamiccast}\\
\helpref{wxStaticCast}{wxstaticcast}
+\membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
+
+\func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
+
+Creates and returns an object of the given class, if the class has been
+registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
+
\membersection{WXDEBUG\_NEW}\label{debugnew}
\func{}{WXDEBUG\_NEW}{arg}
\func{classname *}{wxDynamicCast}{ptr, classname}
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
+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.
\helpref{wxDynamicCast}{wxdynamiccast}
-\membersection{wxICON}\label{wxiconmacro}
-
-\func{}{wxICON}{iconName}
-
-This macro loads an icon from either application resources (on the platforms
-for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to
-avoid using {\tt \#ifdef}s when creating icons.
-
-\wxheading{See also}
-
-\helpref{Bitmaps and icons overview}{wxbitmapoverview},
-\helpref{wxBITMAP}{wxbitmapmacro}
-
-\wxheading{Include files}
-
-<wx/gdicmn.h>
-
\membersection{wxStaticCast}\label{wxstaticcast}
\func{classname *}{wxStaticCast}{ptr, classname}
\helpref{wxDynamicCast}{wxdynamiccast}\\
\helpref{wxConstCast}{wxconstcast}
-\membersection{WXTRACE}\label{trace}
-
-\wxheading{Include files}
-
-<wx/object.h>
-
-\func{}{WXTRACE}{formatString, ...}
-
-Calls wxTrace with printf-style variable argument syntax. Output
-is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
-
-This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
-\wxheading{Include files}
-
-<wx/memory.h>
-
-\membersection{WXTRACELEVEL}\label{tracelevel}
-
-\func{}{WXTRACELEVEL}{level, formatString, ...}
-
-Calls wxTraceLevel with printf-style variable argument syntax. Output
-is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
-The first argument should be the level at which this information is appropriate.
-It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
-this value.
-
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
-\wxheading{Include files}
-
-<wx/memory.h>
-
-\section{wxWindows resource functions}\label{resourcefuncs}
+\section{Resource functions}\label{resourcefuncs}
-\overview{wxWindows resource system}{resourceformats}
+\overview{Resource functions}{resourceformats}
This section details functions for manipulating wxWindows (.WXR) resource
files and loading user interface elements from resources.
\func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{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
+{\tt\#}defining a name to an integer). Unlikely to be used by an application except
perhaps for implementing resource functionality for interpreted languages.
-\membersection{::wxResourceClear}
+\membersection{::wxResourceClear}\label{wxresourceclear}
\func{void}{wxResourceClear}{\void}
Clears the wxWindows resource table.
-\membersection{::wxResourceCreateBitmap}
+\membersection{::wxResourceCreateBitmap}\label{wxresourcecreatebitmap}
\func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
wxBitmap *bitmap = wxResourceCreateBitmap("project_resource");
\end{verbatim}
-\membersection{::wxResourceCreateIcon}
+\membersection{::wxResourceCreateIcon}\label{wxresourcecreateicon}
\func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
wxIcon *icon = wxResourceCreateIcon("project_resource");
\end{verbatim}
-\membersection{::wxResourceCreateMenuBar}
+\membersection{::wxResourceCreateMenuBar}\label{wxresourcecreatemenubar}
\func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
\end{verbatim}
-\membersection{::wxResourceGetIdentifier}
+\membersection{::wxResourceGetIdentifier}\label{wxresourcegetidentifier}
\func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
Each of the contained resources will declare a new C++ variable, and each
of these variables should be passed to wxResourceParseData.
-\membersection{::wxResourceParseFile}
+\membersection{::wxResourceParseFile}\label{wxresourceparsefile}
\func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
\membersection{::wxResourceParseString}\label{wxresourceparsestring}
-\func{bool}{wxResourceParseString}{\param{char*}{ s}, \param{wxResourceTable *}{table = NULL}}
+\func{bool}{wxResourceParseString}{\param{char *}{s}, \param{wxResourceTable *}{table = NULL}}
Parses a string containing one or more wxWindows resource objects. If
the resource objects are global static data that are included into the
\membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
-\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char* }{xbm\_data}, \param{int }{width},
+\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char *}{xbm\_data}, \param{int }{width},
\param{int }{height}, \param{wxResourceTable *}{table = NULL}}
-\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char** }{xpm\_data}}
+\func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char **}{xpm\_data}}
-Makes \tt{#}included XBM or XPM bitmap data known to the wxWindows resource system.
+Makes {\tt\#}included XBM or XPM bitmap data known to the wxWindows resource system.
This is required if other resources will use the bitmap data, since otherwise there
is no connection between names used in resources, and the global bitmap data.
-\membersection{::wxResourceRegisterIconData}
+\membersection{::wxResourceRegisterIconData}\label{wxresourceregistericondata}
Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
<wx/log.h>
+\membersection{::wxDebugMsg}\label{wxdebugmsg}
+
+\func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
+
+{\bf NB:} This function is now obsolete, replaced by \helpref{Log
+functions}{logfunctions} and \helpref{wxLogDebug}{wxlogdebug} in particular.
+
+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/utils.h>
+
+\membersection{::wxError}\label{wxerror}
+
+\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
+
+{\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
+instead.
+
+Displays {\it msg} and continues. This writes to standard error under
+Unix, and pops up a message box under Windows. Used for internal
+wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxFatalError}\label{wxfatalerror}
+
+\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
+
+{\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/utils.h>
+
\membersection{::wxLogError}\label{wxlogerror}
-\func{void}{wxLogError}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogError}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
-The function to use for error messages, i.e. the messages that must be shown
+The functions to use for error messages, i.e. the messages that must be shown
to the user. The default processing is to pop up a message box to inform the
user about it.
\membersection{::wxLogFatalError}\label{wxlogfatalerror}
-\func{void}{wxLogFatalError}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogFatalError}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogFatalError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
Like \helpref{wxLogError}{wxlogerror}, but also
terminates the program with the exit code 3. Using {\it abort()} standard
\membersection{::wxLogWarning}\label{wxlogwarning}
-\func{void}{wxLogWarning}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogWarning}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogWarning}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
For warnings - they are also normally shown to the user, but don't interrupt
the program work.
\membersection{::wxLogMessage}\label{wxlogmessage}
-\func{void}{wxLogMessage}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogMessage}{\param{const char *}{formatString}, \param{...}{}}
-for all normal, informational messages. They also appear in a message box by
+\func{void}{wxVLogMessage}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
+
+For all normal, informational messages. They also appear in a message box by
default (but it can be changed). Notice that the standard behaviour is to not
show informational messages if there are any errors later - the logic being
that the later error messages make the informational messages preceding them
\membersection{::wxLogVerbose}\label{wxlogverbose}
-\func{void}{wxLogVerbose}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogVerbose}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogVerbose}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
For verbose output. Normally, it is suppressed, but
might be activated if the user wishes to know more details about the program
\membersection{::wxLogStatus}\label{wxlogstatus}
-\func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{...}{}}
-\func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxVLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
-Messages logged by this function will appear in the statusbar of the {\it
+\func{void}{wxLogStatus}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogStatus}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
+
+Messages logged by these functions will appear in the statusbar of the {\it
frame} or of the top level application window by default (i.e. when using
-the second version of the function).
+the second version of the functions).
If the target frame doesn't have a statusbar, the message will be lost.
\membersection{::wxLogSysError}\label{wxlogsyserror}
-\func{void}{wxLogSysError}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogSysError}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
Mostly used by wxWindows itself, but might be handy for logging errors after
system call (API function) failure. It logs the specified message text as well
\membersection{::wxLogDebug}\label{wxlogdebug}
-\func{void}{wxLogDebug}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogDebug}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogDebug}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
-The right function for debug output. It only does anything at all in the debug
-mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expands to
+The right functions for debug output. They only do something in debug
+mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expand to
nothing in release mode (otherwise).
\membersection{::wxLogTrace}\label{wxlogtrace}
-\func{void}{wxLogTrace}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxLogTrace}{\param{const char *}{formatString}, \param{...}{}}
+
+\func{void}{wxVLogTrace}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
\func{void}{wxLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{...}{}}
+\func{void}{wxVLogTrace}{\param{const char *}{mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
+
\func{void}{wxLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{...}{}}
+\func{void}{wxVLogTrace}{\param{wxTraceMask}{ mask}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
+
As {\bf wxLogDebug}, trace functions only do something in debug build and
expand to nothing in the release one. The reason for making
it a separate function from it is that usually there are a lot of trace
\item wxTraceOleCalls: trace OLE method calls (Win32 only)
\end{itemize}
+\membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
+
+\func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}
+
+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.
+
+\wxheading{Parameters}
+
+\docparam{title}{The title of the message box shown to the user or the prefix
+of the message string}
+
+\docparam{text}{The text to show to the user}
+
+\wxheading{See also}
+
+\helpref{wxLogFatalError}{wxlogfatalerror}
+
+\wxheading{Include files}
+
+<wx/log.h>
+
\membersection{::wxSysErrorCode}\label{wxsyserrorcode}
\func{unsigned long}{wxSysErrorCode}{\void}
\helpref{wxSysErrorCode}{wxsyserrorcode},
\helpref{wxLogSysError}{wxlogsyserror}
+\membersection{WXTRACE}\label{trace}
+
+\wxheading{Include files}
+
+<wx/object.h>
+
+\func{}{WXTRACE}{formatString, ...}
+
+{\bf NB:} This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
+Calls wxTrace with printf-style variable argument syntax. Output
+is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
+
+\wxheading{Include files}
+
+<wx/memory.h>
+
+\membersection{WXTRACELEVEL}\label{tracelevel}
+
+\func{}{WXTRACELEVEL}{level, formatString, ...}
+
+{\bf NB:} This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
+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.
+
+\wxheading{Include files}
+
+<wx/memory.h>
+
+\membersection{::wxTrace}\label{wxtrace}
+
+\func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
+
+{\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}).
+
+\wxheading{Include files}
+
+<wx/memory.h>
+
+\membersection{::wxTraceLevel}\label{wxtracelevel}
+
+\func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
+
+{\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}).
+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.
+
+\wxheading{Include files}
+
+<wx/memory.h>
+
\section{Time functions}\label{timefunctions}
The functions in this section deal with getting the current time and
\membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
-\func{wxLongLone}{wxGetLocalTimeMillis}{\void}
+\func{wxLongLong}{wxGetLocalTimeMillis}{\void}
Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
\wxheading{See also}
\helpref{wxDateTime::Now}{wxdatetimenow},\\
-\helpref{wxLongLone}{wxlonglong}
+\helpref{wxLongLong}{wxlonglong}
\wxheading{Include files}
<wx/timer.h>
+\membersection{::wxNow}\label{wxnow}
+
+\func{wxString}{wxNow}{\void}
+
+Returns a string representing the current date and time.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxSleep}\label{wxsleep}
+
+\func{void}{wxSleep}{\param{int}{ secs}}
+
+Sleeps for the specified number of seconds.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxStartTimer}\label{wxstarttimer}
\func{void}{wxStartTimer}{\void}
<wx/timer.h>
+\membersection{::wxUsleep}\label{wxusleep}
+
+\func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
+
+Sleeps for the specified number of milliseconds. Notice that usage of this
+function is encouraged instead of calling usleep(3) directly because the
+standard usleep() function is not MT safe.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
\section{Debugging macros and functions}\label{debugmacros}
-Useful macros and functions for error checking and defensive programming. ASSERTs are only
-compiled if \_\_WXDEBUG\_\_ is defined, whereas CHECK macros stay in release
-builds.
+Useful macros and functions for error checking and defensive programming.
+wxWindows defines three families of the assert-like macros:
+the wxASSERT and wxFAIL macros only do anything if \_\_WXDEBUG\_\_ is defined
+(in other words, in the debug build) but disappear completely in the release
+build. On the other hand, the wxCHECK macros stay event in release builds but a
+check failure doesn't generate any user-visible effects then. Finally, the
+compile time assertions don't happen during the run-time but result in the
+compilation error messages if the condition they check fail.
\wxheading{Include files}
\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}
\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
Returns {\tt TRUE} on success.
-
projects / wxWidgets.git / blobdiff