\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
\setfooter{\thepage}{}{}{}{}{\thepage}
-The functions and macros defined in wxWindows are described here.
+The functions and macros defined in wxWindows are described here: you can
+either look up a function using the alphabetical listing of them or find it in
+the corresponding topic.
+
+\section{Alphabetical functions and macros list}
+
+\helpref{CLASSINFO}{classinfo}\\
+\helpref{copystring}{copystring}\\
+\helpref{DECLARE\_ABSTRACT\_CLASS}{declareabstractclass}\\
+\helpref{DECLARE\_APP}{declareapp}\\
+\helpref{DECLARE\_CLASS}{declareclass}\\
+\helpref{DECLARE\_DYNAMIC\_CLASS}{declaredynamicclass}\\
+\helpref{IMPLEMENT\_ABSTRACT\_CLASS2}{implementabstractclass2}\\
+\helpref{IMPLEMENT\_ABSTRACT\_CLASS}{implementabstractclass}\\
+\helpref{IMPLEMENT\_APP}{implementapp}\\
+\helpref{IMPLEMENT\_CLASS2}{implementclass2}\\
+\helpref{IMPLEMENT\_CLASS}{implementclass}\\
+\helpref{IMPLEMENT\_DYNAMIC\_CLASS2}{implementdynamicclass2}\\
+\helpref{IMPLEMENT\_DYNAMIC\_CLASS}{implementdynamicclass}\\
+\helpref{WXDEBUG\_NEW}{debugnew}\\
+\helpref{WXTRACELEVEL}{tracelevel}\\
+\helpref{WXTRACE}{trace}\\
+\helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}\\
+\helpref{wxASSERT\_MSG}{wxassertmsg}\\
+\helpref{wxASSERT}{wxassert}\\
+\helpref{wxBITMAP}{wxbitmapmacro}\\
+\helpref{wxBeginBusyCursor}{wxbeginbusycursor}\\
+\helpref{wxBell}{wxbell}\\
+\helpref{wxCHECK2\_MSG}{wxcheck2msg}\\
+\helpref{wxCHECK2}{wxcheck2}\\
+\helpref{wxCHECK\_MSG}{wxcheckmsg}\\
+\helpref{wxCHECK\_RET}{wxcheckret}\\
+\helpref{wxCHECK\_VERSION}{wxcheckversion}\\
+\helpref{wxCHECK}{wxcheck}\\
+\helpref{wxClientDisplayRect}{wxclientdisplayrect}\\
+\helpref{wxClipboardOpen}{wxclipboardopen}\\
+\helpref{wxCloseClipboard}{wxcloseclipboard}\\
+\helpref{wxColourDisplay}{wxcolourdisplay}\\
+\helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert}\\
+\helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}\\
+\helpref{wxConcatFiles}{wxconcatfiles}\\
+\helpref{wxConstCast}{wxconstcast}\\
+\helpref{wxCopyFile}{wxcopyfile}\\
+\helpref{wxCreateDynamicObject}{wxcreatedynamicobject}\\
+\helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider}\\
+\helpref{wxDDECleanUp}{wxddecleanup}\\
+\helpref{wxDDEInitialize}{wxddeinitialize}\\
+\helpref{wxDROP\_ICON}{wxdropicon}\\
+\helpref{wxDebugMsg}{wxdebugmsg}\\
+\helpref{wxDirExists}{wxdirexists}\\
+\helpref{wxDirSelector}{wxdirselector}\\
+\helpref{wxDisplayDepth}{wxdisplaydepth}\\
+\helpref{wxDisplaySizeMM}{wxdisplaysizemm}\\
+\helpref{wxDisplaySize}{wxdisplaysize}\\
+\helpref{wxDisplaySize}{wxdisplaysize}\\
+\helpref{wxDos2UnixFilename}{wxdos2unixfilename}\\
+\helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
+\helpref{wxDynamicCast}{wxdynamiccast}\\
+\helpref{wxEmptyClipboard}{wxemptyclipboard}\\
+\helpref{wxEnableTopLevelWindows}{wxenabletoplevelwindows}\\
+\helpref{wxEndBusyCursor}{wxendbusycursor}\\
+\helpref{wxEntry}{wxentry}\\
+\helpref{wxEnumClipboardFormats}{wxenumclipboardformats}\\
+\helpref{wxError}{wxerror}\\
+\helpref{wxExecute}{wxexecute}\\
+\helpref{wxExit}{wxexit}\\
+\helpref{wxFAIL\_MSG}{wxfailmsg}\\
+\helpref{wxFAIL}{wxfail}\\
+\helpref{wxFatalError}{wxfatalerror}\\
+\helpref{wxFileExists}{wxfileexists}\\
+\helpref{wxFileModificationTime}{wxfilemodificationtime}\\
+\helpref{wxFileNameFromPath}{wxfilenamefrompath}\\
+\helpref{wxFileSelector}{wxfileselector}\\
+\helpref{wxFindFirstFile}{wxfindfirstfile}\\
+\helpref{wxFindMenuItemId}{wxfindmenuitemid}\\
+\helpref{wxFindNextFile}{wxfindnextfile}\\
+\helpref{wxFindWindowAtPointer}{wxfindwindowatpointer}\\
+\helpref{wxFindWindowAtPoint}{wxfindwindowatpoint}\\
+\helpref{wxFindWindowByLabel}{wxfindwindowbylabel}\\
+\helpref{wxFindWindowByName}{wxfindwindowbyname}\\
+\helpref{wxGetActiveWindow}{wxgetactivewindow}\\
+\helpref{wxGetClipboardData}{wxgetclipboarddata}\\
+\helpref{wxGetClipboardFormatName}{wxgetclipboardformatname}\\
+\helpref{wxGetColourFromUser}{wxgetcolourfromuser}\\
+\helpref{wxGetCwd}{wxgetcwd}\\
+\helpref{wxGetDiskSpace}{wxgetdiskspace}\\
+\helpref{wxGetDisplayName}{wxgetdisplayname}\\
+\helpref{wxGetElapsedTime}{wxgetelapsedtime}\\
+\helpref{wxGetEmailAddress}{wxgetemailaddress}\\
+\helpref{wxGetEnv}{wxgetenv}\\
+\helpref{wxGetFontFromUser}{wxgetfontfromuser}\\
+\helpref{wxGetFreeMemory}{wxgetfreememory}\\
+\helpref{wxGetFullHostName}{wxgetfullhostname}\\
+\helpref{wxGetHomeDir}{wxgethomedir}\\
+\helpref{wxGetHostName}{wxgethostname}\\
+\helpref{wxGetLocalTimeMillis}{wxgetlocaltimemillis}\\
+\helpref{wxGetLocalTime}{wxgetlocaltime}\\
+\helpref{wxGetMousePosition}{wxgetmouseposition}\\
+\helpref{wxGetMultipleChoices}{wxgetmultiplechoices}\\
+\helpref{wxGetMultipleChoice}{wxgetmultiplechoice}\\
+\helpref{wxGetNumberFromUser}{wxgetnumberfromuser}\\
+\helpref{wxGetOSDirectory}{wxgetosdirectory}\\
+\helpref{wxGetOsDescription}{wxgetosdescription}\\
+\helpref{wxGetOsVersion}{wxgetosversion}\\
+\helpref{wxGetPasswordFromUser}{wxgetpasswordfromuser}\\
+\helpref{wxGetPrinterCommand}{wxgetprintercommand}\\
+\helpref{wxGetPrinterFile}{wxgetprinterfile}\\
+\helpref{wxGetPrinterMode}{wxgetprintermode}\\
+\helpref{wxGetPrinterOptions}{wxgetprinteroptions}\\
+\helpref{wxGetPrinterOrientation}{wxgetprinterorientation}\\
+\helpref{wxGetPrinterPreviewCommand}{wxgetprinterpreviewcommand}\\
+\helpref{wxGetPrinterScaling}{wxgetprinterscaling}\\
+\helpref{wxGetPrinterTranslation}{wxgetprintertranslation}\\
+\helpref{wxGetResource}{wxgetresource}\\
+\helpref{wxGetSingleChoiceData}{wxgetsinglechoicedata}\\
+\helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex}\\
+\helpref{wxGetSingleChoice}{wxgetsinglechoice}\\
+\helpref{wxGetTempFileName}{wxgettempfilename}\\
+\helpref{wxGetTextFromUser}{wxgettextfromuser}\\
+\helpref{wxGetTranslation}{wxgettranslation}\\
+\helpref{wxGetUTCTime}{wxgetutctime}\\
+\helpref{wxGetUserHome}{wxgetuserhome}\\
+\helpref{wxGetUserId}{wxgetuserid}\\
+\helpref{wxGetUserName}{wxgetusername}\\
+\helpref{wxGetWorkingDirectory}{wxgetworkingdirectory}\\
+\helpref{wxGetenv}{wxgetenvmacro}\\
+\helpref{wxHandleFatalExceptions}{wxhandlefatalexceptions}\\
+\helpref{wxICON}{wxiconmacro}\\
+\helpref{wxINTXX\_SWAP\_ALWAYS}{intswapalways}\\
+\helpref{wxINTXX\_SWAP\_ON\_BE}{intswaponbe}\\
+\helpref{wxINTXX\_SWAP\_ON\_LE}{intswaponle}\\
+\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}\\
+\helpref{wxInitialize}{wxinitialize}\\
+\helpref{wxIsAbsolutePath}{wxisabsolutepath}\\
+\helpref{wxIsBusy}{wxisbusy}\\
+\helpref{wxIsClipboardFormatAvailable}{wxisclipboardformatavailable}\\
+\helpref{wxIsEmpty}{wxisempty}\\
+\helpref{wxIsWild}{wxiswild}\\
+\helpref{wxKill}{wxkill}\\
+\helpref{wxLoadUserResource}{wxloaduserresource}\\
+\helpref{wxLogDebug}{wxlogdebug}\\
+\helpref{wxLogError}{wxlogerror}\\
+\helpref{wxLogFatalError}{wxlogfatalerror}\\
+\helpref{wxLogMessage}{wxlogmessage}\\
+\helpref{wxLogStatus}{wxlogstatus}\\
+\helpref{wxLogSysError}{wxlogsyserror}\\
+\helpref{wxLogTrace}{wxlogtrace}\\
+\helpref{wxLogVerbose}{wxlogverbose}\\
+\helpref{wxLogWarning}{wxlogwarning}\\
+\helpref{wxMakeMetafilePlaceable}{wxmakemetafileplaceable}\\
+\helpref{wxMatchWild}{wxmatchwild}\\
+\helpref{wxMessageBox}{wxmessagebox}\\
+\helpref{wxMkdir}{wxmkdir}\\
+\helpref{wxMutexGuiEnter}{wxmutexguienter}\\
+\helpref{wxMutexGuiLeave}{wxmutexguileave}\\
+\helpref{wxNewId}{wxnewid}\\
+\helpref{wxNow}{wxnow}\\
+\helpref{wxOnAssert}{wxonassert}\\
+\helpref{wxOpenClipboard}{wxopenclipboard}\\
+\helpref{wxPathOnly}{wxpathonly}\\
+\helpref{wxPostDelete}{wxpostdelete}\\
+\helpref{wxPostEvent}{wxpostevent}\\
+\helpref{wxRegisterClipboardFormat}{wxregisterclipboardformat}\\
+\helpref{wxRegisterId}{wxregisterid}\\
+\helpref{wxRemoveFile}{wxremovefile}\\
+\helpref{wxRenameFile}{wxrenamefile}\\
+\helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}\\
+\helpref{wxResourceClear}{wxresourceclear}\\
+\helpref{wxResourceCreateBitmap}{wxresourcecreatebitmap}\\
+\helpref{wxResourceCreateIcon}{wxresourcecreateicon}\\
+\helpref{wxResourceCreateMenuBar}{wxresourcecreatemenubar}\\
+\helpref{wxResourceGetIdentifier}{wxresourcegetidentifier}\\
+\helpref{wxResourceParseData}{wxresourcedata}\\
+\helpref{wxResourceParseFile}{wxresourceparsefile}\\
+\helpref{wxResourceParseString}{wxresourceparsestring}\\
+\helpref{wxResourceRegisterBitmapData}{registerbitmapdata}\\
+\helpref{wxResourceRegisterIconData}{wxresourceregistericondata}\\
+\helpref{wxRmdir}{wxrmdir}\\
+\helpref{wxSafeYield}{wxsafeyield}\\
+\helpref{wxSetClipboardData}{wxsetclipboarddata}\\
+\helpref{wxSetCursor}{wxsetcursor}\\
+\helpref{wxSetDisplayName}{wxsetdisplayname}\\
+\helpref{wxSetEnv}{wxsetenv}\\
+\helpref{wxSetPrinterCommand}{wxsetprintercommand}\\
+\helpref{wxSetPrinterFile}{wxsetprinterfile}\\
+\helpref{wxSetPrinterMode}{wxsetprintermode}\\
+\helpref{wxSetPrinterOptions}{wxsetprinteroptions}\\
+\helpref{wxSetPrinterOrientation}{wxsetprinterorientation}\\
+\helpref{wxSetPrinterPreviewCommand}{wxsetprinterpreviewcommand}\\
+\helpref{wxSetPrinterScaling}{wxsetprinterscaling}\\
+\helpref{wxSetPrinterTranslation}{wxsetprintertranslation}\\
+\helpref{wxSetWorkingDirectory}{wxsetworkingdirectory}\\
+\helpref{wxShell}{wxshell}\\
+\helpref{wxShowTip}{wxshowtip}\\
+\helpref{wxSleep}{wxsleep}\\
+\helpref{wxSnprintf}{wxsnprintf}\\
+\helpref{wxSplitPath}{wxsplitfunction}\\
+\helpref{wxStartTimer}{wxstarttimer}\\
+\helpref{wxStaticCast}{wxstaticcast}\\
+\helpref{wxStricmp}{wxstricmp}\\
+\helpref{wxStringEq}{wxstringeq}\\
+\helpref{wxStringMatch}{wxstringmatch}\\
+\helpref{wxStripMenuCodes}{wxstripmenucodes}\\
+\helpref{wxStrlen}{wxstrlen}\\
+\helpref{wxSysErrorCode}{wxsyserrorcode}\\
+\helpref{wxSysErrorMsg}{wxsyserrormsg}\\
+\helpref{wxToLower}{wxtolower}\\
+\helpref{wxToUpper}{wxtoupper}\\
+\helpref{wxTraceLevel}{wxtracelevel}\\
+\helpref{wxTrace}{wxtrace}\\
+\helpref{wxTransferFileToStream}{wxtransferfiletostream}\\
+\helpref{wxTransferStreamToFile}{wxtransferstreamtofile}\\
+\helpref{wxTrap}{wxtrap}\\
+\helpref{wxUninitialize}{wxuninitialize}\\
+\helpref{wxUnix2DosFilename}{wxunix2dosfilename}\\
+\helpref{wxUnsetEnv}{wxunsetenv}\\
+\helpref{wxUsleep}{wxusleep}\\
+\helpref{wxVsnprintf}{wxvsnprintf}\\
+\helpref{wxWakeUpIdle}{wxwakeupidle}\\
+\helpref{wxWriteResource}{wxwriteresource}\\
+\helpref{wxYield}{wxyield}
\section{Version macros}\label{versionfunctions}
}
\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}
-
-\membersection{::wxDirExists}
-
-\func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
-
-Returns TRUE if the directory exists.
-
-\membersection{::wxDos2UnixFilename}
+\helpref{wxImage}{wximage}, \helpref{wxImageHandler}{wximagehandler}
-\func{void}{wxDos2UnixFilename}{\param{wxChar *}{s}}
+\wxheading{Include files}
-Converts a DOS to a Unix filename by replacing backslashes with forward
-slashes.
+<wx/image.h>
-\membersection{::wxFileExists}
+\membersection{::wxInitialize}\label{wxinitialize}
-\func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
+\func{bool}{wxInitialize}{\void}
-Returns TRUE if the file exists. It also returns TRUE if the file is
-a directory.
+This function is used in wxBase only and only if you don't create
+\helpref{wxApp}{wxapp} object at all. In this case you must call it from your
+{\tt main()} function before calling any other wxWindows functions.
-\membersection{::wxFileModificationTime}\label{wxfilemodificationtime}
+If the function returns {\tt FALSE} the initialization could not be performed,
+in this case the library cannot be used and
+\helpref{wxUninitialize}{wxuninitialize} shouldn't be called neither.
-\func{time\_t}{wxFileModificationTime}{\param{const wxString\& }{filename}}
+This function may be called several times but
+\helpref{wxUninitialize}{wxuninitialize} must be called for each successful
+call to this function.
-Returns time of last modification of given file.
+\wxheading{Include files}
-\membersection{::wxFileNameFromPath}
+<wx/app.h>
-\func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}}
+\membersection{::wxSafeYield}\label{wxsafeyield}
-\func{char*}{wxFileNameFromPath}{\param{char* }{path}}
+\func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
-Returns the filename for a full path. The second form returns a pointer to
-temporary storage that should not be deallocated.
+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{::wxFindFirstFile}\label{wxfindfirstfile}
+Returns the result of the call to \helpref{::wxYield}{wxyield}.
-\func{wxString}{wxFindFirstFile}{\param{const char*}{spec}, \param{int}{ flags = 0}}
+\wxheading{Include files}
-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 "..".
+<wx/utils.h>
-{\it spec} may contain wildcards.
+\membersection{::wxUninitialize}\label{wxuninitialize}
-{\it flags} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
+\func{void}{wxUninitialize}{\void}
-For example:
+This function is for use in console (wxBase) programs only. It must be called
+once for each previous successful call to \helpref{wxInitialize}{wxinitialize}.
-\begin{verbatim}
- wxString f = wxFindFirstFile("/home/project/*.*");
- while ( !f.IsEmpty() )
- {
- ...
- f = wxFindNextFile();
- }
-\end{verbatim}
+\wxheading{Include files}
-\membersection{::wxFindNextFile}\label{wxfindnextfile}
+<wx/app.h>
-\func{wxString}{wxFindNextFile}{\void}
+\membersection{::wxYield}\label{wxyield}
-Returns the next file that matches the path passed to \helpref{wxFindFirstFile}{wxfindfirstfile}.
+\func{bool}{wxYield}{\void}
-See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example.
+Calls \helpref{wxApp::Yield}{wxappyield}.
-\membersection{::wxGetDiskSpace}\label{wxgetdiskspace}
+This function is kept only for backwards compatibility, please use
+\helpref{wxApp::Yield}{wxappyield}method instead in any new code.
-\func{bool}{wxGetDiskSpace}{\param{const wxString\& }{path}, \param{wxLongLong }{*total = NULL}, \param{wxLongLong }{*free = NULL}}
+\wxheading{Include files}
-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.
+<wx/app.h> or <wx/utils.h>
-\wxheading{Returns}
+\membersection{::wxWakeUpIdle}\label{wxwakeupidle}
-{\tt TRUE} on success, {\tt FALSE} if an error occured (for example, the
-directory doesn't exist).
+\func{void}{wxWakeUpIdle}{\void}
-\wxheading{Portability}
+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 is implemented for Win16 (only for drives less than 2Gb), Win32,
-Mac OS and generic Unix provided the system has {\tt statfs()} function.
+\wxheading{Include files}
-This function first appeared in wxWindows 2.3.2.
+<wx/app.h>
-\membersection{::wxGetOSDirectory}\label{wxgetosdirectory}
+\section{Process control functions}\label{processfunctions}
-\func{wxString}{wxGetOSDirectory}{\void}
+The functions in this section are used to launch or terminate the other
+processes.
-Returns the Windows directory under Windows; on other platforms returns the empty string.
+\membersection{::wxExecute}\label{wxexecute}
-\membersection{::wxIsAbsolutePath}
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
-\func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
+\func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
-Returns TRUE if the argument is an absolute filename, i.e. with a slash
-or drive name at the beginning.
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
-\membersection{::wxPathOnly}
+\perlnote{In wxPerl this function only takes the {\tt command} argument,
+and returns a 2-element list {\tt ( status, output )}, where {\tt output} is
+an array reference.}
-\func{wxString}{wxPathOnly}{\param{const wxString\& }{path}}
+\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}}
-Returns the directory part of the 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.}
-\membersection{::wxUnix2DosFilename}
+Executes another program in Unix or Windows.
-\func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}}
+The first form takes a command string, such as {\tt "emacs file.txt"}.
-Converts a Unix to a DOS filename by replacing forward
-slashes with backslashes.
+The second form takes an array of values: a command, any number of
+arguments, terminated by NULL.
-\membersection{::wxConcatFiles}
+The semantics of the third and fourth versions is different from the first two
+and is described in more details below.
-\func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2},
-\param{const wxString\& }{file3}}
+If {\it sync} is FALSE (the default), flow of control immediately returns.
+If TRUE, the current application waits until the other program has terminated.
-Concatenates {\it file1} and {\it file2} to {\it file3}, returning
-TRUE if successful.
+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{::wxCopyFile}
+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}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = TRUE}}
+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.
-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.
+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.
-\membersection{::wxGetCwd}\label{wxgetcwd}
+See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
+\helpref{Exec sample}{sampleexec}.
-\func{wxString}{wxGetCwd}{\void}
+\wxheading{Include files}
-Returns a string containing the current (or working) directory.
+<wx/utils.h>
-\membersection{::wxGetWorkingDirectory}
+\membersection{::wxExit}\label{wxexit}
-\func{wxString}{wxGetWorkingDirectory}{\param{char*}{buf=NULL}, \param{int }{sz=1000}}
+\func{void}{wxExit}{\void}
-This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.
+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}.
-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.
+\wxheading{Include files}
-{\it sz} is the size of the buffer if supplied.
+<wx/app.h>
-\membersection{::wxGetTempFileName}
+\membersection{::wxKill}\label{wxkill}
-\func{char*}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char* }{buf=NULL}}
+\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}}
-\func{bool}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{wxString\& }{buf}}
+Equivalent to the Unix kill function: send the given signal {\it sig} to the
+process with PID {\it pid}. The valud signal values are
-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}.
+\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}
-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.
+{\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.
-It is the application's responsibility to create and delete the file.
+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{::wxIsWild}\label{wxiswild}
+\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}{wxIsWild}{\param{const wxString\& }{pattern}}
+\wxheading{See also}
-Returns TRUE if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}.
+\helpref{wxProcess::Kill}{wxprocesskill},\rtfsp
+\helpref{wxProcess::Exists}{wxprocessexists},\rtfsp
+\helpref{Exec sample}{sampleexec}
-\membersection{::wxMatchWild}\label{wxmatchwild}
+\wxheading{Include files}
-\func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}}
+<wx/utils.h>
-Returns TRUE if the {\it pattern}\/ matches the {\it text}\/; if {\it
-dot\_special}\/ is TRUE, filenames beginning with a dot are not matched
-with wildcard characters. See \helpref{wxIsWild}{wxiswild}.
+\membersection{::wxShell}\label{wxshell}
-\membersection{::wxMkdir}
+\func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
-\func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}}
+Executes a command in an interactive shell window. If no command is
+specified, then just the shell is spawned.
-Makes the directory {\it dir}, returning TRUE if successful.
+See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
-{\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.
+\wxheading{Include files}
-\membersection{::wxRemoveFile}
+<wx/utils.h>
-\func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
-Removes {\it file}, returning TRUE if successful.
+\section{Thread functions}\label{threadfunctions}
-\membersection{::wxRenameFile}
+\wxheading{Include files}
-\func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
+<wx/thread.h>
-Renames {\it file1} to {\it file2}, returning TRUE if successful.
+\wxheading{See also}
-\membersection{::wxRmdir}
+\helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}, \helpref{Multithreading overview}{wxthreadoverview}
-\func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
+\membersection{::wxMutexGuiEnter}\label{wxmutexguienter}
-Removes the directory {\it dir}, returning TRUE if successful. Does not work under VMS.
+\func{void}{wxMutexGuiEnter}{\void}
-The {\it flags} parameter is reserved for future use.
+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}.
-\membersection{::wxSetWorkingDirectory}
+Typically, these functions are used like this:
-\func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
+\begin{verbatim}
+void MyThread::Foo(void)
+{
+ // before doing any GUI calls we must ensure that this thread is the only
+ // one doing it!
-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.
+ wxMutexGuiEnter();
-\membersection{::wxSplitPath}\label{wxsplitfunction}
+ // Call GUI here:
+ my_window->DrawSomething();
-\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
+ wxMutexGuiLeave();
+}
+\end{verbatim}
-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.
+Note that under GTK, no creation of top-level windows is allowed in any
+thread but the main one.
-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).
+This function is only defined on platforms which support preemptive
+threads.
-On entry, {\it fullname} should be non-NULL (it may be empty though).
+\membersection{::wxMutexGuiLeave}\label{wxmutexguileave}
-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).
+\func{void}{wxMutexGuiLeave}{\void}
-\membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
+See \helpref{::wxMutexGuiEnter()}{wxmutexguienter}.
-\func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
+This function is only defined on platforms which support preemptive
+threads.
-Copies the given file to {\it stream}. Useful when converting an old application to
-use streams (within the document/view framework, for example).
+\section{File functions}\label{filefunctions}
-Use of this function requires the file wx\_doc.h to be included.
+\wxheading{Include files}
-\membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
+<wx/utils.h>
-\func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
+\wxheading{See also}
-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).
+\helpref{wxPathList}{wxpathlist}\\
+\helpref{wxDir}{wxdir}\\
+\helpref{wxFile}{wxfile}\\
+\helpref{wxFileName}{wxfilename}
-Use of this function requires the file wx\_doc.h to be included.
+\membersection{::wxDirExists}\label{wxdirexists}
-\section{Network functions}\label{networkfunctions}
+\func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
-\membersection{::wxGetFullHostName}\label{wxgetfullhostname}
+Returns TRUE if the directory exists.
-\func{wxString}{wxGetFullHostName}{\void}
+\membersection{::wxDos2UnixFilename}\label{wxdos2unixfilename}
-Returns the FQDN (fully qualified domain host name) or an empty string on
-error.
+\func{void}{wxDos2UnixFilename}{\param{wxChar *}{s}}
-\wxheading{See also}
+Converts a DOS to a Unix filename by replacing backslashes with forward
+slashes.
-\helpref{wxGetHostName}{wxgethostname}
+\membersection{::wxFileExists}\label{wxfileexists}
-\wxheading{Include files}
+\func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
-<wx/utils.h>
+Returns TRUE if the file exists. It also returns TRUE if the file is
+a directory.
-\membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
+\membersection{::wxFileModificationTime}\label{wxfilemodificationtime}
-\func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
+\func{time\_t}{wxFileModificationTime}{\param{const wxString\& }{filename}}
-Copies the user's email address into the supplied buffer, by
-concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
-and \helpref{wxGetUserId}{wxgetuserid}.
+Returns time of last modification of given file.
-Returns TRUE if successful, FALSE otherwise.
+\membersection{::wxFileNameFromPath}\label{wxfilenamefrompath}
-\wxheading{Include files}
+\func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}}
-<wx/utils.h>
+\func{char *}{wxFileNameFromPath}{\param{char *}{path}}
-\membersection{::wxGetHostName}\label{wxgethostname}
+Returns the filename for a full path. The second form returns a pointer to
+temporary storage that should not be deallocated.
-\func{wxString}{wxGetHostName}{\void}
+\membersection{::wxFindFirstFile}\label{wxfindfirstfile}
-\func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
+\func{wxString}{wxFindFirstFile}{\param{const char *}{spec}, \param{int}{ flags = 0}}
-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.
+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 "..".
-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.
+{\it spec} may contain wildcards.
-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.
+{\it flags} may be wxDIR for restricting the query to directories, wxFILE for files or zero for either.
-\wxheading{See also}
+For example:
-\helpref{wxGetFullHostName}{wxgetfullhostname}
+\begin{verbatim}
+ wxString f = wxFindFirstFile("/home/project/*.*");
+ while ( !f.IsEmpty() )
+ {
+ ...
+ f = wxFindNextFile();
+ }
+\end{verbatim}
-\wxheading{Include files}
+\membersection{::wxFindNextFile}\label{wxfindnextfile}
-<wx/utils.h>
+\func{wxString}{wxFindNextFile}{\void}
-\section{User identification}\label{useridfunctions}
+Returns the next file that matches the path passed to \helpref{wxFindFirstFile}{wxfindfirstfile}.
-\membersection{::wxGetUserId}\label{wxgetuserid}
+See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example.
-\func{wxString}{wxGetUserId}{\void}
+\membersection{::wxGetDiskSpace}\label{wxgetdiskspace}
-\func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
+\func{bool}{wxGetDiskSpace}{\param{const wxString\& }{path}, \param{wxLongLong }{*total = NULL}, \param{wxLongLong }{*free = NULL}}
-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).
+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.
-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.
+\wxheading{Returns}
-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.
+{\tt TRUE} on success, {\tt FALSE} if an error occured (for example, the
+directory doesn't exist).
-\wxheading{See also}
+\wxheading{Portability}
-\helpref{wxGetUserName}{wxgetusername}
+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.
-\wxheading{Include files}
+This function first appeared in wxWindows 2.3.2.
-<wx/utils.h>
+\membersection{::wxGetOSDirectory}\label{wxgetosdirectory}
-\membersection{::wxGetUserName}\label{wxgetusername}
+\func{wxString}{wxGetOSDirectory}{\void}
-\func{wxString}{wxGetUserName}{\void}
+Returns the Windows directory under Windows; on other platforms returns the empty string.
-\func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}}
+\membersection{::wxIsAbsolutePath}\label{wxisabsolutepath}
-This function returns the full user name (something like "Mr. John Smith").
+\func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
-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.
+Returns TRUE if the argument is an absolute filename, i.e. with a slash
+or drive name at the beginning.
-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{::wxPathOnly}\label{wxpathonly}
-\wxheading{See also}
+\func{wxString}{wxPathOnly}{\param{const wxString\& }{path}}
-\helpref{wxGetUserId}{wxgetuserid}
+Returns the directory part of the filename.
-\wxheading{Include files}
+\membersection{::wxUnix2DosFilename}\label{wxunix2dosfilename}
-<wx/utils.h>
+\func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}}
-\section{String functions}
+Converts a Unix to a DOS filename by replacing forward
+slashes with backslashes.
-\membersection{::copystring}
+\membersection{::wxConcatFiles}\label{wxconcatfiles}
-\func{char*}{copystring}{\param{const char* }{s}}
+\func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2},
+\param{const wxString\& }{file3}}
-Makes a copy of the string {\it s} using the C++ new operator, so it can be
-deleted with the {\it delete} operator.
-
-\membersection{::wxIsEmpty}\label{wxisempty}
+Concatenates {\it file1} and {\it file2} to {\it file3}, returning
+TRUE if successful.
-\func{bool}{wxIsEmpty}{\param{const char *}{ p}}
+\membersection{::wxCopyFile}\label{wxcopyfile}
-Returns {\tt TRUE} if the pointer is either {\tt NULL} or points to an empty
-string, {\tt FALSE} otherwise.
+\func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = TRUE}}
-\membersection{::wxStricmp}\label{wxstricmp}
+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.
-\func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}}
+\membersection{::wxGetCwd}\label{wxgetcwd}
-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.
+\func{wxString}{wxGetCwd}{\void}
-This function complements the standard C function {\it strcmp()} which performs
-case-sensitive comparison.
+Returns a string containing the current (or working) directory.
-\membersection{::wxStringMatch}
+\membersection{::wxGetWorkingDirectory}\label{wxgetworkingdirectory}
-\func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
- \param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}}
+\func{wxString}{wxGetWorkingDirectory}{\param{char *}{buf=NULL}, \param{int }{sz=1000}}
-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.
+This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.
-This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
+Copies the current working directory into the buffer if supplied, or
+copies the working directory into new storage (which you must delete yourself)
+if the buffer is NULL.
-\membersection{::wxStringEq}\label{wxstringeq}
+{\it sz} is the size of the buffer if supplied.
-\func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
+\membersection{::wxGetTempFileName}\label{wxgettempfilename}
-A macro defined as:
+\func{char *}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char *}{buf=NULL}}
-\begin{verbatim}
-#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
-\end{verbatim}
+\func{bool}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{wxString\& }{buf}}
-This function is obsolete, use \helpref{wxString}{wxstring} instead.
+%% Makes a temporary filename based on {\it prefix}, opens and closes the file,
+%% and places the name in {\it buf}. If {\it buf} is NULL, new store
+%% is allocated for the temporary filename using {\it new}.
+%%
+%% Under Windows, the filename will include the drive and name of the
+%% directory allocated for temporary files (usually the contents of the
+%% TEMP variable). Under Unix, the {\tt /tmp} directory is used.
+%%
+%% It is the application's responsibility to create and delete the file.
+
+These functions are obsolete, please use\rtfsp
+\helpref{wxFileName::CreateTempFileName}{wxfilenamecreatetempfilename}\rtfsp
+instead.
-\membersection{::wxStrlen}\label{wxstrlen}
+\membersection{::wxIsWild}\label{wxiswild}
-\func{size\_t}{wxStrlen}{\param{const char *}{ p}}
+\func{bool}{wxIsWild}{\param{const wxString\& }{pattern}}
-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.
+Returns TRUE if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}.
-\membersection{::wxGetTranslation}\label{wxgettranslation}
+\membersection{::wxMatchWild}\label{wxmatchwild}
-\func{const char *}{wxGetTranslation}{\param{const char * }{str}}
+\func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}}
-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().
+Returns TRUE if the {\it pattern}\/ matches the {\it text}\/; if {\it
+dot\_special}\/ is TRUE, filenames beginning with a dot are not matched
+with wildcard characters. See \helpref{wxIsWild}{wxiswild}.
-\membersection{::wxSnprintf}\label{wxsnprintf}
+\membersection{::wxMkdir}\label{wxmkdir}
-\func{int}{wxSnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{}{...}}
+\func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}}
-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.
+Makes the directory {\it dir}, returning TRUE if successful.
-Returns the number of characters copied to the buffer or -1 if there is not
-enough space.
+{\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.
-\wxheading{See also}
+\membersection{::wxRemoveFile}\label{wxremovefile}
-\helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}
+\func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
-\membersection{::wxVsnprintf}\label{wxvsnprintf}
+Removes {\it file}, returning TRUE if successful.
-\func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argptr}}
+\membersection{::wxRenameFile}\label{wxrenamefile}
-The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list}
-argument instead of arbitrary number of parameters.
+\func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
-\wxheading{See also}
+Renames {\it file1} to {\it file2}, returning TRUE if successful.
-\helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv}
+\membersection{::wxRmdir}\label{wxrmdir}
-\section{Dialog functions}\label{dialogfunctions}
+\func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
-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.
+Removes the directory {\it dir}, returning TRUE if successful. Does not work under VMS.
-\membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider}
+The {\it flags} parameter is reserved for future use.
-\func{wxTipProvider *}{wxCreateFileTipProvider}{\param{const wxString\& }{filename},
- \param{size\_t }{currentTip}}
+\membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory}
-This function creates a \helpref{wxTipProvider}{wxtipprovider} which may be
-used with \helpref{wxShowTip}{wxshowtip}.
+\func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
-\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.}
+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.
-\wxheading{See also}
+\membersection{::wxSplitPath}\label{wxsplitfunction}
-\helpref{Tips overview}{tipsoverview}
+\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
-\wxheading{Include files}
+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.
-<wx/tipdlg.h>
+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).
-\membersection{::wxDirSelector}\label{wxdirselector}
+On entry, {\it fullname} should be non-NULL (it may be empty though).
-\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}}
+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 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.
+\membersection{::wxTransferFileToStream}\label{wxtransferfiletostream}
-The application must check for an empty return value (if the user pressed
-Cancel). For example:
+\func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}}
-\begin{verbatim}
-const wxString& dir = wxDirSelector("Choose a folder");
-if ( !dir.empty() )
-{
- ...
-}
-\end{verbatim}
+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/dirdlg.h>
+<wx/docview.h>
-\membersection{::wxFileSelector}\label{wxfileselector}
+\membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
-\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{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
-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.
+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).
-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.
+\wxheading{Include files}
-The wildcard may be a specification for multiple types of file
-with a description for each, such as:
+<wx/docview.h>
-\begin{verbatim}
- "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
-\end{verbatim}
+\section{Network, user and OS functions}\label{networkfunctions}
-The application must check for an empty return value (the user pressed
-Cancel). For example:
+The functions in this section are used to retrieve information about the
+current computer and/or user characteristics.
-\begin{verbatim}
-const wxString& s = wxFileSelector("Choose a file to open");
-if (s)
-{
- ...
-}
-\end{verbatim}
+\membersection{::wxGetFreeMemory}\label{wxgetfreememory}
-\wxheading{Include files}
+\func{long}{wxGetFreeMemory}{\void}
-<wx/filedlg.h>
+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.
-\membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
+\wxheading{Include files}
-\func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
+<wx/utils.h>
-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.
+\membersection{::wxGetFullHostName}\label{wxgetfullhostname}
-\wxheading{Parameters}
+\func{wxString}{wxGetFullHostName}{\void}
-\docparam{parent}{The parent window for the colour selection dialog}
+Returns the FQDN (fully qualified domain host name) or an empty string on
+error.
-\docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
+\wxheading{See also}
+
+\helpref{wxGetHostName}{wxgethostname}
\wxheading{Include files}
-<wx/colordlg.h>
+<wx/utils.h>
-\membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
+\membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
-\func{size\_t}{wxGetMultipleChoices}{\\
- \param{wxArrayInt\& }{selections},\\
- \param{const wxString\& }{message},\\
- \param{const wxString\& }{caption},\\
- \param{const wxArrayString\& }{aChoices},\\
- \param{wxWindow *}{parent = NULL},\\
- \param{int}{ x = -1}, \param{int}{ y = -1},\\
- \param{bool}{ centre = TRUE},\\
- \param{int }{width=150}, \param{int }{height=200}}
+\func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
-\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}}
+Copies the user's email address into the supplied buffer, by
+concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
+and \helpref{wxGetUserId}{wxgetuserid}.
-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.
+Returns TRUE if successful, FALSE otherwise.
-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}.
+\wxheading{Include files}
-If {\it centre} is TRUE, the message text (which may include new line
-characters) is centred; if FALSE, the message is left-justified.
+<wx/utils.h>
-\wxheading{Include files}
+\membersection{::wxGetHomeDir}\label{wxgethomedir}
-<wx/choicdlg.h>
+\func{wxString}{wxGetHomeDir}{\void}
-\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.}
+Return the (current) user's home directory.
-\membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
+\wxheading{See also}
-\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}}
+\helpref{wxGetUserHome}{wxgetuserhome}
-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.
+\wxheading{Include files}
-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.
+<wx/utils.h>
-Dialog is centered on its {\it parent} unless an explicit position is given in
-{\it pos}.
+\membersection{::wxGetHostName}\label{wxgethostname}
-\wxheading{Include files}
+\func{wxString}{wxGetHostName}{\void}
-<wx/textdlg.h>
+\func{bool}{wxGetHostName}{\param{char * }{buf}, \param{int }{sz}}
-\membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
+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{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
- \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL}}
+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.
-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 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/textdlg.h>
+<wx/utils.h>
-\membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
+\membersection{::wxGetUserId}\label{wxgetuserid}
-\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}{wxGetUserId}{\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.
+\func{bool}{wxGetUserId}{\param{char * }{buf}, \param{int }{sz}}
-If {\it centre} is TRUE, the message text (which may include new line characters)
-is centred; if FALSE, the message is left-justified.
+This function returns the "user id" also known as "login name" under Unix i.e.
+something like "jsmith". It uniquely identifies the current user (on this system).
-\wxheading{Include files}
+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.
-<wx/textdlg.h>
+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.
-\membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
+\wxheading{See also}
-\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}}
+\helpref{wxGetUserName}{wxgetusername}
-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.
+\wxheading{Include files}
-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.
+<wx/utils.h>
-If Cancel is pressed, -1 is returned.
+\membersection{::wxGetOsDescription}\label{wxgetosdescription}
-{\it choices} is an array of {\it n} strings for the listbox.
+\func{wxString}{wxGetOsDescription}{\void}
-If {\it centre} is TRUE, the message text (which may include new line characters)
-is centred; if FALSE, the message is left-justified.
+Returns the string containing the description of the current platform in a
+user-readable form. For example, this function may return strings like
+{\tt Windows NT Version 4.0} or {\tt Linux 2.2.2 i386}.
+
+\wxheading{See also}
+
+\helpref{::wxGetOsVersion}{wxgetosversion}
\wxheading{Include files}
-<wx/choicdlg.h>
+<wx/utils.h>
-\membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
+\membersection{::wxGetOsVersion}\label{wxgetosversion}
-\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{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
-\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}}
+Gets operating system version information.
-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.
+\begin{twocollist}\itemsep=0pt
+\twocolitemruled{Platform}{Return types}
+\twocolitem{Mac OS}{Return value is wxMAC when compiled with CodeWarrior under Mac OS 8.x/9.x and Mac OS X, wxMAC\_DARWIN when compiled with the Apple Developer Tools under Mac OS X.}
+\twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }
+\twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
+\twocolitem{OS/2}{Return value is wxOS2\_PM.}
+\twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
+\twocolitem{Windows NT/2000}{Return value is wxWINDOWS\_NT, version is returned in {\it major} and {\it minor}}
+\twocolitem{Windows 98}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 1 or greater.}
+\twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 0.}
+\twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
+\twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
+\end{twocollist}
-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}.
+\wxheading{See also}
-If {\it centre} is TRUE, the message text (which may include new line
-characters) is centred; if FALSE, the message is left-justified.
+\helpref{::wxGetOsDescription}{wxgetosdescription}
\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{::wxGetUserHome}\label{wxgetuserhome}
-\membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
+\func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
-\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}}
+Returns the home directory for the given user. If the username is empty
+(default value), this function behaves like
+\helpref{wxGetHomeDir}{wxgethomedir}.
-\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}}
+\wxheading{Include files}
-As {\bf wxGetSingleChoice} but returns the index representing the selected
-string. If the user pressed cancel, -1 is returned.
+<wx/utils.h>
-\wxheading{Include files}
+\membersection{::wxGetUserName}\label{wxgetusername}
-<wx/choicdlg.h>
+\func{wxString}{wxGetUserName}{\void}
-\perlnote{In wxPerl there is just an array reference in place of {\tt n}
-and {\tt choices}.}
+\func{bool}{wxGetUserName}{\param{char * }{buf}, \param{int }{sz}}
-\membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
+This function returns the full user name (something like "Mr. John Smith").
-\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}}
+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.
-\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}}
+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.
-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}!
+\wxheading{See also}
+
+\helpref{wxGetUserId}{wxgetuserid}
\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}, and the client data array must have the
-same length as the choices array.}
+\section{String functions}
-\membersection{::wxMessageBox}\label{wxmessagebox}
+\membersection{::copystring}\label{copystring}
-\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{char *}{copystring}{\param{const char *}{s}}
-General purpose message dialog. {\it style} may be a bit list of the
-following identifiers:
+Makes a copy of the string {\it s} using the C++ new operator, so it can be
+deleted with the {\it delete} operator.
-\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}
+This function is deprecated, use \helpref{wxString}{wxstring} class instead.
-The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
+\membersection{::wxIsEmpty}\label{wxisempty}
-For example:
+\func{bool}{wxIsEmpty}{\param{const char *}{ p}}
+
+Returns {\tt TRUE} if the pointer is either {\tt NULL} or points to an empty
+string, {\tt FALSE} otherwise.
+
+\membersection{::wxStricmp}\label{wxstricmp}
+
+\func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}}
+
+Returns a negative value, 0, or positive value if {\it p1} is less than, equal
+to or greater than {\it p2}. The comparison is case-insensitive.
+
+This function complements the standard C function {\it strcmp()} which performs
+case-sensitive comparison.
+
+\membersection{::wxStringMatch}\label{wxstringmatch}
+
+\func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\
+ \param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}}
+
+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.
+
+This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
+
+\membersection{::wxStringEq}\label{wxstringeq}
+
+\func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}}
+
+A macro defined as:
\begin{verbatim}
- ...
- int answer = wxMessageBox("Quit program?", "Confirm",
- wxYES_NO | wxCANCEL, main_frame);
- if (answer == wxYES)
- delete main_frame;
- ...
+#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
\end{verbatim}
-{\it message} may contain newline characters, in which case the
-message will be split into separate lines, to cater for large messages.
+This function is obsolete, use \helpref{wxString}{wxstring} instead.
+
+\membersection{::wxStrlen}\label{wxstrlen}
+
+\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.
+
+\membersection{::wxGetTranslation}\label{wxgettranslation}
+
+\func{const char *}{wxGetTranslation}{\param{const char * }{str}}
+
+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().
+
+\membersection{::wxSnprintf}\label{wxsnprintf}
+
+\func{int}{wxSnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{}{...}}
+
+This function replaces the dangerous standard function {\tt sprintf()} and is
+like {\tt snprintf()} available on some platforms. The only difference with
+sprintf() is that an additional argument - buffer size - is taken and the
+buffer is never overflowed.
+
+Returns the number of characters copied to the buffer or -1 if there is not
+enough space.
+
+\wxheading{See also}
+
+\helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}
+
+\membersection{::wxToLower}\label{wxtolower}
+
+\func{char}{wxToLower}{\param{char }{ch}}
+
+Converts the character to lower case. This is implemented as a macro for efficiency.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxToUpper}\label{wxtoupper}
-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.
+\func{char}{wxToUpper}{\param{char }{ch}}
+
+Converts the character to upper case. This is implemented as a macro for efficiency.
\wxheading{Include files}
-<wx/msgdlg.h>
+<wx/utils.h>
-\membersection{::wxShowTip}\label{wxshowtip}
+\membersection{::wxVsnprintf}\label{wxvsnprintf}
-\func{bool}{wxShowTip}{\param{wxWindow *}{parent},
- \param{wxTipProvider *}{tipProvider},
- \param{bool }{showAtStartup = TRUE}}
+\func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}}
-This function shows a "startup tip" to the user.
+The same as \helpref{wxSnprintf}{wxsnprintf} but takes a {\tt va\_list }
+argument instead of arbitrary number of parameters.
-\docparam{parent}{The parent window for the modal dialog}
+\wxheading{See also}
-\docparam{tipProvider}{An object which is used to get the text of the tips.
-It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
+\helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv}
-\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.}
+\section{Dialog functions}\label{dialogfunctions}
-\wxheading{See also}
+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.
-\helpref{Tips overview}{tipsoverview}
+\membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
+
+\func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
+
+Changes the cursor to the given cursor for all windows in the application.
+Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
+to its previous state. These two calls can be nested, and a counter
+ensures that only the outer calls take effect.
+
+See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
\wxheading{Include files}
-<wx/tipdlg.h>
+<wx/utils.h>
-\section{GDI functions}\label{gdifunctions}
+\membersection{::wxBell}\label{wxbell}
-The following are relevant to the GDI (Graphics Device Interface).
+\func{void}{wxBell}{\void}
+
+Ring the system bell.
\wxheading{Include files}
-<wx/gdicmn.h>
+<wx/utils.h>
-\membersection{::wxClientDisplayRect}
+\membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider}
-\func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
-\param{int *}{width}, \param{int *}{height}}
+\func{wxTipProvider *}{wxCreateFileTipProvider}{\param{const wxString\& }{filename},
+ \param{size\_t }{currentTip}}
-\func{wxRect}{wxGetClientDisplayRect}{\void}
+This function creates a \helpref{wxTipProvider}{wxtipprovider} which may be
+used with \helpref{wxShowTip}{wxshowtip}.
-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.
+\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{::wxColourDisplay}
+\wxheading{See also}
-\func{bool}{wxColourDisplay}{\void}
+\helpref{Tips overview}{tipsoverview}
-Returns TRUE if the display is colour, FALSE otherwise.
+\wxheading{Include files}
-\membersection{::wxDisplayDepth}
+<wx/tipdlg.h>
-\func{int}{wxDisplayDepth}{\void}
+\membersection{::wxDirSelector}\label{wxdirselector}
-Returns the depth of the display (a value of 1 denotes a monochrome display).
+\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{::wxDisplaySize}
+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}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
+The application must check for an empty return value (if the user pressed
+Cancel). For example:
-\func{wxSize}{wxGetDisplaySize}{\void}
+\begin{verbatim}
+const wxString& dir = wxDirSelector("Choose a folder");
+if ( !dir.empty() )
+{
+ ...
+}
+\end{verbatim}
-Returns the display size in pixels.
+\wxheading{Include files}
-\membersection{::wxDisplaySizeMM}
+<wx/dirdlg.h>
-\func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
+\membersection{::wxFileSelector}\label{wxfileselector}
-\func{wxSize}{wxGetDisplaySizeMM}{\void}
+\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}}
-Returns the display size in millimeters.
+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.
-\membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
+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.
-\func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
- \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
+The wildcard may be a specification for multiple types of file
+with a description for each, such as:
-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.
+\begin{verbatim}
+ "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
+\end{verbatim}
-In addition to adding the placeable metafile header, this function adds
-the equivalent of the following code to the start of the metafile data:
+The application must check for an empty return value (the user pressed
+Cancel). For example:
\begin{verbatim}
- SetMapMode(dc, MM_ANISOTROPIC);
- SetWindowOrg(dc, minX, minY);
- SetWindowExt(dc, maxX - minX, maxY - minY);
+const wxString& s = wxFileSelector("Choose a file to open");
+if (s)
+{
+ ...
+}
\end{verbatim}
-This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes.
+\wxheading{Include files}
-Placeable metafiles may be imported by many Windows applications, and can be
-used in RTF (Rich Text Format) files.
+<wx/filedlg.h>
-{\it scale} allows the specification of scale for the metafile.
+\membersection{::wxEndBusyCursor}\label{wxendbusycursor}
-This function is only available under Windows.
+\func{void}{wxEndBusyCursor}{\void}
-\membersection{::wxSetCursor}\label{wxsetcursor}
+Changes the cursor back to the original cursor, for all windows in the application.
+Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
-\func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
+See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
-Globally sets the cursor; only has an effect in Windows and GTK.
-See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
+\wxheading{Include files}
-\section{Printer settings}\label{printersettings}
+<wx/utils.h>
-These routines are obsolete and should no longer be used!
+\membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
-The following functions are used to control PostScript printing. Under
-Windows, PostScript output can only be sent to a file.
+\func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
+
+Shows the colour selection dialog and returns the colour selected by user or
+invalid colour (use \helpref{wxColour::Ok}{wxcolourok} to test whether a colour
+is valid) if the dialog was cancelled.
+
+\wxheading{Parameters}
+
+\docparam{parent}{The parent window for the colour selection dialog}
+
+\docparam{colInit}{If given, this will be the colour initially selected in the dialog.}
\wxheading{Include files}
-<wx/dcps.h>
+<wx/colordlg.h>
-\membersection{::wxGetPrinterCommand}
+\membersection{::wxGetFontFromUser}\label{wxgetfontfromuser}
-\func{wxString}{wxGetPrinterCommand}{\void}
+\func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}}
-Gets the printer command used to print a file. The default is {\tt lpr}.
+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.
-\membersection{::wxGetPrinterFile}
+\wxheading{Parameters}
-\func{wxString}{wxGetPrinterFile}{\void}
+\docparam{parent}{The parent window for the font selection dialog}
-Gets the PostScript output filename.
+\docparam{fontInit}{If given, this will be the font initially selected in the dialog.}
-\membersection{::wxGetPrinterMode}
+\wxheading{Include files}
-\func{int}{wxGetPrinterMode}{\void}
+<wx/fontdlg.h>
-Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
-The default is PS\_PREVIEW.
-\membersection{::wxGetPrinterOptions}
+\membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
-\func{wxString}{wxGetPrinterOptions}{\void}
+\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}}
-Gets the additional options for the print command (e.g. specific printer). The default is nothing.
+\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}}
-\membersection{::wxGetPrinterOrientation}
+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.
-\func{int}{wxGetPrinterOrientation}{\void}
+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}.
-Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
+If {\it centre} is TRUE, the message text (which may include new line
+characters) is centred; if FALSE, the message is left-justified.
-\membersection{::wxGetPrinterPreviewCommand}
+\wxheading{Include files}
-\func{wxString}{wxGetPrinterPreviewCommand}{\void}
+<wx/choicdlg.h>
-Gets the command used to view a PostScript file. The default depends on the platform.
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}, and no {\tt selections} parameter; the function
+returns an array containing the user selections.}
-\membersection{::wxGetPrinterScaling}
+\membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
-\func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
+\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}}
-Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
+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.
-\membersection{::wxGetPrinterTranslation}
+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.
-\func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}}
+Dialog is centered on its {\it parent} unless an explicit position is given in
+{\it pos}.
-Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
+\wxheading{Include files}
-\membersection{::wxSetPrinterCommand}
+<wx/textdlg.h>
-\func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
+\membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
+
+\func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
+ \param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL}}
-Sets the printer command used to print a file. The default is {\tt lpr}.
+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.
-\membersection{::wxSetPrinterFile}
+\wxheading{Include files}
-\func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
+<wx/textdlg.h>
-Sets the PostScript output filename.
+\membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
-\membersection{::wxSetPrinterMode}
+\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{void}{wxSetPrinterMode}{\param{int }{mode}}
+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.
-Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
-The default is PS\_PREVIEW.
+If {\it centre} is TRUE, the message text (which may include new line characters)
+is centred; if FALSE, the message is left-justified.
-\membersection{::wxSetPrinterOptions}
+\wxheading{Include files}
-\func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
+<wx/textdlg.h>
-Sets the additional options for the print command (e.g. specific printer). The default is nothing.
+\membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
-\membersection{::wxSetPrinterOrientation}
+\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{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
+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.
-Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
+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.
-\membersection{::wxSetPrinterPreviewCommand}
+If Cancel is pressed, -1 is returned.
-\func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
+{\it choices} is an array of {\it n} strings for the listbox.
-Sets the command used to view a PostScript file. The default depends on the platform.
+If {\it centre} is TRUE, the message text (which may include new line characters)
+is centred; if FALSE, the message is left-justified.
-\membersection{::wxSetPrinterScaling}
+\wxheading{Include files}
-\func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
+<wx/choicdlg.h>
-Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
+\membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
-\membersection{::wxSetPrinterTranslation}
+\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{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
+\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}}
-Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
+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.
-\section{Clipboard functions}\label{clipsboard}
+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}.
-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.
+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/clipbrd.h>
+<wx/choicdlg.h>
-\membersection{::wxClipboardOpen}
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
-\func{bool}{wxClipboardOpen}{\void}
+\membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
-Returns TRUE if this application has already opened the clipboard.
+\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}}
-\membersection{::wxCloseClipboard}
+\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}}
-\func{bool}{wxCloseClipboard}{\void}
+As {\bf wxGetSingleChoice} but returns the index representing the selected
+string. If the user pressed cancel, -1 is returned.
-Closes the clipboard to allow other applications to use it.
+\wxheading{Include files}
-\membersection{::wxEmptyClipboard}
+<wx/choicdlg.h>
-\func{bool}{wxEmptyClipboard}{\void}
+\perlnote{In wxPerl there is just an array reference in place of {\tt n}
+and {\tt choices}.}
-Empties the clipboard.
+\membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
-\membersection{::wxEnumClipboardFormats}
+\func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
+ \param{const wxString\& }{caption},\\
+ \param{const wxArrayString\& }{aChoices},\\
+ \param{const wxString\& }{client\_data[]},\\
+ \param{wxWindow *}{parent = NULL},\\
+ \param{int}{ x = -1}, \param{int}{ y = -1},\\
+ \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
-\func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
+\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}}
-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.
+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}!
-{\it dataFormat} specifies a known format. If this parameter is zero,
-the function returns the first format in the list.
+\wxheading{Include files}
-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.
+<wx/choicdlg.h>
-Before it enumerates the formats function, an application must open the clipboard by using the
-wxOpenClipboard function.
+\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{::wxGetClipboardData}
+\membersection{::wxIsBusy}\label{wxisbusy}
-\func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
+\func{bool}{wxIsBusy}{\void}
-Gets data from the clipboard.
+Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
+\helpref{wxEndBusyCursor}{wxendbusycursor} calls.
-{\it dataFormat} may be one of:
+See also \helpref{wxBusyCursor}{wxbusycursor}.
-\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}
+\wxheading{Include files}
-The clipboard must have previously been opened for this call to succeed.
+<wx/utils.h>
-\membersection{::wxGetClipboardFormatName}
+\membersection{::wxMessageBox}\label{wxmessagebox}
-\func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
+\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}}
-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.
+General purpose message dialog. {\it style} may be a bit list of the
+following identifiers:
-\membersection{::wxIsClipboardFormatAvailable}
+\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}
-\func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
+The return value is one of: wxYES, wxNO, wxCANCEL, wxOK.
-Returns TRUE if the given data format is available on the clipboard.
+For example:
-\membersection{::wxOpenClipboard}
+\begin{verbatim}
+ ...
+ int answer = wxMessageBox("Quit program?", "Confirm",
+ wxYES_NO | wxCANCEL, main_frame);
+ if (answer == wxYES)
+ delete main_frame;
+ ...
+\end{verbatim}
-\func{bool}{wxOpenClipboard}{\void}
+{\it message} may contain newline characters, in which case the
+message will be split into separate lines, to cater for large messages.
-Opens the clipboard for passing data to it or getting data from it.
+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{::wxRegisterClipboardFormat}
+\wxheading{Include files}
-\func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
+<wx/msgdlg.h>
-Registers the clipboard data format name and returns an identifier.
+\membersection{::wxShowTip}\label{wxshowtip}
-\membersection{::wxSetClipboardData}
+\func{bool}{wxShowTip}{\param{wxWindow *}{parent},
+ \param{wxTipProvider *}{tipProvider},
+ \param{bool }{showAtStartup = TRUE}}
-\func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
+This function shows a "startup tip" to the user.
-Passes data to the clipboard.
+\docparam{parent}{The parent window for the modal dialog}
-{\it dataFormat} may be one of:
+\docparam{tipProvider}{An object which is used to get the text of the tips.
+It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
-\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}
+\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 clipboard must have previously been opened for this call to succeed.
+\wxheading{See also}
-\section{Miscellaneous functions}\label{miscellany}
+\helpref{Tips overview}{tipsoverview}
-\membersection{::wxDROP\_ICON}\label{wxdropicon}
+\wxheading{Include files}
-\func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
+<wx/tipdlg.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.
+\section{GDI functions}\label{gdifunctions}
-This macro should be used with
-\helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
+The following are relevant to the GDI (Graphics Device Interface).
\wxheading{Include files}
-<wx/dnd.h>
+<wx/gdicmn.h>
-\membersection{::wxNewId}
+\membersection{wxBITMAP}\label{wxbitmapmacro}
-\func{long}{wxNewId}{\void}
+\func{}{wxBITMAP}{bitmapName}
-Generates an integer identifier unique to this run of the program.
+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{Include files}
+\wxheading{See also}
-<wx/utils.h>
+\helpref{Bitmaps and icons overview}{wxbitmapoverview},
+\helpref{wxICON}{wxiconmacro}
+
+\wxheading{Include files}
-\membersection{::wxRegisterId}
+<wx/gdicmn.h>
-\func{void}{wxRegisterId}{\param{long}{ id}}
+\membersection{::wxClientDisplayRect}\label{wxclientdisplayrect}
-Ensures that ids subsequently generated by {\bf NewId} do not clash with
-the given {\bf id}.
+\func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
+\param{int *}{width}, \param{int *}{height}}
-\wxheading{Include files}
+\func{wxRect}{wxGetClientDisplayRect}{\void}
-<wx/utils.h>
+Returns the dimensions of the work area on the display. On Windows
+this means the area not covered by the taskbar, etc. Other platforms
+are currently defaulting to the whole display until a way is found to
+provide this info for all window managers, etc.
-\membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
+\membersection{::wxColourDisplay}\label{wxcolourdisplay}
-\func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
+\func{bool}{wxColourDisplay}{\void}
-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.
+Returns TRUE if the display is colour, FALSE otherwise.
-See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
+\membersection{::wxDisplayDepth}\label{wxdisplaydepth}
-\wxheading{Include files}
+\func{int}{wxDisplayDepth}{\void}
-<wx/utils.h>
+Returns the depth of the display (a value of 1 denotes a monochrome display).
-\membersection{::wxBell}
+\membersection{::wxDisplaySize}\label{wxdisplaysize}
-\func{void}{wxBell}{\void}
+\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
-Ring the system bell.
+\func{wxSize}{wxGetDisplaySize}{\void}
-\wxheading{Include files}
+Returns the display size in pixels.
-<wx/utils.h>
+\membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}
-\membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
+\func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
-\func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
+\func{wxSize}{wxGetDisplaySizeMM}{\void}
-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.
+Returns the display size in millimeters.
-\membersection{::wxDDECleanUp}\label{wxddecleanup}
+\membersection{::wxDROP\_ICON}\label{wxdropicon}
-\func{void}{wxDDECleanUp}{\void}
+\func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
-Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
-called by the application.
+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.
-See also \helpref{wxDDEInitialize}{wxddeinitialize}.
+This macro should be used with
+\helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
\wxheading{Include files}
-<wx/dde.h>
+<wx/dnd.h>
-\membersection{::wxDDEInitialize}\label{wxddeinitialize}
+\membersection{wxICON}\label{wxiconmacro}
-\func{void}{wxDDEInitialize}{\void}
+\func{}{wxICON}{iconName}
-Initializes the DDE system. May be called multiple times without harm.
+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.
-This no longer needs to be called by the application: it will be called
-by wxWindows if necessary.
+\wxheading{See also}
-See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
-\helpref{wxDDECleanUp}{wxddecleanup}.
+\helpref{Bitmaps and icons overview}{wxbitmapoverview},
+\helpref{wxBITMAP}{wxbitmapmacro}
\wxheading{Include files}
-<wx/dde.h>
-
-\membersection{::wxDebugMsg}\label{wxdebugmsg}
-
-\func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
+<wx/gdicmn.h>
-{\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogdebug} instead!}
+\membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
-Display a debugging message; under Windows, this will appear on the
-debugger command window, and under Unix, it will be written to standard
-error.
+\func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
+ \param{int }{maxX}, \param{int }{maxY}, \param{float }{scale=1.0}}
-The syntax is identical to {\bf printf}: pass a format string and a
-variable list of arguments.
+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.
-{\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.
+In addition to adding the placeable metafile header, this function adds
+the equivalent of the following code to the start of the metafile data:
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+\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{::wxDisplaySize}
+{\it scale} allows the specification of scale for the metafile.
-\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
+This function is only available under Windows.
-Gets the physical size of the display in pixels.
+\membersection{::wxSetCursor}\label{wxsetcursor}
-\wxheading{Include files}
+\func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
-<wx/gdicmn.h>
+Globally sets the cursor; only has an effect in Windows and GTK.
+See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}.
-\membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
+\section{Printer settings}\label{printersettings}
-\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
+These routines are obsolete and should no longer be used!
-This function enables or disables all top level windows. It is used by
-\helpref{::wxSafeYield}{wxsafeyield}.
+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>
-
-\membersection{::wxEntry}\label{wxentry}
+<wx/dcps.h>
-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.
+\membersection{::wxGetPrinterCommand}\label{wxgetprintercommand}
-\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
- \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
+\func{wxString}{wxGetPrinterCommand}{\void}
-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.
+Gets the printer command used to print a file. The default is {\tt lpr}.
-\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
- \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
+\membersection{::wxGetPrinterFile}\label{wxgetprinterfile}
-wxWindows initialization under Windows (for applications constructed as a DLL).
+\func{wxString}{wxGetPrinterFile}{\void}
-\func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
+Gets the PostScript output filename.
-wxWindows initialization under Unix.
+\membersection{::wxGetPrinterMode}\label{wxgetprintermode}
-\wxheading{Remarks}
+\func{int}{wxGetPrinterMode}{\void}
-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:
+Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
+The default is PS\_PREVIEW.
-\begin{verbatim}
-int CTheApp::ExitInstance()
-{
- // OnExit isn't called by CleanUp so must be called explicitly.
- wxTheApp->OnExit();
- wxApp::CleanUp();
+\membersection{::wxGetPrinterOptions}\label{wxgetprinteroptions}
- return CWinApp::ExitInstance();
-}
-\end{verbatim}
+\func{wxString}{wxGetPrinterOptions}{\void}
-\wxheading{Include files}
+Gets the additional options for the print command (e.g. specific printer). The default is nothing.
-<wx/app.h>
+\membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation}
-\membersection{::wxEndBusyCursor}\label{wxendbusycursor}
+\func{int}{wxGetPrinterOrientation}{\void}
-\func{void}{wxEndBusyCursor}{\void}
+Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
-Changes the cursor back to the original cursor, for all windows in the application.
-Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}.
+\membersection{::wxGetPrinterPreviewCommand}\label{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}\label{wxgetprinterscaling}
-\membersection{::wxError}\label{wxerror}
+\func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}}
-\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
+Gets the scaling factor for PostScript output. The default is 1.0, 1.0.
-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{::wxGetPrinterTranslation}\label{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{::wxExecute}\label{wxexecute}
+\membersection{::wxSetPrinterCommand}\label{wxsetprintercommand}
-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
+\func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}}
-\func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
+Sets the printer command used to print a file. The default is {\tt lpr}.
-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
+\membersection{::wxSetPrinterFile}\label{wxsetprinterfile}
-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}}
+\func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}}
-Executes another program in Unix or Windows.
+Sets the PostScript output filename.
-The first form takes a command string, such as {\tt "emacs file.txt"}.
+\membersection{::wxSetPrinterMode}\label{wxsetprintermode}
-The second form takes an array of values: a command, any number of
-arguments, terminated by NULL.
+\func{void}{wxSetPrinterMode}{\param{int }{mode}}
-The semantics of the third and fourth versions is different from the first two
-and is described in more details below.
+Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER).
+The default is PS\_PREVIEW.
-If {\it sync} is FALSE (the default), flow of control immediately returns.
-If TRUE, the current application waits until the other program has terminated.
+\membersection{::wxSetPrinterOptions}\label{wxsetprinteroptions}
-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}.
+\func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}}
-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.
+Sets the additional options for the print command (e.g. specific printer). The default is nothing.
-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.
+\membersection{::wxSetPrinterOrientation}\label{wxsetprinterorientation}
-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.
+\func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}}
-See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
-\helpref{Exec sample}{sampleexec}.
+Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
-\wxheading{Include files}
+\membersection{::wxSetPrinterPreviewCommand}\label{wxsetprinterpreviewcommand}
-<wx/utils.h>
+\func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
-\membersection{::wxExit}\label{wxexit}
+Sets the command used to view a PostScript file. The default depends on the platform.
-\func{void}{wxExit}{\void}
+\membersection{::wxSetPrinterScaling}\label{wxsetprinterscaling}
-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}.
+\func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
-\wxheading{Include files}
+Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
-<wx/app.h>
+\membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation}
-\membersection{::wxFatalError}\label{wxfatalerror}
+\func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
-\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
+Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
-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}.
+\section{Clipboard functions}\label{clipsboard}
+
+These clipboard functions are implemented for Windows only. The use of these functions
+is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
+class instead.
\wxheading{Include files}
-<wx/utils.h>
+<wx/clipbrd.h>
-\membersection{::wxFindMenuItemId}
+\membersection{::wxClipboardOpen}\label{wxclipboardopen}
-\func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
+\func{bool}{wxClipboardOpen}{\void}
-Find a menu item identifier associated with the given frame's menu bar.
+Returns TRUE if this application has already opened the clipboard.
-\wxheading{Include files}
+\membersection{::wxCloseClipboard}\label{wxcloseclipboard}
-<wx/utils.h>
+\func{bool}{wxCloseClipboard}{\void}
-\membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
+Closes the clipboard to allow other applications to use it.
-\func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
+\membersection{::wxEmptyClipboard}\label{wxemptyclipboard}
-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{bool}{wxEmptyClipboard}{\void}
-\wxheading{Include files}
+Empties the clipboard.
-<wx/utils.h>
+\membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}
-\membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
+\func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
-\func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
+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.
-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.
+{\it dataFormat} specifies a known format. If this parameter is zero,
+the function returns the first format in the list.
-If no such named window is found, {\bf wxFindWindowByLabel} is called.
+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{Include files}
+Before it enumerates the formats function, an application must open the clipboard by using the
+wxOpenClipboard function.
-<wx/utils.h>
+\membersection{::wxGetClipboardData}\label{wxgetclipboarddata}
-\membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
+\func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
-\func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
+Gets data from the clipboard.
-Find the deepest window at the given mouse position in screen coordinates,
-returning the window if found, or NULL if not.
+{\it dataFormat} may be one of:
-\membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
+\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}
-\func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
+The clipboard must have previously been opened for this call to succeed.
-Find the deepest window at the mouse pointer position, returning the window
-and current pointer position in screen coordinates.
+\membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}
-\membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
+\func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
-\func{wxWindow *}{wxGetActiveWindow}{\void}
+Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
+length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
-Gets the currently active window (Windows only).
+\membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
-\wxheading{Include files}
+\func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
-<wx/windows.h>
+Returns TRUE if the given data format is available on the clipboard.
-\membersection{::wxGetDisplayName}\label{wxgetdisplayname}
+\membersection{::wxOpenClipboard}\label{wxopenclipboard}
-\func{wxString}{wxGetDisplayName}{\void}
+\func{bool}{wxOpenClipboard}{\void}
-Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
+Opens the clipboard for passing data to it or getting data from it.
-\wxheading{Include files}
+\membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat}
-<wx/utils.h>
+\func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
-\membersection{::wxGetHomeDir}\label{wxgethomedir}
+Registers the clipboard data format name and returns an identifier.
-\func{wxString}{wxGetHomeDir}{\void}
+\membersection{::wxSetClipboardData}\label{wxsetclipboarddata}
-Return the (current) user's home directory.
+\func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
-\wxheading{See also}
+Passes data to the clipboard.
-\helpref{wxGetUserHome}{wxgetuserhome}
+{\it dataFormat} may be one of:
-\wxheading{Include files}
+\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}
-<wx/utils.h>
+The clipboard must have previously been opened for this call to succeed.
-\membersection{::wxGetFreeMemory}\label{wxgetfreememory}
+\section{Miscellaneous functions}\label{miscellany}
-\func{long}{wxGetFreeMemory}{\void}
+\membersection{::wxNewId}\label{wxnewid}
-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.
+\func{long}{wxNewId}{\void}
+
+Generates an integer identifier unique to this run of the program.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxGetMousePosition}\label{wxgetmouseposition}
+\membersection{::wxRegisterId}\label{wxregisterid}
-\func{wxPoint}{wxGetMousePosition}{\void}
+\func{void}{wxRegisterId}{\param{long}{ id}}
-Returns the mouse position in screen coordinates.
+Ensures that ids subsequently generated by {\bf NewId} do not clash with
+the given {\bf id}.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxGetOsDescription}\label{wxgetosdescription}
-
-\func{wxString}{wxGetOsDescription}{\void}
+\membersection{::wxDDECleanUp}\label{wxddecleanup}
-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{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{::wxGetOsVersion}{wxgetosversion}
+See also \helpref{wxDDEInitialize}{wxddeinitialize}.
\wxheading{Include files}
-<wx/utils.h>
-
-\membersection{::wxGetOsVersion}\label{wxgetosversion}
+<wx/dde.h>
-\func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
+\membersection{::wxDDEInitialize}\label{wxddeinitialize}
-Gets operating system version information.
+\func{void}{wxDDEInitialize}{\void}
-\begin{twocollist}\itemsep=0pt
-\twocolitemruled{Platform}{Return types}
-\twocolitem{Mac OS}{Return value is wxMAC when compiled with CodeWarrior under Mac OS 8.x/9.x and Mac OS X, wxMAC\_DARWIN when compiled with the Apple Developer Tools under Mac OS X.}
-\twocolitem{GTK}{Return value is wxGTK, For GTK 1.0, {\it major} is 1, {\it minor} is 0. }
-\twocolitem{Motif}{Return value is wxMOTIF\_X, {\it major} is X version, {\it minor} is X revision.}
-\twocolitem{OS/2}{Return value is wxOS2\_PM.}
-\twocolitem{Windows 3.1}{Return value is wxWINDOWS, {\it major} is 3, {\it minor} is 1.}
-\twocolitem{Windows NT/2000}{Return value is wxWINDOWS\_NT, version is returned in {\it major} and {\it minor}}
-\twocolitem{Windows 98}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 1 or greater.}
-\twocolitem{Windows 95}{Return value is wxWIN95, {\it major} is 4, {\it minor} is 0.}
-\twocolitem{Win32s (Windows 3.1)}{Return value is wxWIN32S, {\it major} is 3, {\it minor} is 1.}
-\twocolitem{Watcom C++ 386 supervisor mode (Windows 3.1)}{Return value is wxWIN386, {\it major} is 3, {\it minor} is 1.}
-\end{twocollist}
+Initializes the DDE system. May be called multiple times without harm.
-\wxheading{See also}
+This no longer needs to be called by the application: it will be called
+by wxWindows if necessary.
-\helpref{::wxGetOsDescription}{wxgetosdescription}
+See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
+\helpref{wxDDECleanUp}{wxddecleanup}.
\wxheading{Include files}
-<wx/utils.h>
-
-\membersection{::wxGetResource}\label{wxgetresource}
+<wx/dde.h>
-\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
+\membersection{::wxDisplaySize}\label{wxdisplaysize}
-\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{float *}{value}, \param{const wxString\& }{file = NULL}}
+\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
-\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{long *}{value}, \param{const wxString\& }{file = NULL}}
+Gets the physical size of the display in pixels.
-\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
- \param{int *}{value}, \param{const wxString\& }{file = NULL}}
+\wxheading{Include files}
-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.
+<wx/gdicmn.h>
-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.
+\membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
-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.
+\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
-See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
+This function enables or disables all top level windows. It is used by
+\helpref{::wxSafeYield}{wxsafeyield}.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxGetUserId}
+\membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}
-\func{bool}{wxGetUserId}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
+\func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
-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''.
+Find a menu item identifier associated with the given frame's menu bar.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxGetUserHome}\label{wxgetuserhome}
+\membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
-\func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
+\func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
-Returns the home directory for the given user. If the username is empty
-(default value), this function behaves like
-\helpref{wxGetHomeDir}{wxgethomedir}.
+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{::wxGetUserName}
+\membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
+
+\func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
-\func{bool}{wxGetUserName}{\param{const wxString\& }{buf}, \param{int}{ bufSize}}
+Find a window by its name (as given in a window constructor or {\bf Create} function call).
+If {\it parent} is NULL, the search will start from all top-level
+frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy.
+The search is recursive in both cases.
-Copies the user's name (such as ``Julian Smart'') into the buffer {\it
-buf}, of maximum size {\it bufSize}, returning TRUE if successful.
-Under Windows, this returns ``unknown''.
+If no such named window is found, {\bf wxFindWindowByLabel} is called.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxHandleFatalExceptions}\label{wxhandlefatalexceptions}
-
-\func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = TRUE}}
+\membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
-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.
+\func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
-\membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
+Find the deepest window at the given mouse position in screen coordinates,
+returning the window if found, or NULL if not.
-\func{void}{wxInitAllImageHandlers}{\void}
+\membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
-Initializes all available image handlers. For a list of available handlers,
-see \helpref{wxImage}{wximage}.
+\func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
-\wxheading{See also}
+Find the deepest window at the mouse pointer position, returning the window
+and current pointer position in screen coordinates.
-\helpref{wxImage}{wximage}, \helpref{wxImageHandler}{wximagehandler}
+\membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
-\wxheading{Include files}
+\func{wxWindow *}{wxGetActiveWindow}{\void}
-<wx/image.h>
+Gets the currently active window (Windows only).
-\membersection{::wxInitialize}\label{wxinitialize}
+\wxheading{Include files}
-\func{bool}{wxInitialize}{\void}
+<wx/windows.h>
-This function is used in wxBase only and only if you don't create
-\helpref{wxApp}{wxapp} object at all. In this case you must call it from your
-{\tt main()} function before calling any other wxWindows functions.
+\membersection{::wxGetDisplayName}\label{wxgetdisplayname}
-If the function returns {\tt FALSE} the initialization could not be performed,
-in this case the library cannot be used and
-\helpref{wxUninitialize}{wxuninitialize} shouldn't be called neither.
+\func{wxString}{wxGetDisplayName}{\void}
-This function may be called several times but
-\helpref{wxUninitialize}{wxuninitialize} must be called for each successful
-call to this function.
+Under X only, returns the current display name. See also \helpref{wxSetDisplayName}{wxsetdisplayname}.
\wxheading{Include files}
-<wx/app.h>
-
-\membersection{::wxIsBusy}\label{wxisbusy}
+<wx/utils.h>
-\func{bool}{wxIsBusy}{\void}
+\membersection{::wxGetMousePosition}\label{wxgetmouseposition}
-Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
-\helpref{wxEndBusyCursor}{wxendbusycursor} calls.
+\func{wxPoint}{wxGetMousePosition}{\void}
-See also \helpref{wxBusyCursor}{wxbusycursor}.
+Returns the mouse position in screen coordinates.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxKill}\label{wxkill}
+\membersection{::wxGetResource}\label{wxgetresource}
-\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}}
+\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
+ \param{const wxString\& *}{value}, \param{const wxString\& }{file = NULL}}
-Equivalent to the Unix kill function: send the given signal {\it sig} to the
-process with PID {\it pid}. The valud signal values are
+\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
+ \param{float *}{value}, \param{const wxString\& }{file = NULL}}
-\begin{verbatim}
-enum wxSignal
-{
- wxSIGNONE = 0, // verify if the process exists under Unix
- wxSIGHUP,
- wxSIGINT,
- wxSIGQUIT,
- wxSIGILL,
- wxSIGTRAP,
- wxSIGABRT,
- wxSIGEMT,
- wxSIGFPE,
- wxSIGKILL, // forcefully kill, dangerous!
- wxSIGBUS,
- wxSIGSEGV,
- wxSIGSYS,
- wxSIGPIPE,
- wxSIGALRM,
- wxSIGTERM // terminate the process gently
-};
-\end{verbatim}
+\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
+ \param{long *}{value}, \param{const wxString\& }{file = NULL}}
-{\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.
+\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
+ \param{int *}{value}, \param{const wxString\& }{file = NULL}}
-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:
+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.
-\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}
+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.
-\wxheading{See also}
+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.
-\helpref{wxProcess::Kill}{wxprocesskill},\rtfsp
-\helpref{wxProcess::Exists}{wxprocessexists},\rtfsp
-\helpref{Exec sample}{sampleexec}
+See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxconfigbase}.
\wxheading{Include files}
<wx/utils.h>
-\membersection{::wxNow}\label{wxnow}
-
-\func{wxString}{wxNow}{\void}
-
-Returns a string representing the current date and time.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
\membersection{::wxPostDelete}\label{wxpostdelete}
\func{void}{wxPostDelete}{\param{wxObject *}{object}}
<wx/app.h>
-\membersection{::wxSafeYield}\label{wxsafeyield}
-
-\func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
-
-This function is similar to wxYield, except that it disables the user input to
-all program windows before calling wxYield and re-enables it again
-afterwards. If {\it win} is not NULL, this window will remain enabled,
-allowing the implementation of some limited user interaction.
-
-Returns the result of the call to \helpref{::wxYield}{wxyield}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
\membersection{::wxSetDisplayName}\label{wxsetdisplayname}
\func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
<wx/utils.h>
-\membersection{::wxShell}\label{wxshell}
-
-\func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
-
-Executes a command in an interactive shell window. If no command is
-specified, then just the shell is spawned.
-
-See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxSleep}\label{wxsleep}
-
-\func{void}{wxSleep}{\param{int}{ secs}}
-
-Sleeps for the specified number of seconds.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxStripMenuCodes}
+\membersection{::wxStripMenuCodes}\label{wxstripmenucodes}
\func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
-\func{void}{wxStripMenuCodes}{\param{char* }{in}, \param{char* }{out}}
+\func{void}{wxStripMenuCodes}{\param{char *}{in}, \param{char *}{out}}
+
+This function is obsolete, please use
+\helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} instead.
Strips any menu codes from {\it in} and places the result
in {\it out} (or returns the new string, in the first form).
<wx/utils.h>
-\membersection{::wxToLower}\label{wxtolower}
-
-\func{char}{wxToLower}{\param{char }{ch}}
-
-Converts the character to lower case. This is implemented as a macro for efficiency.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxToUpper}\label{wxtoupper}
-
-\func{char}{wxToUpper}{\param{char }{ch}}
-
-Converts the character to upper case. This is implemented as a macro for efficiency.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxTrace}\label{wxtrace}
-
-\func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
-
-Takes printf-style variable argument syntax. Output
-is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
-
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
-\wxheading{Include files}
-
-<wx/memory.h>
-
-\membersection{::wxTraceLevel}\label{wxtracelevel}
-
-\func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
-
-Takes printf-style variable argument syntax. Output
-is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
-The first argument should be the level at which this information is appropriate.
-It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
-this value.
-
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
-\wxheading{Include files}
-
-<wx/memory.h>
-
-\membersection{::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>
-
-\membersection{::wxUninitialize}\label{wxuninitialize}
-
-\func{void}{wxUninitialize}{\void}
-
-This function is for use in console (wxBase) programs only. It must be called
-once for each previous successful call to \helpref{wxInitialize}{wxinitialize}.
-
-\wxheading{Include files}
-
-<wx/app.h>
-
-\membersection{::wxUsleep}\label{wxusleep}
-
-\func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
-
-Sleeps for the specified number of milliseconds. Notice that usage of this
-function is encouraged instead of calling usleep(3) directly because the
-standard usleep() function is not MT safe.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
\membersection{::wxWriteResource}\label{wxwriteresource}
\func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
<wx/utils.h>
-\membersection{::wxYield}\label{wxyield}
-
-\func{bool}{wxYield}{\void}
-
-Calls \helpref{wxApp::Yield}{wxappyield}.
-
-This function is kept only for backwards compatibility, please use the
-wxApp method instead in any new code.
-
-\wxheading{Include files}
-
-<wx/app.h> or <wx/utils.h>
-
-\membersection{::wxWakeUpIdle}\label{wxwakeupidle}
-
-\func{void}{wxWakeUpIdle}{\void}
-
-This functions wakes up the (internal and platform dependent) idle system, i.e. it
-will force the system to send an idle event even if the system currently {\it is}
- idle and thus would not send any idle event until after some other event would get
-sent. This is also useful for sending events between two threads and is used by
-the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and
-\helpref{wxEvtHandler::AddPendingEvent}{wxevthandleraddpendingevent}.
-
-\wxheading{Include files}
-
-<wx/app.h>
-
-\section{Macros}\label{macros}
+\section{Byte order macros}\label{macros}
-These macros are defined in wxWindows.
+The endian-ness issues (that is the difference between big-endian and
+little-endian architectures) are important for the portable programs working
+with the external binary data (for example, data files or data coming from
+network) which is usually in some fixed, platform-independent format. The
+macros are helpful for transforming the data to the correct format.
\membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways}
\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{macros}
+
+wxWindows uses its own RTTI ("run-time type identification") system which
+predates the current standard C++ RTTI and so is kept for backwards
+compatribility reasons but also because it allows some things which the
+standard RTTI doesn't directly support (such as creating a class from its
+name).
+
+The standard C++ RTTI can be used in the user code without any problems and in
+general you shouldn't need to use the functions and the macros in this section
+unless you are thinking of modifying or adding any wxWindows classes.
+
+\wxheading{See also}
+
+\helpref{RTTI overview}{runtimeclassoverview}
\membersection{CLASSINFO}\label{classinfo}
<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}
<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}
\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{Resource functions}\label{resourcefuncs}
-\section{wxWindows 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.
\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.
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 This function is deprecated, use \helpref{wxLogDebug}{wxlogdebug} instead!}
+
+Display a debugging message; under Windows, this will appear on the
+debugger command window, and under Unix, it will be written to standard
+error.
+
+The syntax is identical to {\bf printf}: pass a format string and a
+variable list of arguments.
+
+{\bf Tip:} under Windows, if your application crashes before the
+message appears in the debugging window, put a wxYield call after
+each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
+(at least for Watcom C++): preformat your messages and use OutputDebugString
+instead.
+
+This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxError}\label{wxerror}
+
+\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
+
+This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
+instead.
+
+Displays {\it msg} and continues. This writes to standard error under
+Unix, and pops up a message box under Windows. Used for internal
+wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+\membersection{::wxFatalError}\label{wxfatalerror}
+
+\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
+
+This function is now obsolete, please use
+\helpref{wxLogFatalError}{wxlogfatalerror} instead.
+
+Displays {\it msg} and exits. This writes to standard error under Unix,
+and pops up a message box under Windows. Used for fatal internal
+wxWindows errors. See also \helpref{wxError}{wxerror}.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
\membersection{::wxLogError}\label{wxlogerror}
-\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}{wxVLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{va\_list }{argPtr}}
+
+\func{void}{wxLogStatus}{\param{const char *}{formatString}, \param{...}{}}
-\func{void}{wxLogStatus}{\param{const char*}{ formatString}, \param{...}{}}
+\func{void}{wxVLogStatus}{\param{const char *}{formatString}, \param{va\_list }{argPtr}}
-Messages logged by this function will appear in the statusbar of the {\it
+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
\helpref{wxSysErrorCode}{wxsyserrorcode},
\helpref{wxLogSysError}{wxlogsyserror}
+\membersection{WXTRACE}\label{trace}
+
+\wxheading{Include files}
+
+<wx/object.h>
+
+\func{}{WXTRACE}{formatString, ...}
+
+Calls wxTrace with printf-style variable argument syntax. Output
+is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
+
+This macro is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
+\wxheading{Include files}
+
+<wx/memory.h>
+
+\membersection{WXTRACELEVEL}\label{tracelevel}
+
+\func{}{WXTRACELEVEL}{level, formatString, ...}
+
+Calls wxTraceLevel with printf-style variable argument syntax. Output
+is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
+The first argument should be the level at which this information is appropriate.
+It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
+this value.
+
+This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
+\wxheading{Include files}
+
+<wx/memory.h>
+
+\membersection{::wxTrace}\label{wxtrace}
+
+\func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
+
+Takes printf-style variable argument syntax. Output
+is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
+
+This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
+\wxheading{Include files}
+
+<wx/memory.h>
+
+\membersection{::wxTraceLevel}\label{wxtracelevel}
+
+\func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
+
+Takes printf-style variable argument syntax. Output
+is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugcontextoverview}).
+The first argument should be the level at which this information is appropriate.
+It will only be output if the level returned by wxDebugContext::GetLevel is equal to or greater than
+this value.
+
+This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
+
+\wxheading{Include files}
+
+<wx/memory.h>
+
\section{Time functions}\label{timefunctions}
The functions in this section deal with getting the current time and
<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 *}{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 involing the
+{\tt sizeof} operator as they can't be tested by the preprocessor but it is
+sometimes desirable to test them at the compile time.
+
+Note that this macro internally declares a struct whose name it tries to make
+unique by using the {\tt \_\_LINE\_\_} in it but it may still not work if you
+use it on the same line in two different source files. In this case you may
+either change the line in which either of them appears on or use the
+\helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro.
+
+\wxheading{See also}
+
+\helpref{wxASSERT\_MSG}{wxassertmsg},\\
+\helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize}
+
+\membersection{wxCOMPILE\_TIME\_ASSERT2}\label{wxcompiletimeassert2}
+
+\func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}, \param{}{name}}
+
+This macro is identical to \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}
+except that it allows you to specify a unique {\it name} for the struct
+internally defined by this macro to avoid getting the compilation errors
+described \helpref{above}{wxcompiletimeassert}.
\membersection{wxFAIL}\label{wxfail}
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