X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4104ed92a537f36f7f41ce07d34cadbe4d78685c..733a25f0f454eefbb1392faad986d8dde7919230:/docs/latex/wx/function.tex?ds=inline diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index b14ab02ec5..5d553b30d0 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -2,7 +2,7 @@ \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% \setfooter{\thepage}{}{}{}{}{\thepage} -The functions and macros defined in wxWindows are described here: you can +The functions and macros defined in wxWidgets are described here: you can either look up a function using the alphabetical listing of them or find it in the corresponding topic. @@ -21,6 +21,7 @@ the corresponding topic. \helpref{IMPLEMENT\_CLASS}{implementclass}\\ \helpref{IMPLEMENT\_DYNAMIC\_CLASS2}{implementdynamicclass2}\\ \helpref{IMPLEMENT\_DYNAMIC\_CLASS}{implementdynamicclass}\\ +\helpref{wxCONCAT}{wxconcat}\\ \helpref{WXDEBUG\_NEW}{debugnew}\\ \helpref{WXTRACELEVEL}{tracelevel}\\ \helpref{WXTRACE}{trace}\\ @@ -37,6 +38,7 @@ the corresponding topic. \helpref{wxCHECK\_MSG}{wxcheckmsg}\\ \helpref{wxCHECK\_RET}{wxcheckret}\\ \helpref{wxCHECK\_VERSION}{wxcheckversion}\\ +\helpref{wxCHECK\_VERSION\_FULL}{wxcheckversionfull}\\ \helpref{wxCHECK\_W32API\_VERSION}{wxcheckw32apiversion}\\ \helpref{wxClientDisplayRect}{wxclientdisplayrect}\\ \helpref{wxClipboardOpen}{functionwxclipboardopen}\\ @@ -107,6 +109,7 @@ the corresponding topic. \helpref{wxGetFullHostName}{wxgetfullhostname}\\ \helpref{wxGetHomeDir}{wxgethomedir}\\ \helpref{wxGetHostName}{wxgethostname}\\ +\helpref{wxGetKeyState}{wxgetkeystate}\\ \helpref{wxGetLocalTimeMillis}{wxgetlocaltimemillis}\\ \helpref{wxGetLocalTime}{wxgetlocaltime}\\ \helpref{wxGetMousePosition}{wxgetmouseposition}\\ @@ -172,6 +175,8 @@ the corresponding topic. \helpref{wxMakeMetafilePlaceable}{wxmakemetafileplaceable}\\ \helpref{wxMatchWild}{wxmatchwild}\\ \helpref{wxMessageBox}{wxmessagebox}\\ +\helpref{wxMilliSleep}{wxmillisleep}\\ +\helpref{wxMicroSleep}{wxmicrosleep}\\ \helpref{wxMkdir}{wxmkdir}\\ \helpref{wxMutexGuiEnter}{wxmutexguienter}\\ \helpref{wxMutexGuiLeave}{wxmutexguileave}\\ @@ -179,6 +184,7 @@ the corresponding topic. \helpref{wxNow}{wxnow}\\ \helpref{wxOnAssert}{wxonassert}\\ \helpref{wxOpenClipboard}{wxopenclipboard}\\ +\helpref{wxParseCommonDialogsFilter}{wxparsecommondialogsfilter}\\ \helpref{wxPathOnly}{wxpathonly}\\ \helpref{wxPostDelete}{wxpostdelete}\\ \helpref{wxPostEvent}{wxpostevent}\\ @@ -219,13 +225,12 @@ the corresponding topic. \helpref{wxSysErrorCode}{wxsyserrorcode}\\ \helpref{wxSysErrorMsg}{wxsyserrormsg}\\ \helpref{wxT}{wxt}\\ -\helpref{wxToLower}{wxtolower}\\ -\helpref{wxToUpper}{wxtoupper}\\ \helpref{wxTraceLevel}{wxtracelevel}\\ \helpref{wxTrace}{wxtrace}\\ \helpref{wxTransferFileToStream}{wxtransferfiletostream}\\ \helpref{wxTransferStreamToFile}{wxtransferstreamtofile}\\ \helpref{wxTrap}{wxtrap}\\ +\helpref{wxULL}{wxull}\\ \helpref{wxUninitialize}{wxuninitialize}\\ \helpref{wxUnix2DosFilename}{wxunix2dosfilename}\\ \helpref{wxUnsetEnv}{wxunsetenv}\\ @@ -234,39 +239,58 @@ the corresponding topic. \helpref{wxWakeUpIdle}{wxwakeupidle}\\ \helpref{wxWriteResource}{wxwriteresource}\\ \helpref{wxYield}{wxyield}\\ +\helpref{wx\_const\_cast}{wxconstcastraw}\\ +\helpref{wx\_static\_cast}{wxstaticcastraw}\\ \helpref{\_}{underscore}\\ \helpref{\_T}{underscoret} + + \section{Version macros}\label{versionfunctions} -The following constants are defined in wxWindows: +The following constants are defined in wxWidgets: \begin{itemize}\itemsep=0pt -\item {\tt wxMAJOR\_VERSION} is the major version of wxWindows -\item {\tt wxMINOR\_VERSION} is the minor version of wxWindows +\item {\tt wxMAJOR\_VERSION} is the major version of wxWidgets +\item {\tt wxMINOR\_VERSION} is the minor version of wxWidgets \item {\tt wxRELEASE\_NUMBER} is the release number +\item {\tt wxSUBRELEASE\_NUMBER} is the subrelease number which is $0$ for all +official releases \end{itemize} -For example, the values or these constants for wxWindows 2.1.15 are 2, 1 and +For example, the values or these constants for wxWidgets 2.1.15 are 2, 1 and 15. Additionally, {\tt wxVERSION\_STRING} is a user-readable string containing -the full wxWindows version and {\tt wxVERSION\_NUMBER} is a combination of the +the full wxWidgets version and {\tt wxVERSION\_NUMBER} is a combination of the three version numbers above: for 2.1.15, it is 2115 and it is 2200 for -wxWindows 2.2. +wxWidgets 2.2. + +The subrelease number is only used for the sources in between official releases +and so normally is not useful. \wxheading{Include files} or + +\membersection{wxCHECK\_GCC\_VERSION}\label{wxcheckgccversion} + +\func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor, release}} + +Returns $1$ if the compiler being used to compile the code is GNU C++ +compiler (g++) version major.minor.release or greater. Otherwise, and also if +the compiler is not GNU C++ at all, returns $0$. + + \membersection{wxCHECK\_VERSION}\label{wxcheckversion} \func{bool}{wxCHECK\_VERSION}{\param{}{major, minor, release}} -This is a macro which evaluates to true if the current wxWindows version is at +This is a macro which evaluates to true if the current wxWidgets version is at least major.minor.release. -For example, to test if the program is compiled with wxWindows 2.2 or higher, +For example, to test if the program is compiled with wxWidgets 2.2 or higher, the following can be done: \begin{verbatim} @@ -281,13 +305,14 @@ the following can be done: } \end{verbatim} -\membersection{wxCHECK\_GCC\_VERSION}\label{wxcheckgccversion} -\func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor, release}} +\membersection{wxCHECK\_VERSION\_FULL}\label{wxcheckversionfull} + +\func{bool}{wxCHECK\_VERSION\_FULL}{\param{}{major, minor, release, subrel}} + +Same as \helpref{wxCHECK\_VERSION}{wxcheckversion} but also checks that +\texttt{wxSUBRELEASE\_NUMBER} is at least \arg{subrel}. -Returns $1$ if the compiler being used to compile the code is GNU C++ -compiler (g++) version major.minor.release or greater. Otherwise, and also if -the compiler is not GNU C++ at all, returns $0$. \membersection{wxCHECK\_W32API\_VERSION}\label{wxcheckw32apiversion} @@ -297,38 +322,41 @@ Returns $1$ if the version of w32api headers used is major.minor.release or greater. Otherwise, and also if we are not compiling with mingw32/cygwin under Win32 at all, returns $0$. + + \section{Application initialization and termination}\label{appinifunctions} The functions in this section are used on application startup/shutdown and also to control the behaviour of the main event loop of the GUI programs. + \membersection{::wxEntry}\label{wxentry} -This initializes wxWindows in a platform-dependent way. Use this if you -are not using the default wxWindows entry code (e.g. main or WinMain). For example, -you can initialize wxWindows from an Microsoft Foundation Classes application using +This initializes wxWidgets in a platform-dependent way. Use this if you +are not using the default wxWidgets entry code (e.g. main or WinMain). For example, +you can initialize wxWidgets from an Microsoft Foundation Classes application using this function. \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance}, \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = true}} -wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is false, the -function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows +wxWidgets initialization under Windows (non-DLL). If {\it enterLoop} is false, the +function will return immediately after calling wxApp::OnInit. Otherwise, the wxWidgets message loop will be entered. \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance}, \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}} -wxWindows initialization under Windows (for applications constructed as a DLL). +wxWidgets initialization under Windows (for applications constructed as a DLL). \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}} -wxWindows initialization under Unix. +wxWidgets initialization under Unix. \wxheading{Remarks} -To clean up wxWindows, call wxApp::OnExit followed by the static function -wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows: +To clean up wxWidgets, call wxApp::OnExit followed by the static function +wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWidgets: \begin{verbatim} int CTheApp::ExitInstance() @@ -346,11 +374,12 @@ int CTheApp::ExitInstance() + \membersection{::wxGetApp}\label{wxgetapp} \func{wxAppDerivedClass\&}{wxGetApp}{\void} -This function doesn't exist in wxWindows but it is created by using +This function doesn't exist in wxWidgets but it is created by using the \helpref{IMPLEMENT\_APP}{implementapp} macro. Thus, before using it anywhere but in the same module where this macro is used, you must make it available using \helpref{DECLARE\_APP}{declareapp}. @@ -360,6 +389,7 @@ wxTheApp pointer is that the latter is of type {\tt wxApp *} and so wouldn't allow you to access the functions specific to your application class but not present in wxApp while wxGetApp() returns the object of the right type. + \membersection{::wxHandleFatalExceptions}\label{wxhandlefatalexceptions} \func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = true}} @@ -372,6 +402,7 @@ normal way which usually just means that the application will be terminated. Calling wxHandleFatalExceptions() with {\it doIt} equal to false will restore this default behaviour. + \membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers} \func{void}{wxInitAllImageHandlers}{\void} @@ -387,13 +418,14 @@ see \helpref{wxImage}{wximage}. + \membersection{::wxInitialize}\label{wxinitialize} \func{bool}{wxInitialize}{\void} This function is used in wxBase only and only if you don't create \helpref{wxApp}{wxapp} object at all. In this case you must call it from your -{\tt main()} function before calling any other wxWindows functions. +{\tt main()} function before calling any other wxWidgets functions. If the function returns {\tt false} the initialization could not be performed, in this case the library cannot be used and @@ -407,6 +439,7 @@ call to this function. + \membersection{::wxSafeYield}\label{wxsafeyield} \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}, \param{bool}{ @@ -423,6 +456,7 @@ Returns the result of the call to \helpref{::wxYield}{wxyield}. + \membersection{::wxUninitialize}\label{wxuninitialize} \func{void}{wxUninitialize}{\void} @@ -434,6 +468,7 @@ once for each previous successful call to \helpref{wxInitialize}{wxinitialize}. + \membersection{::wxYield}\label{wxyield} \func{bool}{wxYield}{\void} @@ -447,6 +482,7 @@ the \helpref{wxApp::Yield}{wxappyield} method instead in any new code. or + \membersection{::wxWakeUpIdle}\label{wxwakeupidle} \func{void}{wxWakeUpIdle}{\void} @@ -462,26 +498,35 @@ the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and + + \section{Process control functions}\label{processfunctions} The functions in this section are used to launch or terminate the other processes. + \membersection{::wxExecute}\label{wxexecute} \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{int }{sync = wxEXEC\_ASYNC}, \param{wxProcess *}{callback = NULL}} +\perlnote{In wxPerl this function is called \texttt{Wx::ExecuteCommand}} + \func{long}{wxExecute}{\param{char **}{argv}, \param{int }{flags = wxEXEC\_ASYNC}, \param{wxProcess *}{callback = NULL}} +\perlnote{In wxPerl this function is called \texttt{Wx::ExecuteArgs}} + \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}} -\perlnote{In wxPerl this function only takes the {\tt command} argument, +\perlnote{In wxPerl this function is called \texttt{Wx::ExecuteStdout} and it +only takes the {\tt command} argument, and returns a 2-element list {\tt ( status, output )}, where {\tt output} is an array reference.} \func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}} -\perlnote{In wxPerl this function only takes the {\tt command} argument, +\perlnote{In wxPerl this function is called \texttt{Wx::ExecuteStdoutStderr} +and it only takes the {\tt command} argument, and returns a 3-element list {\tt ( status, output, errors )}, where {\tt output} and {\tt errors} are array references.} @@ -553,7 +598,7 @@ single string.} array, any additional ones are the command parameters and the array must be terminated with a NULL pointer.} -\docparam{flags}{Combination of bit masks {\tt wxEXEC\_ASYNC}, +\docparam{flags}{Combination of bit masks {\tt wxEXEC\_ASYNC},\rtfsp {\tt wxEXEC\_SYNC} and {\tt wxEXEC\_NOHIDE}} \docparam{callback}{An optional pointer to \helpref{wxProcess}{wxprocess}} @@ -562,6 +607,7 @@ terminated with a NULL pointer.} + \membersection{::wxExit}\label{wxexit} \func{void}{wxExit}{\void} @@ -575,6 +621,7 @@ application. See \helpref{wxCloseEvent}{wxcloseevent} and \helpref{wxApp}{wxapp} + \membersection{::wxKill}\label{wxkill} \func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}} @@ -605,7 +652,7 @@ enum wxSignal \end{verbatim} {\tt wxSIGNONE}, {\tt wxSIGKILL} and {\tt wxSIGTERM} have the same meaning -under both Unix and Windows but all the other signals are equivalent to +under both Unix and Windows but all the other signals are equivalent to {\tt wxSIGTERM} under Windows. Returns 0 on success, -1 on failure. If {\it rc} parameter is not NULL, it will @@ -632,6 +679,7 @@ enum wxKillError + \membersection{::wxGetProcessId}\label{wxgetprocessid} \func{unsigned long}{wxGetProcessId}{\void} @@ -644,6 +692,7 @@ If an error occurs, $0$ is returned. + \membersection{::wxShell}\label{wxshell} \func{bool}{wxShell}{\param{const wxString\& }{command = NULL}} @@ -657,6 +706,7 @@ See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}. + \membersection{::wxShutdown}\label{wxshutdown} \func{bool}{wxShutdown}{\param{wxShutdownFlags}{flags}} @@ -678,6 +728,8 @@ and that this function is only implemented under Unix and Win32. + + \section{Thread functions}\label{threadfunctions} The functions and macros here mainly exist to make it writing the code which @@ -699,6 +751,7 @@ to create and use the critical section only when needed. \helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}, \helpref{Multithreading overview}{wxthreadoverview} + \membersection{wxCRIT\_SECT\_DECLARE}\label{wxcritsectdeclare} \func{}{wxCRIT\_SECT\_DECLARE}{\param{}{cs}} @@ -707,6 +760,7 @@ This macro declares a (static) critical section object named {\it cs} if {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. + \membersection{wxCRIT\_SECT\_DECLARE\_MEMBER}\label{wxcritsectdeclaremember} \func{}{wxCRIT\_SECT\_DECLARE}{\param{}{cs}} @@ -718,6 +772,7 @@ include the {\tt static} keyword (unlike a class or struct member which explains its name. + \membersection{wxCRIT\_SECT\_LOCKER}\label{wxcritsectlocker} \func{}{wxCRIT\_SECT\_LOCKER}{\param{}{name}, \param{}{cs}} @@ -727,6 +782,7 @@ object named {\it name} and associated with the critical section {\it cs} if {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. + \membersection{wxCRITICAL\_SECTION}\label{wxcriticalsectionmacro} \func{}{wxCRITICAL\_SECTION}{\param{}{name}} @@ -753,14 +809,16 @@ other threads start calling it, if this is not the case this approach can {\bf not} be used and the critical section must be made a global instead). + \membersection{wxENTER\_CRIT\_SECT}\label{wxentercritsect} \func{}{wxENTER\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}} -This macro is equivalent to \helpref{cs.Enter()}{wxcriticalsectionenter} if +This macro is equivalent to \helpref{cs.Enter()}{wxcriticalsectionenter} if {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. + \membersection{::wxIsMainThread}\label{wxismainthread} \func{bool}{wxIsMainThread}{\void} @@ -769,14 +827,16 @@ Returns {\tt true} if this thread is the main one. Always returns {\tt true} if {\tt wxUSE\_THREADS} is $0$. + \membersection{wxLEAVE\_CRIT\_SECT}\label{wxleavecritsect} \func{}{wxLEAVE\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}} -This macro is equivalent to \helpref{cs.Leave()}{wxcriticalsectionleave} if +This macro is equivalent to \helpref{cs.Leave()}{wxcriticalsectionleave} if {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. + \membersection{::wxMutexGuiEnter}\label{wxmutexguienter} \func{void}{wxMutexGuiEnter}{\void} @@ -810,6 +870,7 @@ thread but the main one. This function is only defined on platforms which support preemptive threads. + \membersection{::wxMutexGuiLeave}\label{wxmutexguileave} \func{void}{wxMutexGuiLeave}{\void} @@ -819,6 +880,8 @@ See \helpref{::wxMutexGuiEnter()}{wxmutexguienter}. This function is only defined on platforms which support preemptive threads. + + \section{File functions}\label{filefunctions} \wxheading{Include files} @@ -832,12 +895,14 @@ threads. \helpref{wxFile}{wxfile}\\ \helpref{wxFileName}{wxfilename} + \membersection{::wxDirExists}\label{functionwxdirexists} \func{bool}{wxDirExists}{\param{const wxString\& }{dirname}} Returns true if the directory exists. + \membersection{::wxDos2UnixFilename}\label{wxdos2unixfilename} \func{void}{wxDos2UnixFilename}{\param{wxChar *}{s}} @@ -845,12 +910,13 @@ Returns true if the directory exists. Converts a DOS to a Unix filename by replacing backslashes with forward slashes. + \membersection{::wxFileExists}\label{functionwxfileexists} \func{bool}{wxFileExists}{\param{const wxString\& }{filename}} -Returns true if the file exists. It also returns true if the file is -a directory. +Returns true if the file exists and is a plain file. + \membersection{::wxFileModificationTime}\label{wxfilemodificationtime} @@ -858,6 +924,7 @@ a directory. Returns time of last modification of given file. + \membersection{::wxFileNameFromPath}\label{wxfilenamefrompath} \func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}} @@ -870,6 +937,7 @@ Returns time of last modification of given file. Returns the filename for a full path. The second form returns a pointer to temporary storage that should not be deallocated. + \membersection{::wxFindFirstFile}\label{wxfindfirstfile} \func{wxString}{wxFindFirstFile}{\param{const char *}{spec}, \param{int}{ flags = 0}} @@ -894,6 +962,7 @@ For example: } \end{verbatim} + \membersection{::wxFindNextFile}\label{wxfindnextfile} \func{wxString}{wxFindNextFile}{\void} @@ -902,6 +971,7 @@ Returns the next file that matches the path passed to \helpref{wxFindFirstFile}{ See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example. + \membersection{::wxGetDiskSpace}\label{wxgetdiskspace} \func{bool}{wxGetDiskSpace}{\param{const wxString\& }{path}, \param{wxLongLong }{*total = NULL}, \param{wxLongLong }{*free = NULL}} @@ -918,10 +988,11 @@ directory doesn't exist). \wxheading{Portability} -This function is implemented for Win16 (only for drives less than 2Gb), Win32, +This function is implemented for Win32, Mac OS and generic Unix provided the system has {\tt statfs()} function. -This function first appeared in wxWindows 2.3.2. +This function first appeared in wxWidgets 2.3.2. + \membersection{::wxGetOSDirectory}\label{wxgetosdirectory} @@ -929,6 +1000,7 @@ This function first appeared in wxWindows 2.3.2. Returns the Windows directory under Windows; on other platforms returns the empty string. + \membersection{::wxIsAbsolutePath}\label{wxisabsolutepath} \func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}} @@ -936,12 +1008,14 @@ Returns the Windows directory under Windows; on other platforms returns the empt Returns true if the argument is an absolute filename, i.e. with a slash or drive name at the beginning. + \membersection{::wxPathOnly}\label{wxpathonly} \func{wxString}{wxPathOnly}{\param{const wxString\& }{path}} Returns the directory part of the filename. + \membersection{::wxUnix2DosFilename}\label{wxunix2dosfilename} \func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}} @@ -949,6 +1023,7 @@ Returns the directory part of the filename. Converts a Unix to a DOS filename by replacing forward slashes with backslashes. + \membersection{::wxConcatFiles}\label{wxconcatfiles} \func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, @@ -957,6 +1032,7 @@ slashes with backslashes. Concatenates {\it file1} and {\it file2} to {\it file3}, returning true if successful. + \membersection{::wxCopyFile}\label{wxcopyfile} \func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = true}} @@ -966,12 +1042,14 @@ Copies {\it file1} to {\it file2}, returning true if successful. If if it exists, but if {\it overwrite} is false, the functions fails in this case. + \membersection{::wxGetCwd}\label{wxgetcwd} \func{wxString}{wxGetCwd}{\void} Returns a string containing the current (or working) directory. + \membersection{::wxGetWorkingDirectory}\label{wxgetworkingdirectory} \func{wxString}{wxGetWorkingDirectory}{\param{char *}{buf=NULL}, \param{int }{sz=1000}} @@ -979,11 +1057,12 @@ Returns a string containing the current (or working) directory. {\bf NB:} This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead. Copies the current working directory into the buffer if supplied, or -copies the working directory into new storage (which you must delete yourself) -if the buffer is NULL. +copies the working directory into new storage (which you {\emph must} delete +yourself) if the buffer is NULL. {\it sz} is the size of the buffer if supplied. + \membersection{::wxGetTempFileName}\label{wxgettempfilename} \func{char *}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{char *}{buf=NULL}} @@ -1004,40 +1083,60 @@ if the buffer is NULL. \helpref{wxFileName::CreateTempFileName}{wxfilenamecreatetempfilename}\rtfsp instead. + \membersection{::wxIsWild}\label{wxiswild} \func{bool}{wxIsWild}{\param{const wxString\& }{pattern}} Returns true if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}. + \membersection{::wxMatchWild}\label{wxmatchwild} \func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}} -Returns true if the {\it pattern}\/ matches the {\it text}\/; if {\it +Returns true if the \arg{pattern}\/ matches the {\it text}\/; if {\it dot\_special}\/ is true, filenames beginning with a dot are not matched with wildcard characters. See \helpref{wxIsWild}{wxiswild}. + \membersection{::wxMkdir}\label{wxmkdir} \func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}} -Makes the directory {\it dir}, returning true if successful. +Makes the directory \arg{dir}, returning true if successful. {\it perm} is the access mask for the directory for the systems on which it is supported (Unix) and doesn't have effect for the other ones. + +\membersection{::wxParseCommonDialogsFilter}\label{wxparsecommondialogsfilter} + +\func{int}{wxParseCommonDialogsFilter}{\param{const wxString\& }{wildCard}, \param{wxArrayString\& }{descriptions}, \param{wxArrayString\& }{filters}} + +Parses the \arg{wildCard}, returning the number of filters. +Returns 0 if none or if there's a problem. +The arrays will contain an equal number of items found before the error. +On platforms where native dialogs handle only one filter per entry, +entries in arrays are automatically adjusted. +\arg{wildCard} is in the form: +\begin{verbatim} + "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png" +\end{verbatim} + \membersection{::wxRemoveFile}\label{wxremovefile} \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}} -Removes {\it file}, returning true if successful. +Removes \arg{file}, returning true if successful. + \membersection{::wxRenameFile}\label{wxrenamefile} \func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}} -Renames {\it file1} to {\it file2}, returning true if successful. +Renames \arg{file1} to \arg{file2}, returning true if successful. + \membersection{::wxRmdir}\label{wxrmdir} @@ -1047,6 +1146,7 @@ Removes the directory {\it dir}, returning true if successful. Does not work und The {\it flags} parameter is reserved for future use. + \membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory} \func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}} @@ -1054,6 +1154,7 @@ The {\it flags} parameter is reserved for future use. Sets the current working directory, returning true if the operation succeeded. Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification. + \membersection{::wxSplitPath}\label{wxsplitfunction} \func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}} @@ -1078,6 +1179,7 @@ three of them may be empty if the corresponding component is. The old contents o strings pointed to by these parameters will be overwritten in any case (if the pointers are not NULL). + \membersection{::wxTransferFileToStream}\label{wxtransferfiletostream} \func{bool}{wxTransferFileToStream}{\param{const wxString\& }{filename}, \param{ostream\& }{stream}} @@ -1089,6 +1191,7 @@ use streams (within the document/view framework, for example). + \membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile} \func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}} @@ -1100,11 +1203,14 @@ use streams (within the document/view framework, for example). + + \section{Network, user and OS functions}\label{networkfunctions} The functions in this section are used to retrieve information about the current computer and/or user characteristics. + \membersection{::wxGetFreeMemory}\label{wxgetfreememory} \func{long}{wxGetFreeMemory}{\void} @@ -1117,6 +1223,7 @@ under Windows, Linux and Solaris. + \membersection{::wxGetFullHostName}\label{wxgetfullhostname} \func{wxString}{wxGetFullHostName}{\void} @@ -1132,6 +1239,7 @@ error. + \membersection{::wxGetEmailAddress}\label{wxgetemailaddress} \func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}} @@ -1146,6 +1254,7 @@ Returns true if successful, false otherwise. + \membersection{::wxGetHomeDir}\label{wxgethomedir} \func{wxString}{wxGetHomeDir}{\void} @@ -1160,6 +1269,7 @@ Return the (current) user's home directory. + \membersection{::wxGetHostName}\label{wxgethostname} \func{wxString}{wxGetHostName}{\void} @@ -1172,7 +1282,7 @@ the domain name. Under Windows or NT, this function first looks in the environment variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp -in the {\bf wxWindows} section of the WIN.INI file is tried. +in the {\bf wxWidgets} section of the WIN.INI file is tried. The first variant of this function returns the hostname if successful or an empty string otherwise. The second (deprecated) function returns true @@ -1186,6 +1296,7 @@ if successful, false otherwise. + \membersection{::wxGetUserId}\label{wxgetuserid} \func{wxString}{wxGetUserId}{\void} @@ -1197,7 +1308,7 @@ something like "jsmith". It uniquely identifies the current user (on this system Under Windows or NT, this function first looks in the environment variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp -in the {\bf wxWindows} section of the WIN.INI file is tried. +in the {\bf wxWidgets} section of the WIN.INI file is tried. The first variant of this function returns the login name if successful or an empty string otherwise. The second (deprecated) function returns true @@ -1211,6 +1322,7 @@ if successful, false otherwise. + \membersection{::wxGetOsDescription}\label{wxgetosdescription} \func{wxString}{wxGetOsDescription}{\void} @@ -1227,6 +1339,7 @@ user-readable form. For example, this function may return strings like + \membersection{::wxGetOsVersion}\label{wxgetosversion} \func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}} @@ -1257,6 +1370,7 @@ Both {\it major} and {\it minor} have to be looked at as hexadecimal numbers. So + \membersection{::wxGetUserHome}\label{wxgetuserhome} \func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}} @@ -1269,6 +1383,7 @@ Returns the home directory for the given user. If the username is empty + \membersection{::wxGetUserName}\label{wxgetusername} \func{wxString}{wxGetUserName}{\void} @@ -1278,7 +1393,7 @@ Returns the home directory for the given user. If the username is empty This function returns the full user name (something like "Mr. John Smith"). Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp -in the {\bf wxWindows} section of the WIN.INI file. If PenWindows +in the {\bf wxWidgets} section of the WIN.INI file. If PenWindows is running, the entry {\bf Current} in the section {\bf User} of the PENWIN.INI file is used. @@ -1294,8 +1409,11 @@ if successful, {\tt false} otherwise. + + \section{String functions} + \membersection{::copystring}\label{copystring} \func{char *}{copystring}{\param{const char *}{s}} @@ -1305,10 +1423,13 @@ deleted with the {\it delete} operator. This function is deprecated, use \helpref{wxString}{wxstring} class instead. + \membersection{::wxGetTranslation}\label{wxgettranslation} \func{const char *}{wxGetTranslation}{\param{const char * }{str}} +\func{const char *}{wxGetTranslation}{\param{const char * }{str}, \param{const char * }{strPlural}, \param{size\_t }{n}} + This function returns the translation of string {\it str} in the current \helpref{locale}{wxlocale}. If the string is not found in any of the loaded message catalogs (see \helpref{internationalization overview}{internationalization}), the @@ -1318,6 +1439,19 @@ is used very often, an alternative (and also common in Unix world) syntax is provided: the \helpref{\_()}{underscore} macro is defined to do the same thing as wxGetTranslation. +The second form is used when retrieving translation of string that has +different singular and plural form in English or different plural forms in some +other language. It takes two extra arguments: \arg{str} +parameter must contain the singular form of the string to be converted. +It is also used as the key for the search in the catalog. +The \arg{strPlural} parameter is the plural form (in English). +The parameter \arg{n} is used to determine the plural form. If no +message catalog is found \arg{str} is returned if `n == 1', +otherwise \arg{strPlural}. +See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150} for additional information on plural forms handling. + +Both versions call \helpref{wxLocale::GetString}{wxlocalegetstring}. + \membersection{::wxIsEmpty}\label{wxisempty} \func{bool}{wxIsEmpty}{\param{const char *}{ p}} @@ -1325,6 +1459,7 @@ as wxGetTranslation. Returns {\tt true} if the pointer is either {\tt NULL} or points to an empty string, {\tt false} otherwise. + \membersection{::wxStrcmp}\label{wxstrcmp} \func{int}{wxStrcmp}{\param{const char *}{p1}, \param{const char *}{p2}} @@ -1335,6 +1470,7 @@ to or greater than {\it p2}. The comparison is case-sensitive. This function complements the standard C function {\it stricmp()} which performs case-insensitive comparison. + \membersection{::wxStricmp}\label{wxstricmp} \func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}} @@ -1345,6 +1481,7 @@ to or greater than {\it p2}. The comparison is case-insensitive. This function complements the standard C function {\it strcmp()} which performs case-sensitive comparison. + \membersection{::wxStringMatch}\label{wxstringmatch} \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\ @@ -1356,6 +1493,7 @@ Returns {\tt true} if the substring {\it s1} is found within {\it s2}, ignoring case if {\it exact} is false. If {\it subString} is {\tt false}, no substring matching is done. + \membersection{::wxStringEq}\label{wxstringeq} \func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}} @@ -1368,6 +1506,7 @@ A macro defined as: #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0)) \end{verbatim} + \membersection{::wxStrlen}\label{wxstrlen} \func{size\_t}{wxStrlen}{\param{const char *}{ p}} @@ -1376,6 +1515,7 @@ This is a safe version of standard function {\it strlen()}: it does exactly the same thing (i.e. returns the length of the string) except that it returns 0 if {\it p} is the {\tt NULL} pointer. + \membersection{::wxSnprintf}\label{wxsnprintf} \func{int}{wxSnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{}{...}} @@ -1392,6 +1532,7 @@ enough space. \helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf} + \membersection{wxT}\label{wxt} \func{wxChar}{wxT}{\param{char }{ch}} @@ -1413,40 +1554,45 @@ build. In fact, its definition is: #endif \end{verbatim} + \membersection{wxTRANSLATE}\label{wxtranslate} \func{const wxChar *}{wxTRANSLATE}{\param{const char *}{s}} This macro doesn't do anything in the program code -- it simply expands to the -value of its argument (expand in Unicode build where it is equivalent to +value of its argument (except in Unicode build where it is equivalent to \helpref{wxT}{wxt} which makes it unnecessary to use both wxTRANSLATE and wxT with the same string which would be really unreadable). However it does have a purpose and it is to mark the literal strings for the extraction into the message catalog created by {\tt xgettext} program. Usually this is achieved using \helpref{\_()}{underscore} but that macro not only marks -the string for extraction but also expands into +the string for extraction but also expands into a \helpref{wxGetTranslation}{wxgettranslation} function call which means that it -cannot be used in some situations, notably for the static arrays +cannot be used in some situations, notably for static array initialization. Here is an example which should make it more clear: suppose that you have a static array of strings containing the weekday names and which have to be -translated (note that it is a bad example, really, as +translated (note that it is a bad example, really, as \helpref{wxDateTime}{wxdatetime} already can be used to get the localized week day names already). If you write + \begin{verbatim} static const wxChar * const weekdays[] = { _("Mon"), ..., _("Sun") }; ... // use weekdays[n] as usual \end{verbatim} + the code wouldn't compile because the function calls are forbidden in the array initializer. So instead you should do + \begin{verbatim} static const wxChar * const weekdays[] = { wxTRANSLATE("Mon"), ..., wxTRANSLATE("Sun") }; ... // use wxGetTranslation(weekdays[n]) \end{verbatim} + here. Note that although the code {\bf would} compile if you simply omit @@ -1454,27 +1600,6 @@ wxTRANSLATE() in the above, it wouldn't work as expected because there would be no translations for the weekday names in the program message catalog and wxGetTranslation wouldn't find them. - -\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} - - - -\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} - - - \membersection{::wxVsnprintf}\label{wxvsnprintf} \func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}} @@ -1487,6 +1612,7 @@ argument instead of arbitrary number of parameters. \helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv} + \membersection{\_}\label{underscore} \func{const wxChar *}{\_}{\param{const char *}{s}} @@ -1506,13 +1632,13 @@ Don't confuse this macro with \helpref{\_T()}{underscoret}! \func{const wxChar *}{\_T}{\param{const wxChar }{ch}} This macro is exactly the same as \helpref{wxT}{wxt} and is defined in -wxWindows simply because it may be more intuitive for Windows programmers as +wxWidgets simply because it may be more intuitive for Windows programmers as the standard Win32 headers also define it (as well as yet another name for the same macro which is {\tt \_TEXT()}). Don't confuse this macro with \helpref{\_()}{underscore}! -\membersection{\_}\label{underscore} + \section{Dialog functions}\label{dialogfunctions} @@ -1522,6 +1648,7 @@ parameters are optional. However, it is recommended to pass a parent frame parameter, or (in MS Windows or Motif) the wrong window frame may be brought to the front when the dialog box is popped up. + \membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor} \func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}} @@ -1537,6 +1664,7 @@ See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}. + \membersection{::wxBell}\label{wxbell} \func{void}{wxBell}{\void} @@ -1547,6 +1675,7 @@ Ring the system bell. + \membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider} \func{wxTipProvider *}{wxCreateFileTipProvider}{\param{const wxString\& }{filename}, @@ -1567,6 +1696,7 @@ is remembered between the 2 program runs.} + \membersection{::wxDirSelector}\label{wxdirselector} \func{wxString}{wxDirSelector}{\param{const wxString\& }{message = wxDirSelectorPromptStr},\\ @@ -1593,6 +1723,7 @@ if ( !dir.empty() ) + \membersection{::wxFileSelector}\label{wxfileselector} \func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\ @@ -1607,7 +1738,7 @@ If path is empty, the current directory will be used. If filename is empty, no default filename will be supplied. The wildcard determines what files are displayed in the file selector, and file extension supplies a type extension for the required filename. Flags may be a combination of wxOPEN, -wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0. +wxSAVE, wxOVERWRITE\_PROMPT, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0. Both the Unix and Windows versions implement a wildcard filter. Typing a filename containing wildcards (*, ?) in the filename text item, and @@ -1638,6 +1769,7 @@ if ( !filename.empty() ) + \membersection{::wxEndBusyCursor}\label{wxendbusycursor} \func{void}{wxEndBusyCursor}{\void} @@ -1651,6 +1783,7 @@ See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}. + \membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser} \func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}} @@ -1669,6 +1802,7 @@ is valid) if the dialog was cancelled. + \membersection{::wxGetFontFromUser}\label{wxgetfontfromuser} \func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}} @@ -1688,6 +1822,7 @@ is valid) if the dialog was cancelled. + \membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices} \func{size\_t}{wxGetMultipleChoices}{\\ @@ -1731,6 +1866,7 @@ characters) is centred; if false, the message is left-justified. and {\tt choices}, and no {\tt selections} parameter; the function returns an array containing the user selections.} + \membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser} \func{long}{wxGetNumberFromUser}{ @@ -1756,7 +1892,8 @@ Dialog is centered on its {\it parent} unless an explicit position is given in \wxheading{Include files} - + + \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser} @@ -1771,6 +1908,7 @@ to be used for entering passwords as the function name implies. + \membersection{::wxGetTextFromUser}\label{wxgettextfromuser} \func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\ @@ -1788,6 +1926,7 @@ is centred; if false, the message is left-justified. + \membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice} \func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\ @@ -1814,6 +1953,7 @@ is centred; if false, the message is left-justified. + \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice} \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\ @@ -1852,6 +1992,7 @@ characters) is centred; if false, the message is left-justified. \perlnote{In wxPerl there is just an array reference in place of {\tt n} and {\tt choices}.} + \membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex} \func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\ @@ -1876,6 +2017,7 @@ string. If the user pressed cancel, -1 is returned. \perlnote{In wxPerl there is just an array reference in place of {\tt n} and {\tt choices}.} + \membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata} \func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\ @@ -1907,6 +2049,7 @@ elements as {\it choices} or {\it aChoices}! and {\tt choices}, and the client data array must have the same length as the choices array.} + \membersection{::wxIsBusy}\label{wxisbusy} \func{bool}{wxIsBusy}{\void} @@ -1920,6 +2063,7 @@ See also \helpref{wxBusyCursor}{wxbusycursor}. + \membersection{::wxMessageBox}\label{wxmessagebox} \func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK},\\ @@ -1950,7 +2094,7 @@ For example: int answer = wxMessageBox("Quit program?", "Confirm", wxYES_NO | wxCANCEL, main_frame); if (answer == wxYES) - delete main_frame; + main_frame->Close(); ... \end{verbatim} @@ -1961,6 +2105,7 @@ message will be split into separate lines, to cater for large messages. + \membersection{::wxShowTip}\label{wxshowtip} \func{bool}{wxShowTip}{\param{wxWindow *}{parent}, @@ -1988,12 +2133,15 @@ checkbox which is shown in the tips dialog.} + + \section{Math functions} \wxheading{Include files} + \membersection{wxFinite}\label{wxfinite} \func{int}{wxFinite}{\param{double }{x}} @@ -2001,6 +2149,7 @@ checkbox which is shown in the tips dialog.} Returns a non-zero value if {\it x} is neither infinite or NaN (not a number), returns 0 otherwise. + \membersection{wxIsNaN}\label{wxisnan} \func{bool}{wxIsNaN}{\param{double }{x}} @@ -2009,6 +2158,8 @@ Returns a non-zero value if {\it x} is NaN (not a number), returns 0 otherwise. + + \section{GDI functions}\label{gdifunctions} The following are relevant to the GDI (Graphics Device Interface). @@ -2017,6 +2168,7 @@ The following are relevant to the GDI (Graphics Device Interface). + \membersection{wxBITMAP}\label{wxbitmapmacro} \func{}{wxBITMAP}{bitmapName} @@ -2034,6 +2186,7 @@ avoid using {\tt \#ifdef}s when creating bitmaps. + \membersection{::wxClientDisplayRect}\label{wxclientdisplayrect} \func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y}, @@ -2046,18 +2199,21 @@ this means the area not covered by the taskbar, etc. Other platforms are currently defaulting to the whole display until a way is found to provide this info for all window managers, etc. + \membersection{::wxColourDisplay}\label{wxcolourdisplay} \func{bool}{wxColourDisplay}{\void} Returns true if the display is colour, false otherwise. + \membersection{::wxDisplayDepth}\label{wxdisplaydepth} \func{int}{wxDisplayDepth}{\void} Returns the depth of the display (a value of 1 denotes a monochrome display). + \membersection{::wxDisplaySize}\label{wxdisplaysize} \func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}} @@ -2066,6 +2222,7 @@ Returns the depth of the display (a value of 1 denotes a monochrome display). Returns the display size in pixels. + \membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm} \func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}} @@ -2074,6 +2231,7 @@ Returns the display size in pixels. Returns the display size in millimeters. + \membersection{::wxDROP\_ICON}\label{wxdropicon} \func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}} @@ -2089,6 +2247,7 @@ This macro should be used with + \membersection{wxICON}\label{wxiconmacro} \func{}{wxICON}{iconName} @@ -2106,6 +2265,7 @@ avoid using {\tt \#ifdef}s when creating icons. + \membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable} \func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY}, @@ -2125,7 +2285,7 @@ the equivalent of the following code to the start of the metafile data: SetWindowExt(dc, maxX - minX, maxY - minY); \end{verbatim} -This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes. +This simulates the wxMM\_TEXT mapping mode, which wxWidgets assumes. Placeable metafiles may be imported by many Windows applications, and can be used in RTF (Rich Text Format) files. @@ -2134,6 +2294,7 @@ used in RTF (Rich Text Format) files. This function is only available under Windows. + \membersection{::wxSetCursor}\label{wxsetcursor} \func{void}{wxSetCursor}{\param{wxCursor *}{cursor}} @@ -2141,6 +2302,8 @@ This function is only available under Windows. Globally sets the cursor; only has an effect in Windows and GTK. See also \helpref{wxCursor}{wxcursor}, \helpref{wxWindow::SetCursor}{wxwindowsetcursor}. + + \section{Printer settings}\label{printersettings} {\bf NB:} These routines are obsolete and should no longer be used! @@ -2152,18 +2315,21 @@ Windows, PostScript output can only be sent to a file. + \membersection{::wxGetPrinterCommand}\label{wxgetprintercommand} \func{wxString}{wxGetPrinterCommand}{\void} Gets the printer command used to print a file. The default is {\tt lpr}. + \membersection{::wxGetPrinterFile}\label{wxgetprinterfile} \func{wxString}{wxGetPrinterFile}{\void} Gets the PostScript output filename. + \membersection{::wxGetPrinterMode}\label{wxgetprintermode} \func{int}{wxGetPrinterMode}{\void} @@ -2171,48 +2337,56 @@ Gets the PostScript output filename. Gets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER). The default is PS\_PREVIEW. + \membersection{::wxGetPrinterOptions}\label{wxgetprinteroptions} \func{wxString}{wxGetPrinterOptions}{\void} Gets the additional options for the print command (e.g. specific printer). The default is nothing. + \membersection{::wxGetPrinterOrientation}\label{wxgetprinterorientation} \func{int}{wxGetPrinterOrientation}{\void} Gets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT. + \membersection{::wxGetPrinterPreviewCommand}\label{wxgetprinterpreviewcommand} \func{wxString}{wxGetPrinterPreviewCommand}{\void} Gets the command used to view a PostScript file. The default depends on the platform. + \membersection{::wxGetPrinterScaling}\label{wxgetprinterscaling} \func{void}{wxGetPrinterScaling}{\param{float *}{x}, \param{float *}{y}} Gets the scaling factor for PostScript output. The default is 1.0, 1.0. + \membersection{::wxGetPrinterTranslation}\label{wxgetprintertranslation} \func{void}{wxGetPrinterTranslation}{\param{float *}{x}, \param{float *}{y}} Gets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0. + \membersection{::wxSetPrinterCommand}\label{wxsetprintercommand} \func{void}{wxSetPrinterCommand}{\param{const wxString\& }{command}} Sets the printer command used to print a file. The default is {\tt lpr}. + \membersection{::wxSetPrinterFile}\label{wxsetprinterfile} \func{void}{wxSetPrinterFile}{\param{const wxString\& }{filename}} Sets the PostScript output filename. + \membersection{::wxSetPrinterMode}\label{wxsetprintermode} \func{void}{wxSetPrinterMode}{\param{int }{mode}} @@ -2220,36 +2394,43 @@ Sets the PostScript output filename. Sets the printing mode controlling where output is sent (PS\_PREVIEW, PS\_FILE or PS\_PRINTER). The default is PS\_PREVIEW. + \membersection{::wxSetPrinterOptions}\label{wxsetprinteroptions} \func{void}{wxSetPrinterOptions}{\param{const wxString\& }{options}} Sets the additional options for the print command (e.g. specific printer). The default is nothing. + \membersection{::wxSetPrinterOrientation}\label{wxsetprinterorientation} \func{void}{wxSetPrinterOrientation}{\param{int}{ orientation}} Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT. + \membersection{::wxSetPrinterPreviewCommand}\label{wxsetprinterpreviewcommand} \func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}} Sets the command used to view a PostScript file. The default depends on the platform. + \membersection{::wxSetPrinterScaling}\label{wxsetprinterscaling} \func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}} Sets the scaling factor for PostScript output. The default is 1.0, 1.0. + \membersection{::wxSetPrinterTranslation}\label{wxsetprintertranslation} \func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}} Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0. + + \section{Clipboard functions}\label{clipsboard} These clipboard functions are implemented for Windows only. The use of these functions @@ -2260,24 +2441,28 @@ class instead. + \membersection{::wxClipboardOpen}\label{functionwxclipboardopen} \func{bool}{wxClipboardOpen}{\void} Returns true if this application has already opened the clipboard. + \membersection{::wxCloseClipboard}\label{wxcloseclipboard} \func{bool}{wxCloseClipboard}{\void} Closes the clipboard to allow other applications to use it. + \membersection{::wxEmptyClipboard}\label{wxemptyclipboard} \func{bool}{wxEmptyClipboard}{\void} Empties the clipboard. + \membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats} \func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}} @@ -2298,6 +2483,7 @@ is not open. Before it enumerates the formats function, an application must open the clipboard by using the wxOpenClipboard function. + \membersection{::wxGetClipboardData}\label{wxgetclipboarddata} \func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}} @@ -2313,6 +2499,7 @@ Gets data from the clipboard. The clipboard must have previously been opened for this call to succeed. + \membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname} \func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}} @@ -2320,24 +2507,28 @@ The clipboard must have previously been opened for this call to succeed. Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format. + \membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable} \func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}} Returns true if the given data format is available on the clipboard. + \membersection{::wxOpenClipboard}\label{wxopenclipboard} \func{bool}{wxOpenClipboard}{\void} Opens the clipboard for passing data to it or getting data from it. + \membersection{::wxRegisterClipboardFormat}\label{wxregisterclipboardformat} \func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}} Registers the clipboard data format name and returns an identifier. + \membersection{::wxSetClipboardData}\label{wxsetclipboarddata} \func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}} @@ -2356,21 +2547,31 @@ Passes data to the clipboard. The clipboard must have previously been opened for this call to succeed. + + \section{Miscellaneous functions}\label{miscellany} + +\membersection{wxCONCAT}\label{wxconcat} + +\func{}{wxCONCAT}{\param{}{x}, \param{}{y}} + +This macro returns the concatenation of two tokens \arg{x} and \arg{y}. + + \membersection{wxDYNLIB\_FUNCTION}\label{wxdynlibfunction} \func{}{wxDYNLIB\_FUNCTION}{\param{}{type}, \param{}{name}, \param{}{dynlib}} When loading a function from a DLL you always have to cast the returned -\tt{void *} pointer to the correct type and, even more annoyingly, you have to +{\tt void *} pointer to the correct type and, even more annoyingly, you have to repeat this type twice if you want to declare and define a function pointer all in one line This macro makes this slightly less painful by allowing you to specify the type only once, as the first parameter, and creating a variable of this type named after the function but with {\tt pfn} prefix and initialized with the -function \arg{name} from the \helpref{wxDynamicLibrary}{wxDynamicLibrary} +function \arg{name} from the \helpref{wxDynamicLibrary}{wxdynamiclibrary} \arg{dynlib}. \wxheading{Parameters} @@ -2383,6 +2584,7 @@ it is quoted automatically by the macro)} \docparam{dynlib}{the library to load the function from} + \membersection{wxEXPLICIT}\label{wxexplicit} {\tt wxEXPLICIT} is a macro which expands to the C++ {\tt explicit} keyword if @@ -2390,6 +2592,20 @@ the compiler supports it or nothing otherwise. Thus, it can be used even in the code which might have to be compiled with an old compiler without support for this language feature but still take advantage of it when it is available. + +\membersection{::wxGetKeyState}\label{wxgetkeystate} + +\func{bool}{wxGetKeyState}{\param{wxKeyCode }{key}} + +Returns \true if the key parameter is currently pressed on the keyboard, or +with modifier keys, (caps lock, etc) if the key is active (the led light is +on). + +\wxheading{Include files} + + + + \membersection{wxLL}\label{wxll} \func{wxLongLong\_t}{wxLL}{\param{}{number}} @@ -2407,6 +2623,11 @@ allows to define 64 bit compile time constants: +\wxheading{See also} + +\helpref{wxULL}{wxull}, \helpref{wxLongLong}{wxlonglong} + + \membersection{wxLongLongFmtSpec}\label{wxlonglongfmtspec} This macro is defined to contain the {\tt printf()} format specifier using @@ -2428,6 +2649,7 @@ printed. Example of using it: + \membersection{::wxNewId}\label{wxnewid} \func{long}{wxNewId}{\void} @@ -2438,6 +2660,7 @@ Generates an integer identifier unique to this run of the program. + \membersection{::wxRegisterId}\label{wxregisterid} \func{void}{wxRegisterId}{\param{long}{ id}} @@ -2449,11 +2672,12 @@ the given {\bf id}. + \membersection{::wxDDECleanUp}\label{wxddecleanup} \func{void}{wxDDECleanUp}{\void} -Called when wxWindows exits, to clean up the DDE system. This no longer needs to be +Called when wxWidgets exits, to clean up the DDE system. This no longer needs to be called by the application. See also \helpref{wxDDEInitialize}{wxddeinitialize}. @@ -2462,6 +2686,7 @@ See also \helpref{wxDDEInitialize}{wxddeinitialize}. + \membersection{::wxDDEInitialize}\label{wxddeinitialize} \func{void}{wxDDEInitialize}{\void} @@ -2469,15 +2694,16 @@ See also \helpref{wxDDEInitialize}{wxddeinitialize}. Initializes the DDE system. May be called multiple times without harm. This no longer needs to be called by the application: it will be called -by wxWindows if necessary. +by wxWidgets if necessary. -See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection}, +See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},\rtfsp \helpref{wxDDECleanUp}{wxddecleanup}. \wxheading{Include files} + \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows} \func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = true}} @@ -2489,6 +2715,7 @@ This function enables or disables all top level windows. It is used by + \membersection{::wxFindMenuItemId}\label{wxfindmenuitemid} \func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}} @@ -2499,6 +2726,7 @@ Find a menu item identifier associated with the given frame's menu bar. + \membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel} \func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}} @@ -2515,6 +2743,7 @@ The search is recursive in both cases. + \membersection{::wxFindWindowByName}\label{wxfindwindowbyname} \func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}} @@ -2533,6 +2762,7 @@ If no such named window is found, {\bf wxFindWindowByLabel} is called. + \membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint} \func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}} @@ -2540,6 +2770,7 @@ If no such named window is found, {\bf wxFindWindowByLabel} is called. Find the deepest window at the given mouse position in screen coordinates, returning the window if found, or NULL if not. + \membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer} \func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}} @@ -2547,6 +2778,7 @@ returning the window if found, or NULL if not. Find the deepest window at the mouse pointer position, returning the window and current pointer position in screen coordinates. + \membersection{::wxGetActiveWindow}\label{wxgetactivewindow} \func{wxWindow *}{wxGetActiveWindow}{\void} @@ -2557,6 +2789,7 @@ Gets the currently active window (Windows only). + \membersection{::wxGetDisplayName}\label{wxgetdisplayname} \func{wxString}{wxGetDisplayName}{\void} @@ -2567,6 +2800,7 @@ Under X only, returns the current display name. See also \helpref{wxSetDisplayNa + \membersection{::wxGetMousePosition}\label{wxgetmouseposition} \func{wxPoint}{wxGetMousePosition}{\void} @@ -2577,6 +2811,7 @@ Returns the mouse position in screen coordinates. + \membersection{::wxGetResource}\label{wxgetresource} \func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, @@ -2611,6 +2846,7 @@ See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxco + \membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent} \func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}} @@ -2622,6 +2858,7 @@ frame or dialog containing it, or {\tt NULL}. + \membersection{::wxLoadUserResource}\label{wxloaduserresource} \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}} @@ -2643,6 +2880,7 @@ This function is available under Windows only. + \membersection{::wxPostDelete}\label{wxpostdelete} \func{void}{wxPostDelete}{\param{wxObject *}{object}} @@ -2658,6 +2896,7 @@ Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead. + \membersection{::wxPostEvent}\label{wxpostevent} \func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}} @@ -2672,6 +2911,7 @@ See the respective documentation for details (and caveats). + \membersection{::wxSetDisplayName}\label{wxsetdisplayname} \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}} @@ -2687,6 +2927,7 @@ See also \helpref{wxGetDisplayName}{wxgetdisplayname}. + \membersection{::wxStripMenuCodes}\label{wxstripmenucodes} \func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}} @@ -2706,6 +2947,29 @@ as a keyboard shortkey in Windows and Motif) and $\backslash$t (tab in Windows). + +\membersection{wxULL}\label{wxull} + +\func{wxLongLong\_t}{wxULL}{\param{}{number}} + +This macro is defined for the platforms with a native 64 bit integer type and +allows to define unsigned 64 bit compile time constants: + +\begin{verbatim} + #ifdef wxLongLong_t + unsigned wxLongLong_t ll = wxULL(0x1234567890abcdef); + #endif +\end{verbatim} + +\wxheading{Include files} + + + +\wxheading{See also} + +\helpref{wxLL}{wxll}, \helpref{wxLongLong}{wxlonglong} + + \membersection{::wxWriteResource}\label{wxwriteresource} \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry}, @@ -2737,6 +3001,8 @@ See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfig + + \section{Byte order macros}\label{byteordermacros} The endian-ness issues (that is the difference between big-endian and @@ -2745,6 +3011,7 @@ with the external binary data (for example, data files or data coming from network) which is usually in some fixed, platform-independent format. The macros are helpful for transforming the data to the correct format. + \membersection{wxINTXX\_SWAP\_ALWAYS}\label{intswapalways} \func{wxInt32}{wxINT32\_SWAP\_ALWAYS}{\param{wxInt32 }{value}} @@ -2759,6 +3026,7 @@ These macros will swap the bytes of the {\it value} variable from little endian to big endian or vice versa unconditionally, i.e. independently of the current platform. + \membersection{wxINTXX\_SWAP\_ON\_BE}\label{intswaponbe} \func{wxInt32}{wxINT32\_SWAP\_ON\_BE}{\param{wxInt32 }{value}} @@ -2777,6 +3045,7 @@ been compiled on a little-endian architecture, the value will be unchanged. Use these macros to read data from and write data to a file that stores data in little-endian (for example Intel i386) format. + \membersection{wxINTXX\_SWAP\_ON\_LE}\label{intswaponle} \func{wxInt32}{wxINT32\_SWAP\_ON\_LE}{\param{wxInt32 }{value}} @@ -2795,9 +3064,11 @@ been compiled on a big-endian architecture, the value will be unchanged. Use these macros to read data from and write data to a file that stores data in big-endian format. + + \section{RTTI functions}\label{rttimacros} -wxWindows uses its own RTTI ("run-time type identification") system which +wxWidgets uses its own RTTI ("run-time type identification") system which predates the current standard C++ RTTI and so is kept for backwards compatibility reasons but also because it allows some things which the standard RTTI doesn't directly support (such as creating a class from its @@ -2805,12 +3076,13 @@ name). The standard C++ RTTI can be used in the user code without any problems and in general you shouldn't need to use the functions and the macros in this section -unless you are thinking of modifying or adding any wxWindows classes. +unless you are thinking of modifying or adding any wxWidgets classes. \wxheading{See also} \helpref{RTTI overview}{runtimeclassoverview} + \membersection{CLASSINFO}\label{classinfo} \func{wxClassInfo *}{CLASSINFO}{className} @@ -2821,6 +3093,7 @@ Returns a pointer to the wxClassInfo object associated with this class. + \membersection{DECLARE\_ABSTRACT\_CLASS}\label{declareabstractclass} \func{}{DECLARE\_ABSTRACT\_CLASS}{className} @@ -2847,6 +3120,7 @@ class wxCommand: public wxObject + \membersection{DECLARE\_APP}\label{declareapp} \func{}{DECLARE\_APP}{className} @@ -2866,6 +3140,7 @@ Example: + \membersection{DECLARE\_CLASS}\label{declareclass} \func{}{DECLARE\_CLASS}{className} @@ -2878,6 +3153,7 @@ dynamically. The same as DECLARE\_ABSTRACT\_CLASS. + \membersection{DECLARE\_DYNAMIC\_CLASS}\label{declaredynamicclass} \func{}{DECLARE\_DYNAMIC\_CLASS}{className} @@ -2903,6 +3179,7 @@ class wxFrame: public wxWindow + \membersection{IMPLEMENT\_ABSTRACT\_CLASS}\label{implementabstractclass} \func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName} @@ -2925,6 +3202,7 @@ wxCommand::wxCommand(void) + \membersection{IMPLEMENT\_ABSTRACT\_CLASS2}\label{implementabstractclass2} \func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2} @@ -2936,12 +3214,13 @@ a class that has run-time type information and two base classes. The same as IMP + \membersection{IMPLEMENT\_APP}\label{implementapp} \func{}{IMPLEMENT\_APP}{className} This is used in the application class implementation file to make the application class known to -wxWindows for dynamic construction. You use this instead of +wxWidgets for dynamic construction. You use this instead of Old form: @@ -2961,6 +3240,7 @@ See also \helpref{DECLARE\_APP}{declareapp}. + \membersection{IMPLEMENT\_CLASS}\label{implementclass} \func{}{IMPLEMENT\_CLASS}{className, baseClassName} @@ -2972,6 +3252,7 @@ a class that has run-time type information. The same as IMPLEMENT\_ABSTRACT\_CLA + \membersection{IMPLEMENT\_CLASS2}\label{implementclass2} \func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2} @@ -2984,6 +3265,7 @@ same as IMPLEMENT\_ABSTRACT\_CLASS2. + \membersection{IMPLEMENT\_DYNAMIC\_CLASS}\label{implementdynamicclass} \func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName} @@ -3007,6 +3289,7 @@ wxFrame::wxFrame(void) + \membersection{IMPLEMENT\_DYNAMIC\_CLASS2}\label{implementdynamicclass2} \func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2} @@ -3020,6 +3303,7 @@ base classes. + \membersection{wxConstCast}\label{wxconstcast} \func{classname *}{wxConstCast}{ptr, classname} @@ -3029,9 +3313,11 @@ supports {\it const\_cast} or into an old, C-style cast, otherwise. \wxheading{See also} +\helpref{wx\_const\_cast}{wxconstcastraw}\\ \helpref{wxDynamicCast}{wxdynamiccast}\\ \helpref{wxStaticCast}{wxstaticcast} + \membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject} \func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}} @@ -3039,6 +3325,7 @@ supports {\it const\_cast} or into an old, C-style cast, otherwise. Creates and returns an object of the given class, if the class has been registered with the dynamic class system using DECLARE... and IMPLEMENT... macros. + \membersection{WXDEBUG\_NEW}\label{debugnew} \func{}{WXDEBUG\_NEW}{arg} @@ -3056,6 +3343,7 @@ In non-debug mode, this is defined as the normal new operator. + \membersection{wxDynamicCast}\label{wxdynamiccast} \func{classname *}{wxDynamicCast}{ptr, classname} @@ -3090,6 +3378,7 @@ Example: \helpref{wxConstCast}{wxconstcast}\\ \helpref{wxStatiicCast}{wxstaticcast} + \membersection{wxDynamicCastThis}\label{wxdynamiccastthis} \func{classname *}{wxDynamicCastThis}{classname} @@ -3103,6 +3392,7 @@ this macro should be used to avoid them. \helpref{wxDynamicCast}{wxdynamiccast} + \membersection{wxStaticCast}\label{wxstaticcast} \func{classname *}{wxStaticCast}{ptr, classname} @@ -3111,20 +3401,55 @@ This macro checks that the cast is valid in debug mode (an assert failure will result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the result of executing an equivalent of {\tt static\_cast(ptr)}. +\wxheading{See also} + +\helpref{wx\_static\_cast}{wxstaticcastraw}\\ \helpref{wxDynamicCast}{wxdynamiccast}\\ \helpref{wxConstCast}{wxconstcast} + +\membersection{wx\_const\_cast}\label{wxconstcastraw} + +\func{T}{wx\_const\_cast}{T, x} + +Same as \texttt{const\_cast(x)} if the compiler supports const cast or +\texttt{(T)x} for old compilers. Unlike \helpref{wxConstCast}{wxconstcast}, +the cast it to the type \arg{T} and not to \texttt{T *} and also the order of +arguments is the same as for the standard cast. + +\wxheading{See also} + +\helpref{wx\_static\_cast}{wxstaticcastraw}\\ + + +\membersection{wx\_static\_cast}\label{wxstaticcastraw} + +\func{T}{wx\_static\_cast}{T, x} + +Same as \texttt{static\_cast(x)} if the compiler supports static cast or +\texttt{(T)x} for old compilers. Unlike \helpref{wxStaticCast}{wxstaticcast}, +there are no checks being done and the meaning of the macro arguments is exactly +the same as for the standard static cast, i.e. \arg{T} is the full type name and +star is not appended to it. + +\wxheading{See also} + +\helpref{wx\_const\_cast}{wxconstcastraw}\\ + + + \section{Log functions}\label{logfunctions} These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for further information. The functions use (implicitly) the currently active log target, so their descriptions here may not apply if the log target is not the -standard one (installed by wxWindows in the beginning of the program). +standard one (installed by wxWidgets in the beginning of the program). \wxheading{Include files} + \membersection{::wxDebugMsg}\label{wxdebugmsg} \func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}} @@ -3149,36 +3474,39 @@ instead. + \membersection{::wxError}\label{wxerror} -\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}} +\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Internal Error"}} {\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror} instead. Displays {\it msg} and continues. This writes to standard error under Unix, and pops up a message box under Windows. Used for internal -wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}. +wxWidgets errors. See also \helpref{wxFatalError}{wxfatalerror}. \wxheading{Include files} + \membersection{::wxFatalError}\label{wxfatalerror} -\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}} +\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Fatal Error"}} {\bf NB:} This function is now obsolete, please use \helpref{wxLogFatalError}{wxlogfatalerror} instead. Displays {\it msg} and exits. This writes to standard error under Unix, and pops up a message box under Windows. Used for fatal internal -wxWindows errors. See also \helpref{wxError}{wxerror}. +wxWidgets errors. See also \helpref{wxError}{wxerror}. \wxheading{Include files} + \membersection{::wxLogError}\label{wxlogerror} \func{void}{wxLogError}{\param{const char *}{formatString}, \param{...}{}} @@ -3189,6 +3517,7 @@ The functions to use for error messages, i.e. the messages that must be shown to the user. The default processing is to pop up a message box to inform the user about it. + \membersection{::wxLogFatalError}\label{wxlogfatalerror} \func{void}{wxLogFatalError}{\param{const char *}{formatString}, \param{...}{}} @@ -3199,6 +3528,7 @@ Like \helpref{wxLogError}{wxlogerror}, but also terminates the program with the exit code 3. Using {\it abort()} standard function also terminates the program with this exit code. + \membersection{::wxLogWarning}\label{wxlogwarning} \func{void}{wxLogWarning}{\param{const char *}{formatString}, \param{...}{}} @@ -3208,6 +3538,7 @@ function also terminates the program with this exit code. For warnings - they are also normally shown to the user, but don't interrupt the program work. + \membersection{::wxLogMessage}\label{wxlogmessage} \func{void}{wxLogMessage}{\param{const char *}{formatString}, \param{...}{}} @@ -3220,6 +3551,7 @@ show informational messages if there are any errors later - the logic being that the later error messages make the informational messages preceding them meaningless. + \membersection{::wxLogVerbose}\label{wxlogverbose} \func{void}{wxLogVerbose}{\param{const char *}{formatString}, \param{...}{}} @@ -3230,6 +3562,7 @@ For verbose output. Normally, it is suppressed, but might be activated if the user wishes to know more details about the program progress (another, but possibly confusing name for the same function is {\bf wxLogInfo}). + \membersection{::wxLogStatus}\label{wxlogstatus} \func{void}{wxLogStatus}{\param{wxFrame *}{frame}, \param{const char *}{formatString}, \param{...}{}} @@ -3246,13 +3579,14 @@ 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}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}} -Mostly used by wxWindows itself, but might be handy for logging errors after +Mostly used by wxWidgets itself, but might be handy for logging errors after system call (API function) failure. It logs the specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending on the platform) and the corresponding error message. The second form @@ -3263,6 +3597,7 @@ of this function takes the error code explicitly as the first argument. \helpref{wxSysErrorCode}{wxsyserrorcode}, \helpref{wxSysErrorMsg}{wxsyserrormsg} + \membersection{::wxLogDebug}\label{wxlogdebug} \func{void}{wxLogDebug}{\param{const char *}{formatString}, \param{...}{}} @@ -3273,6 +3608,7 @@ The right functions for debug output. They only do something in debug mode (when the preprocessor symbol \_\_WXDEBUG\_\_ is defined) and expand to nothing in release mode (otherwise). + \membersection{::wxLogTrace}\label{wxlogtrace} \func{void}{wxLogTrace}{\param{const char *}{formatString}, \param{...}{}} @@ -3300,8 +3636,10 @@ the value of the trace mask (possible during the run-time). For the second function (taking a string mask), the message is logged only if the mask has been previously enabled by the call to -\helpref{AddTraceMask}{wxlogaddtracemask}. The predefined string trace masks -used by wxWindows are: +\helpref{AddTraceMask}{wxlogaddtracemask} or by setting +\helpref{{\tt WXTRACE} environment variable}{envvars}. +The predefined string trace masks +used by wxWidgets are: \begin{itemize}\itemsep=0pt \item wxTRACE\_MemAlloc: trace memory allocation (new/delete) @@ -3326,6 +3664,7 @@ trace masks. \item wxTraceOleCalls: trace OLE method calls (Win32 only) \end{itemize} + \membersection{::wxSafeShowMessage}\label{wxsafeshowmessage} \func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}} @@ -3352,6 +3691,7 @@ of the message string} + \membersection{::wxSysErrorCode}\label{wxsyserrorcode} \func{unsigned long}{wxSysErrorCode}{\void} @@ -3364,6 +3704,7 @@ Returns the error code from the last system call. This function uses \helpref{wxSysErrorMsg}{wxsyserrormsg}, \helpref{wxLogSysError}{wxlogsyserror} + \membersection{::wxSysErrorMsg}\label{wxsyserrormsg} \func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}} @@ -3377,6 +3718,7 @@ Returns the error message corresponding to the given system error code. If \helpref{wxSysErrorCode}{wxsyserrorcode}, \helpref{wxLogSysError}{wxlogsyserror} + \membersection{WXTRACE}\label{trace} \wxheading{Include files} @@ -3394,6 +3736,7 @@ is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugco + \membersection{WXTRACELEVEL}\label{tracelevel} \func{}{WXTRACELEVEL}{level, formatString, ...} @@ -3410,6 +3753,7 @@ this value. + \membersection{::wxTrace}\label{wxtrace} \func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}} @@ -3423,6 +3767,7 @@ is directed to the current output stream (see \helpref{wxDebugContext}{wxdebugco + \membersection{::wxTraceLevel}\label{wxtracelevel} \func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}} @@ -3439,6 +3784,8 @@ this value. + + \section{Time functions}\label{timefunctions} The functions in this section deal with getting the current time and @@ -3449,6 +3796,7 @@ should be used instead. For retrieving the current time, you may also use \helpref{wxDateTime::Now}{wxdatetimenow} or \helpref{wxDateTime::UNow}{wxdatetimeunow} methods. + \membersection{::wxGetElapsedTime}\label{wxgetelapsedtime} \func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = true}} @@ -3464,6 +3812,7 @@ See also \helpref{wxTimer}{wxtimer}. + \membersection{::wxGetLocalTime}\label{wxgetlocaltime} \func{long}{wxGetLocalTime}{\void} @@ -3478,6 +3827,7 @@ Returns the number of seconds since local time 00:00:00 Jan 1st 1970. + \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis} \func{wxLongLong}{wxGetLocalTimeMillis}{\void} @@ -3493,6 +3843,7 @@ Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970. + \membersection{::wxGetUTCTime}\label{wxgetutctime} \func{long}{wxGetUTCTime}{\void} @@ -3507,6 +3858,34 @@ Returns the number of seconds since GMT 00:00:00 Jan 1st 1970. + +\membersection{::wxMicroSleep}\label{wxmicrosleep} + +\func{void}{wxMicroSleep}{\param{unsigned long}{ microseconds}} + +Sleeps for the specified number of microseconds. The microsecond resolution may +not, in fact, be available on all platforms (currently only Unix platforms with +nanosleep(2) may provide it) in which case this is the same as +\helpref{wxMilliSleep}{wxmillisleep}(\arg{microseconds}$/1000$). + +\wxheading{Include files} + + + + +\membersection{::wxMilliSleep}\label{wxmillisleep} + +\func{void}{wxMilliSleep}{\param{unsigned long}{ milliseconds}} + +Sleeps for the specified number of milliseconds. Notice that usage of this +function is encouraged instead of calling usleep(3) directly because the +standard usleep() function is not MT safe. + +\wxheading{Include files} + + + + \membersection{::wxNow}\label{wxnow} \func{wxString}{wxNow}{\void} @@ -3517,6 +3896,7 @@ Returns a string representing the current date and time. + \membersection{::wxSleep}\label{wxsleep} \func{void}{wxSleep}{\param{int}{ secs}} @@ -3527,6 +3907,7 @@ Sleeps for the specified number of seconds. + \membersection{::wxStartTimer}\label{wxstarttimer} \func{void}{wxStartTimer}{\void} @@ -3539,22 +3920,22 @@ See also \helpref{wxTimer}{wxtimer}. + \membersection{::wxUsleep}\label{wxusleep} \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}} -Sleeps for the specified number of milliseconds. Notice that usage of this -function is encouraged instead of calling usleep(3) directly because the -standard usleep() function is not MT safe. +This function is deprecated because its name is misleading: notice that the +argument is in milliseconds, not microseconds. Please use either +\helpref{wxMilliSleep}{wxmillisleep} or \helpref{wxMicroSleep}{wxmicrosleep} +depending on the resolution you need. -\wxheading{Include files} - \section{Debugging macros and functions}\label{debugmacros} Useful macros and functions for error checking and defensive programming. -wxWindows defines three families of the assert-like macros: +wxWidgets defines three families of the assert-like macros: the wxASSERT and wxFAIL macros only do anything if \_\_WXDEBUG\_\_ is defined (in other words, in the debug build) but disappear completely in the release build. On the other hand, the wxCHECK macros stay event in release builds but a @@ -3566,6 +3947,7 @@ compilation error messages if the condition they check fail. + \membersection{::wxOnAssert}\label{wxonassert} \func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{cond}, \param{const char *}{msg = NULL}} @@ -3580,6 +3962,7 @@ ignoring any subsequent assert failures, you may override \helpref{wxApp::OnAssert}{wxapponassert} which is called by this function if the global application object exists. + \membersection{wxASSERT}\label{wxassert} \func{}{wxASSERT}{\param{}{condition}} @@ -3595,6 +3978,7 @@ because it will not be executed in release mode at all. \helpref{wxASSERT\_MSG}{wxassertmsg},\\ \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert} + \membersection{wxASSERT\_MIN\_BITSIZE}\label{wxassertminbitsize} \func{}{wxASSERT\_MIN\_BITSIZE}{\param{}{type}, \param{}{size}} @@ -3613,6 +3997,7 @@ You may use it like this, for example: wxASSERT_MIN_BITSIZE(wchar_t, 16); \end{verbatim} + \membersection{wxASSERT\_MSG}\label{wxassertmsg} \func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}} @@ -3624,6 +4009,7 @@ Assert macro with message. An error message will be generated if the condition i \helpref{wxASSERT}{wxassert},\\ \helpref{wxCOMPILE\_TIME\_ASSERT}{wxcompiletimeassert} + \membersection{wxCOMPILE\_TIME\_ASSERT}\label{wxcompiletimeassert} \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}} @@ -3643,11 +4029,17 @@ use it on the same line in two different source files. In this case you may either change the line in which either of them appears on or use the \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2} macro. +Also note that Microsoft Visual C++ has a bug which results in compiler errors +if you use this macro with ``Program Database For Edit And Continue'' +(\texttt{/ZI}) option, so you shouldn't use it (``Program Database'' +(\texttt{/Zi}) is ok though) for the code making use of this macro. + \wxheading{See also} \helpref{wxASSERT\_MSG}{wxassertmsg},\\ \helpref{wxASSERT\_MIN\_BITSIZE}{wxassertminbitsize} + \membersection{wxCOMPILE\_TIME\_ASSERT2}\label{wxcompiletimeassert2} \func{}{wxCOMPILE\_TIME\_ASSERT}{\param{}{condition}, \param{}{msg}, \param{}{name}} @@ -3657,6 +4049,7 @@ except that it allows you to specify a unique {\it name} for the struct internally defined by this macro to avoid getting the compilation errors described \helpref{above}{wxcompiletimeassert}. + \membersection{wxFAIL}\label{wxfail} \func{}{wxFAIL}{\void} @@ -3665,6 +4058,7 @@ Will always generate an assert error if this code is reached (in debug mode). See also: \helpref{wxFAIL\_MSG}{wxfailmsg} + \membersection{wxFAIL\_MSG}\label{wxfailmsg} \func{}{wxFAIL\_MSG}{\param{}{msg}} @@ -3679,6 +4073,7 @@ cases are processed above. \helpref{wxFAIL}{wxfail} + \membersection{wxCHECK}\label{wxcheck} \func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}} @@ -3686,6 +4081,7 @@ cases are processed above. Checks that the condition is true, returns with the given return value if not (FAILs in debug mode). This check is done even in release mode. + \membersection{wxCHECK\_MSG}\label{wxcheckmsg} \func{}{wxCHECK\_MSG}{\param{}{condition}, \param{}{retValue}, \param{}{msg}} @@ -3696,6 +4092,7 @@ This check is done even in release mode. This macro may be only used in non void functions, see also \helpref{wxCHECK\_RET}{wxcheckret}. + \membersection{wxCHECK\_RET}\label{wxcheckret} \func{}{wxCHECK\_RET}{\param{}{condition}, \param{}{msg}} @@ -3706,6 +4103,7 @@ message in debug mode). This check is done even in release mode. This macro should be used in void functions instead of \helpref{wxCHECK\_MSG}{wxcheckmsg}. + \membersection{wxCHECK2}\label{wxcheck2} \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}} @@ -3717,6 +4115,7 @@ returning from the function must be done when the {\it condition} is false. This check is done even in release mode. + \membersection{wxCHECK2\_MSG}\label{wxcheck2msg} \func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}} @@ -3725,6 +4124,7 @@ This is the same as \helpref{wxCHECK2}{wxcheck2}, but \helpref{wxFAIL\_MSG}{wxfailmsg} with the specified {\it msg} is called instead of wxFAIL() if the {\it condition} is false. + \membersection{::wxTrap}\label{wxtrap} \func{void}{wxTrap}{\void} @@ -3740,6 +4140,7 @@ In release mode this function does nothing. + \membersection{::wxIsDebuggerRunning}\label{wxisdebuggerrunning} \func{bool}{wxIsDebuggerRunning}{\void} @@ -3751,6 +4152,8 @@ Please note that this function is currently only implemented for Mac builds using CodeWarrior and always returns {\tt false} elsewhere. + + \section{Environment access functions}\label{environfunctions} The functions in this section allow to access (get) or change value of @@ -3763,6 +4166,7 @@ Win32 and POSIX-like systems (Unix). + \membersection{wxGetenv}\label{wxgetenvmacro} \func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}} @@ -3774,6 +4178,7 @@ Note that under Win32 it may not return correct value for the variables set with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function instead. + \membersection{wxGetEnv}\label{wxgetenv} \func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}} @@ -3784,6 +4189,7 @@ and are not interested in its value. Returns {\tt true} if the variable exists, {\tt false} otherwise. + \membersection{wxSetEnv}\label{wxsetenv} \func{bool}{wxSetEnv}{\param{const wxString\&}{ var}, \param{const wxChar *}{value}} @@ -3793,6 +4199,7 @@ to {\it value}. Returns {\tt true} on success. + \membersection{wxUnsetEnv}\label{wxunsetenv} \func{bool}{wxUnsetEnv}{\param{const wxString\&}{ var}}