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{IMPLEMENT\_CLASS}{implementclass}\\
\helpref{IMPLEMENT\_DYNAMIC\_CLASS2}{implementdynamicclass2}\\
\helpref{IMPLEMENT\_DYNAMIC\_CLASS}{implementdynamicclass}\\
+\helpref{ngettext}{ngettext}\\
+\helpref{wxCONCAT}{wxconcat}\\
\helpref{WXDEBUG\_NEW}{debugnew}\\
\helpref{WXTRACELEVEL}{tracelevel}\\
\helpref{WXTRACE}{trace}\\
\helpref{wxBITMAP}{wxbitmapmacro}\\
\helpref{wxBeginBusyCursor}{wxbeginbusycursor}\\
\helpref{wxBell}{wxbell}\\
+\helpref{wxCHECK}{wxcheck}\\
\helpref{wxCHECK2\_MSG}{wxcheck2msg}\\
\helpref{wxCHECK2}{wxcheck2}\\
+\helpref{wxCHECK\_GCC\_VERSION}{wxcheckgccversion}\\
\helpref{wxCHECK\_MSG}{wxcheckmsg}\\
\helpref{wxCHECK\_RET}{wxcheckret}\\
\helpref{wxCHECK\_VERSION}{wxcheckversion}\\
-\helpref{wxCHECK}{wxcheck}\\
+\helpref{wxCHECK\_W32API\_VERSION}{wxcheckw32apiversion}\\
\helpref{wxClientDisplayRect}{wxclientdisplayrect}\\
\helpref{wxClipboardOpen}{functionwxclipboardopen}\\
\helpref{wxCloseClipboard}{wxcloseclipboard}\\
\helpref{wxCopyFile}{wxcopyfile}\\
\helpref{wxCreateDynamicObject}{wxcreatedynamicobject}\\
\helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider}\\
+\helpref{wxCRIT\_SECT\_DECLARE}{wxcritsectdeclare}\\
+\helpref{wxCRIT\_SECT\_DECLARE\_MEMBER}{wxcritsectdeclaremember}\\
+\helpref{wxCRIT\_SECT\_LOCKER}{wxcritsectlocker}\\
+\helpref{wxCRITICAL\_SECTION}{wxcriticalsectionmacro}\\ % wxcs already taken!
\helpref{wxDDECleanUp}{wxddecleanup}\\
\helpref{wxDDEInitialize}{wxddeinitialize}\\
\helpref{wxDROP\_ICON}{wxdropicon}\\
\helpref{wxDos2UnixFilename}{wxdos2unixfilename}\\
\helpref{wxDynamicCastThis}{wxdynamiccastthis}\\
\helpref{wxDynamicCast}{wxdynamiccast}\\
+\helpref{wxDYNLIB\_FUNCTION}{wxdynlibfunction}\\
\helpref{wxEmptyClipboard}{wxemptyclipboard}\\
\helpref{wxEnableTopLevelWindows}{wxenabletoplevelwindows}\\
\helpref{wxEndBusyCursor}{wxendbusycursor}\\
+\helpref{wxENTER\_CRIT\_SECT}{wxentercritsect}\\
\helpref{wxEntry}{wxentry}\\
\helpref{wxEnumClipboardFormats}{wxenumclipboardformats}\\
\helpref{wxError}{wxerror}\\
\helpref{wxExecute}{wxexecute}\\
\helpref{wxExit}{wxexit}\\
+\helpref{wxEXPLICIT}{wxexplicit}\\
\helpref{wxFAIL\_MSG}{wxfailmsg}\\
\helpref{wxFAIL}{wxfail}\\
\helpref{wxFatalError}{wxfatalerror}\\
\helpref{wxFindWindowAtPoint}{wxfindwindowatpoint}\\
\helpref{wxFindWindowByLabel}{wxfindwindowbylabel}\\
\helpref{wxFindWindowByName}{wxfindwindowbyname}\\
+\helpref{wxFinite}{wxfinite}\\
\helpref{wxGetActiveWindow}{wxgetactivewindow}\\
+\helpref{wxGetApp}{wxgetapp}\\
\helpref{wxGetClipboardData}{wxgetclipboarddata}\\
\helpref{wxGetClipboardFormatName}{wxgetclipboardformatname}\\
\helpref{wxGetColourFromUser}{wxgetcolourfromuser}\\
\helpref{wxGetPrinterPreviewCommand}{wxgetprinterpreviewcommand}\\
\helpref{wxGetPrinterScaling}{wxgetprinterscaling}\\
\helpref{wxGetPrinterTranslation}{wxgetprintertranslation}\\
+\helpref{wxGetProcessId}{wxgetprocessid}\\
\helpref{wxGetResource}{wxgetresource}\\
\helpref{wxGetSingleChoiceData}{wxgetsinglechoicedata}\\
\helpref{wxGetSingleChoiceIndex}{wxgetsinglechoiceindex}\\
\helpref{wxIsAbsolutePath}{wxisabsolutepath}\\
\helpref{wxIsBusy}{wxisbusy}\\
\helpref{wxIsClipboardFormatAvailable}{wxisclipboardformatavailable}\\
+\helpref{wxIsDebuggerRunning}{wxisdebuggerrunning}\\
\helpref{wxIsEmpty}{wxisempty}\\
+\helpref{wxIsMainThread}{wxismainthread}\\
+\helpref{wxIsNaN}{wxisnan}\\
\helpref{wxIsWild}{wxiswild}\\
\helpref{wxKill}{wxkill}\\
+\helpref{wxLEAVE\_CRIT\_SECT}{wxleavecritsect}\\
\helpref{wxLoadUserResource}{wxloaduserresource}\\
\helpref{wxLogDebug}{wxlogdebug}\\
\helpref{wxLogError}{wxlogerror}\\
\helpref{wxLogTrace}{wxlogtrace}\\
\helpref{wxLogVerbose}{wxlogverbose}\\
\helpref{wxLogWarning}{wxlogwarning}\\
+\helpref{wxLL}{wxll}\\
+\helpref{wxLongLongFmtSpec}{wxlonglongfmtspec}\\
\helpref{wxMakeMetafilePlaceable}{wxmakemetafileplaceable}\\
\helpref{wxMatchWild}{wxmatchwild}\\
\helpref{wxMessageBox}{wxmessagebox}\\
\helpref{wxRegisterId}{wxregisterid}\\
\helpref{wxRemoveFile}{wxremovefile}\\
\helpref{wxRenameFile}{wxrenamefile}\\
-\helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}\\
-\helpref{wxResourceClear}{wxresourceclear}\\
-\helpref{wxResourceCreateBitmap}{wxresourcecreatebitmap}\\
-\helpref{wxResourceCreateIcon}{wxresourcecreateicon}\\
-\helpref{wxResourceCreateMenuBar}{wxresourcecreatemenubar}\\
-\helpref{wxResourceGetIdentifier}{wxresourcegetidentifier}\\
-\helpref{wxResourceParseData}{wxresourcedata}\\
-\helpref{wxResourceParseFile}{wxresourceparsefile}\\
-\helpref{wxResourceParseString}{wxresourceparsestring}\\
-\helpref{wxResourceRegisterBitmapData}{registerbitmapdata}\\
-\helpref{wxResourceRegisterIconData}{wxresourceregistericondata}\\
\helpref{wxRmdir}{wxrmdir}\\
\helpref{wxSafeShowMessage}{wxsafeshowmessage}\\
\helpref{wxSafeYield}{wxsafeyield}\\
\helpref{wxSplitPath}{wxsplitfunction}\\
\helpref{wxStartTimer}{wxstarttimer}\\
\helpref{wxStaticCast}{wxstaticcast}\\
+\helpref{wxStrcmp}{wxstrcmp}\\
\helpref{wxStricmp}{wxstricmp}\\
\helpref{wxStringEq}{wxstringeq}\\
\helpref{wxStringMatch}{wxstringmatch}\\
\helpref{wxStrlen}{wxstrlen}\\
\helpref{wxSysErrorCode}{wxsyserrorcode}\\
\helpref{wxSysErrorMsg}{wxsyserrormsg}\\
+\helpref{wxT}{wxt}\\
\helpref{wxToLower}{wxtolower}\\
\helpref{wxToUpper}{wxtoupper}\\
\helpref{wxTraceLevel}{wxtracelevel}\\
\helpref{wxTransferFileToStream}{wxtransferfiletostream}\\
\helpref{wxTransferStreamToFile}{wxtransferstreamtofile}\\
\helpref{wxTrap}{wxtrap}\\
+\helpref{wxULL}{wxull}\\
\helpref{wxUninitialize}{wxuninitialize}\\
\helpref{wxUnix2DosFilename}{wxunix2dosfilename}\\
\helpref{wxUnsetEnv}{wxunsetenv}\\
\helpref{wxVsnprintf}{wxvsnprintf}\\
\helpref{wxWakeUpIdle}{wxwakeupidle}\\
\helpref{wxWriteResource}{wxwriteresource}\\
-\helpref{wxYield}{wxyield}
+\helpref{wxYield}{wxyield}\\
+\helpref{\_}{underscore}\\
+\helpref{\_T}{underscoret}
+
+
\section{Version macros}\label{versionfunctions}
<wx/version.h> or <wx/defs.h>
+
\membersection{wxCHECK\_VERSION}\label{wxcheckversion}
\func{bool}{wxCHECK\_VERSION}{\param{}{major, minor, release}}
}
\end{verbatim}
+
+\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\_W32API\_VERSION}\label{wxcheckw32apiversion}
+
+\func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor, release}}
+
+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
this function.
\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
- \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
+ \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = true}}
-wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
+wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is false, the
function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
message loop will be entered.
<wx/app.h>
+
+
+\membersection{::wxGetApp}\label{wxgetapp}
+
+\func{wxAppDerivedClass\&}{wxGetApp}{\void}
+
+This function doesn't exist in wxWindows 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}.
+
+The advantage of using this function compared to directly using the global
+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}}
+\func{bool}{wxHandleFatalExceptions}{\param{bool}{ doIt = true}}
-If {\it doIt} is TRUE, the fatal exceptions (also known as general protection
+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
+Calling wxHandleFatalExceptions() with {\it doIt} equal to false will restore
this default behaviour.
+
\membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers}
\func{void}{wxInitAllImageHandlers}{\void}
<wx/image.h>
+
\membersection{::wxInitialize}\label{wxinitialize}
\func{bool}{wxInitialize}{\void}
\helpref{wxApp}{wxapp} object at all. In this case you must call it from your
{\tt main()} function before calling any other wxWindows functions.
-If the function returns {\tt FALSE} the initialization could not be performed,
+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.
<wx/app.h>
+
\membersection{::wxSafeYield}\label{wxsafeyield}
-\func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}}
+\func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}, \param{bool}{
+ onlyIfNeeded = false}}
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
<wx/utils.h>
+
\membersection{::wxUninitialize}\label{wxuninitialize}
\func{void}{wxUninitialize}{\void}
<wx/app.h>
+
\membersection{::wxYield}\label{wxyield}
\func{bool}{wxYield}{\void}
Calls \helpref{wxApp::Yield}{wxappyield}.
-This function is kept only for backwards compatibility, please use
-\helpref{wxApp::Yield}{wxappyield}method instead in any new code.
+This function is kept only for backwards compatibility. Please use
+the \helpref{wxApp::Yield}{wxappyield} method instead in any new code.
\wxheading{Include files}
<wx/app.h> or <wx/utils.h>
+
\membersection{::wxWakeUpIdle}\label{wxwakeupidle}
\func{void}{wxWakeUpIdle}{\void}
\wxheading{Include files}
-<wx/app.h>
+<wx/event.h>
+
+
\section{Process control functions}\label{processfunctions}
The functions in this section are used to launch or terminate the other
processes.
+
\membersection{::wxExecute}\label{wxexecute}
\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{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.}
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}.
+calling \helpref{wxEnableTopLevelWindows(false)}{wxenabletoplevelwindows}.
For asynchronous execution, however, the return value is the process id and
zero value indicates that the command could not be executed. As an added
and only this, case the calling code will not get the notification about
process termination.
-If callback isn't NULL and if execution is asynchronous,
+If callback isn't NULL and if execution is asynchronous,
\helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
the process finishes. Specifying this parameter also allows you to redirect the
-standard input and/or output of the process being launched by calling
+standard input and/or output of the process being launched by calling
\helpref{Redirect}{wxprocessredirect}. If the child process IO is redirected,
under Windows the process window is not shown by default (this avoids having to
flush an unnecessary console for the processes which don't create any windows
{\it output}. The fourth version adds the possibility to additionally capture
the messages from standard error output in the {\it errors} array.
-See also \helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess},
-\helpref{Exec sample}{sampleexec}.
+{\bf NB:} Currently wxExecute() can only be used from the main thread, calling
+this function from another thread will result in an assert failure in debug
+build and won't work.
+
+\wxheading{See also}
+
+\helpref{wxShell}{wxshell}, \helpref{wxProcess}{wxprocess}, \helpref{Exec sample}{sampleexec}.
\wxheading{Parameters}
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},
{\tt wxEXEC\_SYNC} and {\tt wxEXEC\_NOHIDE}}
\docparam{callback}{An optional pointer to \helpref{wxProcess}{wxprocess}}
<wx/utils.h>
+
\membersection{::wxExit}\label{wxexit}
\func{void}{wxExit}{\void}
<wx/app.h>
+
\membersection{::wxKill}\label{wxkill}
\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}}
<wx/utils.h>
+
+\membersection{::wxGetProcessId}\label{wxgetprocessid}
+
+\func{unsigned long}{wxGetProcessId}{\void}
+
+Returns the number uniquely identifying the current process in the system.
+
+If an error occurs, $0$ is returned.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+
+
\membersection{::wxShell}\label{wxshell}
\func{bool}{wxShell}{\param{const wxString\& }{command = NULL}}
<wx/utils.h>
+
\membersection{::wxShutdown}\label{wxshutdown}
\func{bool}{wxShutdown}{\param{wxShutdownFlags}{flags}}
-This function shuts down or reboots the computer depending on the value of the
+This function shuts down or reboots the computer depending on the value of the
{\it flags}. Please notice that doing this requires the corresponding access
rights (superuser under Unix, {\tt SE\_SHUTDOWN} privelege under Windows NT)
and that this function is only implemented under Unix and Win32.
\wxheading{Returns}
-{\tt TRUE} on success, {\tt FALSE} if an error occured.
+{\tt true} on success, {\tt false} if an error occured.
\wxheading{Include files}
<wx/utils.h>
+
+
\section{Thread functions}\label{threadfunctions}
+The functions and macros here mainly exist to make it writing the code which
+may be compiled in multi thread build ({\tt wxUSE\_THREADS} $= 1$) as well as
+in single thread configuration ({\tt wxUSE\_THREADS} $= 0$).
+
+For example, a static variable must be protected against simultaneous access by
+multiple threads in the former configuration but in the latter the extra
+overhead of using the critical section is not needed. To solve this problem,
+the \helpref{wxCRITICAL\_SECTION}{wxcriticalsectionmacro} macro may be used
+to create and use the critical section only when needed.
+
\wxheading{Include files}
<wx/thread.h>
\helpref{wxThread}{wxthread}, \helpref{wxMutex}{wxmutex}, \helpref{Multithreading overview}{wxthreadoverview}
+
+
+\membersection{wxCRIT\_SECT\_DECLARE}\label{wxcritsectdeclare}
+
+\func{}{wxCRIT\_SECT\_DECLARE}{\param{}{cs}}
+
+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}}
+
+This macro declares a critical section object named {\it cs} if
+{\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. As it doesn't
+include the {\tt static} keyword (unlike
+\helpref{wxCRIT\_SECT\_DECLARE}{wxcritsectdeclare}), it can be used to declare
+a class or struct member which explains its name.
+
+
+
+\membersection{wxCRIT\_SECT\_LOCKER}\label{wxcritsectlocker}
+
+\func{}{wxCRIT\_SECT\_LOCKER}{\param{}{name}, \param{}{cs}}
+
+This macro creates a \helpref{critical section lock}{wxcriticalsectionlocker}
+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}}
+
+This macro combines \helpref{wxCRIT\_SECT\_DECLARE}{wxcritsectdeclare} and
+\helpref{wxCRIT\_SECT\_LOCKER}{wxcritsectlocker}: it creates a static critical
+section object and also the lock object associated with it. Because of this, it
+can be only used inside a function, not at global scope. For example:
+
+\begin{verbatim}
+int IncCount()
+{
+ static int s_counter = 0;
+
+ wxCRITICAL_SECTION(counter);
+
+ return ++s_counter;
+}
+\end{verbatim}
+
+(note that we suppose that the function is called the first time from the main
+thread so that the critical section object is initialized correctly by the time
+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
+{\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
+
+
+
+\membersection{::wxIsMainThread}\label{wxismainthread}
+
+\func{bool}{wxIsMainThread}{\void}
+
+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
+{\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
+
+
+
\membersection{::wxMutexGuiEnter}\label{wxmutexguienter}
\func{void}{wxMutexGuiEnter}{\void}
This function is only defined on platforms which support preemptive
threads.
+
\membersection{::wxMutexGuiLeave}\label{wxmutexguileave}
\func{void}{wxMutexGuiLeave}{\void}
This function is only defined on platforms which support preemptive
threads.
+
+
\section{File functions}\label{filefunctions}
\wxheading{Include files}
\helpref{wxFile}{wxfile}\\
\helpref{wxFileName}{wxfilename}
+
\membersection{::wxDirExists}\label{functionwxdirexists}
\func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
-Returns TRUE if the directory exists.
+Returns true if the directory exists.
+
\membersection{::wxDos2UnixFilename}\label{wxdos2unixfilename}
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}
Returns time of last modification of given file.
+
\membersection{::wxFileNameFromPath}\label{wxfilenamefrompath}
\func{wxString}{wxFileNameFromPath}{\param{const wxString\& }{path}}
\func{char *}{wxFileNameFromPath}{\param{char *}{path}}
-{\bf NB:} This function is obsolete, please use
+{\bf NB:} This function is obsolete, please use
\helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
Returns the filename for a full path. The second form returns a pointer to
temporary storage that should not be deallocated.
+
\membersection{::wxFindFirstFile}\label{wxfindfirstfile}
\func{wxString}{wxFindFirstFile}{\param{const char *}{spec}, \param{int}{ flags = 0}}
}
\end{verbatim}
+
\membersection{::wxFindNextFile}\label{wxfindnextfile}
\func{wxString}{wxFindNextFile}{\void}
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}}
\wxheading{Returns}
-{\tt TRUE} on success, {\tt FALSE} if an error occured (for example, the
+{\tt true} on success, {\tt false} if an error occured (for example, the
directory doesn't exist).
\wxheading{Portability}
This function first appeared in wxWindows 2.3.2.
+
\membersection{::wxGetOSDirectory}\label{wxgetosdirectory}
\func{wxString}{wxGetOSDirectory}{\void}
Returns the Windows directory under Windows; on other platforms returns the empty string.
+
\membersection{::wxIsAbsolutePath}\label{wxisabsolutepath}
\func{bool}{wxIsAbsolutePath}{\param{const wxString\& }{filename}}
-Returns TRUE if the argument is an absolute filename, i.e. with a slash
+Returns true if the argument is an absolute filename, i.e. with a slash
or drive name at the beginning.
+
\membersection{::wxPathOnly}\label{wxpathonly}
\func{wxString}{wxPathOnly}{\param{const wxString\& }{path}}
Returns the directory part of the filename.
+
\membersection{::wxUnix2DosFilename}\label{wxunix2dosfilename}
\func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}}
Converts a Unix to a DOS filename by replacing forward
slashes with backslashes.
+
\membersection{::wxConcatFiles}\label{wxconcatfiles}
\func{bool}{wxConcatFiles}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2},
\param{const wxString\& }{file3}}
Concatenates {\it file1} and {\it file2} to {\it file3}, returning
-TRUE if successful.
+true if successful.
+
\membersection{::wxCopyFile}\label{wxcopyfile}
-\func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = TRUE}}
+\func{bool}{wxCopyFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = true}}
-Copies {\it file1} to {\it file2}, returning TRUE if successful. If
-{\it overwrite} parameter is TRUE (default), the destination file is overwritten
-if it exists, but if {\it overwrite} is FALSE, the functions fails in this
+Copies {\it file1} to {\it file2}, returning true if successful. If
+{\it overwrite} parameter is true (default), the destination file is overwritten
+if it exists, but if {\it overwrite} is false, the functions fails in this
case.
+
\membersection{::wxGetCwd}\label{wxgetcwd}
\func{wxString}{wxGetCwd}{\void}
Returns a string containing the current (or working) directory.
+
\membersection{::wxGetWorkingDirectory}\label{wxgetworkingdirectory}
\func{wxString}{wxGetWorkingDirectory}{\param{char *}{buf=NULL}, \param{int }{sz=1000}}
{\bf NB:} This function is obsolete: use \helpref{wxGetCwd}{wxgetcwd} instead.
Copies the current working directory into the buffer if supplied, or
-copies the working directory into new storage (which you must delete yourself)
-if the buffer is NULL.
+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}}
\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}.
+Returns true if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatchwild}.
+
\membersection{::wxMatchWild}\label{wxmatchwild}
\func{bool}{wxMatchWild}{\param{const wxString\& }{pattern}, \param{const wxString\& }{text}, \param{bool}{ dot\_special}}
-Returns TRUE if the {\it pattern}\/ matches the {\it text}\/; if {\it
-dot\_special}\/ is TRUE, filenames beginning with a dot are not matched
+Returns true if the {\it pattern}\/ matches the {\it text}\/; if {\it
+dot\_special}\/ is true, filenames beginning with a dot are not matched
with wildcard characters. See \helpref{wxIsWild}{wxiswild}.
+
\membersection{::wxMkdir}\label{wxmkdir}
\func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}}
-Makes the directory {\it dir}, returning TRUE if successful.
+Makes the directory {\it dir}, returning true if successful.
{\it perm} is the access mask for the directory for the systems on which it is
supported (Unix) and doesn't have effect for the other ones.
+
\membersection{::wxRemoveFile}\label{wxremovefile}
\func{bool}{wxRemoveFile}{\param{const wxString\& }{file}}
-Removes {\it file}, returning TRUE if successful.
+Removes {\it file}, returning true if successful.
+
\membersection{::wxRenameFile}\label{wxrenamefile}
\func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
-Renames {\it file1} to {\it file2}, returning TRUE if successful.
+Renames {\it file1} to {\it file2}, returning true if successful.
+
\membersection{::wxRmdir}\label{wxrmdir}
\func{bool}{wxRmdir}{\param{const wxString\& }{dir}, \param{int}{ flags=0}}
-Removes the directory {\it dir}, returning TRUE if successful. Does not work under VMS.
+Removes the directory {\it dir}, returning true if successful. Does not work under VMS.
The {\it flags} parameter is reserved for future use.
+
\membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory}
\func{bool}{wxSetWorkingDirectory}{\param{const wxString\& }{dir}}
-Sets the current working directory, returning TRUE if the operation succeeded.
+Sets the current working directory, returning true if the operation succeeded.
Under MS Windows, the current drive is also changed if {\it dir} contains a drive specification.
+
\membersection{::wxSplitPath}\label{wxsplitfunction}
\func{void}{wxSplitPath}{\param{const char *}{ fullname}, \param{wxString *}{ path}, \param{wxString *}{ name}, \param{wxString *}{ ext}}
-{\bf NB:} This function is obsolete, please use
+{\bf NB:} This function is obsolete, please use
\helpref{wxFileName::SplitPath}{wxfilenamesplitpath} instead.
This function splits a full file name into components: the path (including possible disk/drive
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}}
<wx/docview.h>
+
\membersection{::wxTransferStreamToFile}\label{wxtransferstreamtofile}
\func{bool}{wxTransferStreamToFile}{\param{istream\& }{stream} \param{const wxString\& }{filename}}
<wx/docview.h>
+
+
\section{Network, user and OS functions}\label{networkfunctions}
The functions in this section are used to retrieve information about the
current computer and/or user characteristics.
+
\membersection{::wxGetFreeMemory}\label{wxgetfreememory}
\func{long}{wxGetFreeMemory}{\void}
<wx/utils.h>
+
\membersection{::wxGetFullHostName}\label{wxgetfullhostname}
\func{wxString}{wxGetFullHostName}{\void}
<wx/utils.h>
+
\membersection{::wxGetEmailAddress}\label{wxgetemailaddress}
\func{bool}{wxGetEmailAddress}{\param{const wxString\& }{buf}, \param{int }{sz}}
concatenating the values returned by \helpref{wxGetFullHostName}{wxgetfullhostname}\rtfsp
and \helpref{wxGetUserId}{wxgetuserid}.
-Returns TRUE if successful, FALSE otherwise.
+Returns true if successful, false otherwise.
\wxheading{Include files}
<wx/utils.h>
+
\membersection{::wxGetHomeDir}\label{wxgethomedir}
\func{wxString}{wxGetHomeDir}{\void}
<wx/utils.h>
+
\membersection{::wxGetHostName}\label{wxgethostname}
\func{wxString}{wxGetHostName}{\void}
in the {\bf wxWindows} section of the WIN.INI file is tried.
The first variant of this function returns the hostname if successful or an
-empty string otherwise. The second (deprecated) function returns TRUE
-if successful, FALSE otherwise.
+empty string otherwise. The second (deprecated) function returns true
+if successful, false otherwise.
\wxheading{See also}
<wx/utils.h>
+
\membersection{::wxGetUserId}\label{wxgetuserid}
\func{wxString}{wxGetUserId}{\void}
in the {\bf wxWindows} section of the WIN.INI file is tried.
The first variant of this function returns the login name if successful or an
-empty string otherwise. The second (deprecated) function returns TRUE
-if successful, FALSE otherwise.
+empty string otherwise. The second (deprecated) function returns true
+if successful, false otherwise.
\wxheading{See also}
<wx/utils.h>
+
\membersection{::wxGetOsDescription}\label{wxgetosdescription}
\func{wxString}{wxGetOsDescription}{\void}
<wx/utils.h>
+
\membersection{::wxGetOsVersion}\label{wxgetosversion}
\func{int}{wxGetOsVersion}{\param{int *}{major = NULL}, \param{int *}{minor = NULL}}
\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{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.
+
+Both {\it major} and {\it minor} have to be looked at as hexadecimal numbers. So System 10.2.4 returns 0x10, resp 16 for {\it major} and 0x24, resp 36 for {\it minor}. }
\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.}
<wx/utils.h>
+
\membersection{::wxGetUserHome}\label{wxgetuserhome}
\func{const wxChar *}{wxGetUserHome}{\param{const wxString\& }{user = ""}}
Returns the home directory for the given user. If the username is empty
-(default value), this function behaves like
+(default value), this function behaves like
\helpref{wxGetHomeDir}{wxgethomedir}.
\wxheading{Include files}
<wx/utils.h>
+
\membersection{::wxGetUserName}\label{wxgetusername}
\func{wxString}{wxGetUserName}{\void}
the PENWIN.INI file is used.
The first variant of this function returns the user name if successful or an
-empty string otherwise. The second (deprecated) function returns {\tt TRUE}
-if successful, {\tt FALSE} otherwise.
+empty string otherwise. The second (deprecated) function returns {\tt true}
+if successful, {\tt false} otherwise.
\wxheading{See also}
<wx/utils.h>
+
+
\section{String functions}
+
\membersection{::copystring}\label{copystring}
\func{char *}{copystring}{\param{const char *}{s}}
This function is deprecated, use \helpref{wxString}{wxstring} class instead.
+
+\membersection{ngettext}\label{ngettext}
+
+\func{const wxChar *}{ngettext}{\param{const char *}{str}, \param{const char *}{strPlural}, \param{size\_t }{n}}
+
+This macro expands into a call to plural form version of
+\helpref{wxGetTranslation}{wxgettranslation}
+function, so it marks the message for the extraction by {\tt xgettext} just as
+\helpref{wxTRANSLATE}{wxtranslate} does, but also returns the translation of
+the string for the current locale during execution, either singular or plural
+form depending on the value of \arg{n}.
+
+\wxheading{See also}
+
+\helpref{\_}{underscore}
+
+
+\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
+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 (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}. The \helpref{ngettext}{ngettext} macro is defined
+to do the same thing.
+See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150} for additional information on plural forms handling.
+
\membersection{::wxIsEmpty}\label{wxisempty}
\func{bool}{wxIsEmpty}{\param{const char *}{ p}}
-Returns {\tt TRUE} if the pointer is either {\tt NULL} or points to an empty
-string, {\tt FALSE} otherwise.
+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}}
+
+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-sensitive.
+
+This function complements the standard C function {\it stricmp()} which performs
+case-insensitive comparison.
+
\membersection{::wxStricmp}\label{wxstricmp}
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}}
+ \param{bool}{ subString = true}, \param{bool}{ exact = false}}
{\bf NB:} This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead.
-Returns {\tt TRUE} if the substring {\it s1} is found within {\it s2},
-ignoring case if {\it exact} is FALSE. If {\it subString} is {\tt FALSE},
+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}}
#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
\end{verbatim}
+
\membersection{::wxStrlen}\label{wxstrlen}
\func{size\_t}{wxStrlen}{\param{const char *}{ p}}
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}
\helpref{wxVsnprintf}{wxvsnprintf}, \helpref{wxString::Printf}{wxstringprintf}
+
+\membersection{wxT}\label{wxt}
+
+\func{wxChar}{wxT}{\param{char }{ch}}
+
+\func{const wxChar *}{wxT}{\param{const char *}{s}}
+
+wxT() is a macro which can be used with character and string literals (in other
+words, {\tt 'x'} or {\tt "foo"}) to automatically convert them to Unicode in
+Unicode build configuration. Please see the
+\helpref{Unicode overview}{unicode} for more information.
+
+This macro is simply returns the value passed to it without changes in ASCII
+build. In fact, its definition is:
+\begin{verbatim}
+#ifdef UNICODE
+#define wxT(x) L ## x
+#else // !Unicode
+#define wxT(x) x
+#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
+\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
+\helpref{wxGetTranslation}{wxgettranslation} function call which means that it
+cannot be used in some situations, notably for the static arrays
+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
+\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
+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}}
<wx/utils.h>
+
\membersection{::wxToUpper}\label{wxtoupper}
\func{char}{wxToUpper}{\param{char }{ch}}
<wx/utils.h>
+
\membersection{::wxVsnprintf}\label{wxvsnprintf}
\func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}}
\helpref{wxSnprintf}{wxsnprintf}, \helpref{wxString::PrintfV}{wxstringprintfv}
+
+
+\membersection{\_}\label{underscore}
+
+\func{const wxChar *}{\_}{\param{const char *}{s}}
+
+This macro expands into a call to \helpref{wxGetTranslation}{wxgettranslation}
+function, so it marks the message for the extraction by {\tt xgettext} just as
+\helpref{wxTRANSLATE}{wxtranslate} does, but also returns the translation of
+the string for the current locale during execution.
+
+Don't confuse this macro with \helpref{\_T()}{underscoret}!
+
+\wxheading{See also}
+
+\helpref{ngettext}{ngettext}
+
+
+
+\membersection{\_T}\label{underscoret}
+
+\func{wxChar}{\_T}{\param{char }{ch}}
+
+\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
+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}!
+
+
+
\section{Dialog functions}\label{dialogfunctions}
Below are a number of convenience functions for getting input from the
parameter, or (in MS Windows or Motif) the wrong window frame may be brought to
the front when the dialog box is popped up.
+
\membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
\func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
<wx/utils.h>
+
\membersection{::wxBell}\label{wxbell}
\func{void}{wxBell}{\void}
<wx/utils.h>
+
\membersection{::wxCreateFileTipProvider}\label{wxcreatefiletipprovider}
\func{wxTipProvider *}{wxCreateFileTipProvider}{\param{const wxString\& }{filename},
<wx/tipdlg.h>
+
\membersection{::wxDirSelector}\label{wxdirselector}
\func{wxString}{wxDirSelector}{\param{const wxString\& }{message = wxDirSelectorPromptStr},\\
<wx/dirdlg.h>
+
\membersection{::wxFileSelector}\label{wxfileselector}
\func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\
Cancel). For example:
\begin{verbatim}
-const wxString& s = wxFileSelector("Choose a file to open");
-if (s)
+wxString filename = wxFileSelector("Choose a file to open");
+if ( !filename.empty() )
{
- ...
+ // work with the file
+ ...
}
+//else: cancelled by user
\end{verbatim}
\wxheading{Include files}
<wx/filedlg.h>
+
\membersection{::wxEndBusyCursor}\label{wxendbusycursor}
\func{void}{wxEndBusyCursor}{\void}
<wx/utils.h>
+
\membersection{::wxGetColourFromUser}\label{wxgetcolourfromuser}
\func{wxColour}{wxGetColourFromUser}{\param{wxWindow *}{parent}, \param{const wxColour\& }{colInit}}
<wx/colordlg.h>
+
\membersection{::wxGetFontFromUser}\label{wxgetfontfromuser}
\func{wxFont}{wxGetFontFromUser}{\param{wxWindow *}{parent}, \param{const wxFont\& }{fontInit}}
<wx/fontdlg.h>
+
\membersection{::wxGetMultipleChoices}\label{wxgetmultiplechoices}
\func{size\_t}{wxGetMultipleChoices}{\\
\param{const wxArrayString\& }{aChoices},\\
\param{wxWindow *}{parent = NULL},\\
\param{int}{ x = -1}, \param{int}{ y = -1},\\
- \param{bool}{ centre = TRUE},\\
+ \param{bool}{ centre = true},\\
\param{int }{width=150}, \param{int }{height=200}}
\func{size\_t}{wxGetMultipleChoices}{\\
\param{int}{ n}, \param{const wxString\& }{choices[]},\\
\param{wxWindow *}{parent = NULL},\\
\param{int}{ x = -1}, \param{int}{ y = -1},\\
- \param{bool}{ centre = TRUE},\\
+ \param{bool}{ centre = true},\\
\param{int }{width=150}, \param{int }{height=200}}
Pops up a dialog box containing a message, OK/Cancel buttons and a
which is an array of {\it n} strings for the listbox or by using a single
{\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
-If {\it centre} is TRUE, the message text (which may include new line
-characters) is centred; if FALSE, the message is left-justified.
+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}
and {\tt choices}, and no {\tt selections} parameter; the function
returns an array containing the user selections.}
+
\membersection{::wxGetNumberFromUser}\label{wxgetnumberfromuser}
\func{long}{wxGetNumberFromUser}{
<wx/textdlg.h>
+
\membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser}
\func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
<wx/textdlg.h>
+
\membersection{::wxGetTextFromUser}\label{wxgettextfromuser}
\func{wxString}{wxGetTextFromUser}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Input text"},\\
\param{const wxString\& }{default\_value = ``"}, \param{wxWindow *}{parent = NULL},\\
- \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = TRUE}}
+ \param{int}{ x = -1}, \param{int}{ y = -1}, \param{bool}{ centre = true}}
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.
-If {\it centre} is TRUE, the message text (which may include new line characters)
-is centred; if FALSE, the message is left-justified.
+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/textdlg.h>
+
\membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice}
\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}}
+ \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection
listbox. The user may choose one or more item(s) and press OK or Cancel.
{\it choices} is an array of {\it n} strings for the listbox.
-If {\it centre} is TRUE, the message text (which may include new line characters)
-is centred; if FALSE, the message is left-justified.
+If {\it centre} is true, the message text (which may include new line characters)
+is centred; if false, the message is left-justified.
\wxheading{Include files}
<wx/choicdlg.h>
+
\membersection{::wxGetSingleChoice}\label{wxgetsinglechoice}
\func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
\param{const wxArrayString\& }{aChoices},\\
\param{wxWindow *}{parent = NULL},\\
\param{int}{ x = -1}, \param{int}{ y = -1},\\
- \param{bool}{ centre = TRUE},\\
+ \param{bool}{ centre = true},\\
\param{int }{width=150}, \param{int }{height=200}}
\func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\
\param{int}{ n}, \param{const wxString\& }{choices[]},\\
\param{wxWindow *}{parent = NULL},\\
\param{int}{ x = -1}, \param{int}{ y = -1},\\
- \param{bool}{ centre = TRUE},\\
+ \param{bool}{ centre = true},\\
\param{int }{width=150}, \param{int }{height=200}}
Pops up a dialog box containing a message, OK/Cancel buttons and a
which is an array of {\it n} strings for the listbox or by using a single
{\it aChoices} parameter of type \helpref{wxArrayString}{wxarraystring}.
-If {\it centre} is TRUE, the message text (which may include new line
-characters) is centred; if FALSE, the message is left-justified.
+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}
\perlnote{In wxPerl there is just an array reference in place of {\tt n}
and {\tt choices}.}
+
\membersection{::wxGetSingleChoiceIndex}\label{wxgetsinglechoiceindex}
\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
\param{const wxString\& }{caption},\\
\param{const wxArrayString\& }{aChoices},\\
\param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
- \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
+ \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
\func{int}{wxGetSingleChoiceIndex}{\param{const wxString\& }{message},\\
\param{const wxString\& }{caption},\\
\param{int}{ n}, \param{const wxString\& }{choices[]},\\
\param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\
- \param{bool}{ centre = TRUE}, \param{int }{width=150}, \param{int }{height=200}}
+ \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
As {\bf wxGetSingleChoice} but returns the index representing the selected
string. If the user pressed cancel, -1 is returned.
\perlnote{In wxPerl there is just an array reference in place of {\tt n}
and {\tt choices}.}
+
\membersection{::wxGetSingleChoiceData}\label{wxgetsinglechoicedata}
\func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
\param{const wxString\& }{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}}
+ \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
\func{wxString}{wxGetSingleChoiceData}{\param{const wxString\& }{message},\\
\param{const wxString\& }{caption},\\
\param{const 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}}
+ \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}}
As {\bf wxGetSingleChoice} but takes an array of client data pointers
corresponding to the strings, and returns one of these pointers or NULL if
and {\tt choices}, and the client data array must have the
same length as the choices array.}
+
\membersection{::wxIsBusy}\label{wxisbusy}
\func{bool}{wxIsBusy}{\void}
-Returns TRUE if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
+Returns true if between two \helpref{wxBeginBusyCursor}{wxbeginbusycursor} and\rtfsp
\helpref{wxEndBusyCursor}{wxendbusycursor} calls.
See also \helpref{wxBusyCursor}{wxbusycursor}.
<wx/utils.h>
+
\membersection{::wxMessageBox}\label{wxmessagebox}
-\func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \pipe wxCENTRE},\\
+\func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK},\\
\param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1}}
General purpose message dialog. {\it style} may be a bit list of the
\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.}
int answer = wxMessageBox("Quit program?", "Confirm",
wxYES_NO | wxCANCEL, main_frame);
if (answer == wxYES)
- delete main_frame;
+ main_frame->Close();
...
\end{verbatim}
{\it message} may contain newline characters, in which case the
message will be split into separate lines, to cater for large messages.
-Under Windows, the native MessageBox function is used unless wxCENTRE
-is specified in the style, in which case a generic function is used.
-This is because the native MessageBox function cannot centre text.
-The symbols are not shown when the generic function is used.
-
\wxheading{Include files}
<wx/msgdlg.h>
+
\membersection{::wxShowTip}\label{wxshowtip}
\func{bool}{wxShowTip}{\param{wxWindow *}{parent},
\param{wxTipProvider *}{tipProvider},
- \param{bool }{showAtStartup = TRUE}}
+ \param{bool }{showAtStartup = true}}
-This function shows a "startup tip" to the user.
+This function shows a "startup tip" to the user. The return value is the
+state of the ``Show tips at startup'' checkbox.
\docparam{parent}{The parent window for the modal dialog}
\docparam{tipProvider}{An object which is used to get the text of the tips.
It may be created with the \helpref{wxCreateFileTipProvider}{wxcreatefiletipprovider} function.}
-\docparam{showAtStartup}{Should be TRUE if startup tips are shown, FALSE
+\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.}
<wx/tipdlg.h>
-\section{GDI functions}\label{gdifunctions}
-The following are relevant to the GDI (Graphics Device Interface).
+
+
+\section{Math functions}
\wxheading{Include files}
-<wx/gdicmn.h>
+<wx/math.h>
-\membersection{wxBITMAP}\label{wxbitmapmacro}
+
+\membersection{wxFinite}\label{wxfinite}
+
+\func{int}{wxFinite}{\param{double }{x}}
+
+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}}
+
+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).
+
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+
+
+\membersection{wxBITMAP}\label{wxbitmapmacro}
\func{}{wxBITMAP}{bitmapName}
<wx/gdicmn.h>
+
\membersection{::wxClientDisplayRect}\label{wxclientdisplayrect}
\func{void}{wxClientDisplayRect}{\param{int *}{x}, \param{int *}{y},
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.
+Returns true if the display is colour, false otherwise.
+
\membersection{::wxDisplayDepth}\label{wxdisplaydepth}
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}}
Returns the display size in pixels.
+
\membersection{::wxDisplaySizeMM}\label{wxdisplaysizemm}
\func{void}{wxDisplaySizeMM}{\param{int *}{width}, \param{int *}{height}}
Returns the display size in millimeters.
+
\membersection{::wxDROP\_ICON}\label{wxdropicon}
\func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
<wx/dnd.h>
+
\membersection{wxICON}\label{wxiconmacro}
\func{}{wxICON}{iconName}
<wx/gdicmn.h>
+
\membersection{::wxMakeMetafilePlaceable}\label{wxmakemetafileplaceable}
\func{bool}{wxMakeMetafilePlaceable}{\param{const wxString\& }{filename}, \param{int }{minX}, \param{int }{minY},
This function is only available under Windows.
+
\membersection{::wxSetCursor}\label{wxsetcursor}
\func{void}{wxSetCursor}{\param{wxCursor *}{cursor}}
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!
<wx/dcps.h>
+
\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}
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}}
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
<wx/clipbrd.h>
+
\membersection{::wxClipboardOpen}\label{functionwxclipboardopen}
\func{bool}{wxClipboardOpen}{\void}
-Returns TRUE if this application has already opened the clipboard.
+Returns true if this application has already opened the clipboard.
+
\membersection{::wxCloseClipboard}\label{wxcloseclipboard}
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}}
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}}
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}}
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.
+Returns true if the given data format is available on the clipboard.
+
\membersection{::wxOpenClipboard}\label{wxopenclipboard}
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}}
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
+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}
+\arg{dynlib}.
+
+\wxheading{Parameters}
+
+\docparam{type}{the type of the function}
+
+\docparam{name}{the name of the function to load, not a string (without quotes,
+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
+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{wxLL}\label{wxll}
+
+\func{wxLongLong\_t}{wxLL}{\param{}{number}}
+
+This macro is defined for the platforms with a native 64 bit integer type and
+allows to define 64 bit compile time constants:
+
+\begin{verbatim}
+ #ifdef wxLongLong_t
+ wxLongLong_t ll = wxLL(0x1234567890abcdef);
+ #endif
+\end{verbatim}
+
+\wxheading{Include files}
+
+<wx/longlong.h>
+
+\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
+which 64 bit integer numbers (i.e. those of type {\tt wxLongLong\_t}) can be
+printed. Example of using it:
+
+\begin{verbatim}
+ #ifdef wxLongLong_t
+ wxLongLong_t ll = wxLL(0x1234567890abcdef);
+ printf("Long long = %" wxLongLongFmtSpec "x\n", ll);
+ #endif
+\end{verbatim}
+
+\wxheading{See also}
+
+\helpref{wxLL}{wxll}
+
+\wxheading{Include files}
+
+<wx/longlong.h>
+
+
\membersection{::wxNewId}\label{wxnewid}
\func{long}{wxNewId}{\void}
<wx/utils.h>
+
\membersection{::wxRegisterId}\label{wxregisterid}
\func{void}{wxRegisterId}{\param{long}{ id}}
<wx/utils.h>
+
\membersection{::wxDDECleanUp}\label{wxddecleanup}
\func{void}{wxDDECleanUp}{\void}
<wx/dde.h>
+
\membersection{::wxDDEInitialize}\label{wxddeinitialize}
\func{void}{wxDDEInitialize}{\void}
<wx/dde.h>
+
\membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
-\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}}
+\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = true}}
This function enables or disables all top level windows. It is used by
\helpref{::wxSafeYield}{wxsafeyield}.
<wx/utils.h>
+
\membersection{::wxFindMenuItemId}\label{wxfindmenuitemid}
\func{int}{wxFindMenuItemId}{\param{wxFrame *}{frame}, \param{const wxString\& }{menuString}, \param{const wxString\& }{itemString}}
<wx/utils.h>
+
\membersection{::wxFindWindowByLabel}\label{wxfindwindowbylabel}
\func{wxWindow *}{wxFindWindowByLabel}{\param{const wxString\& }{label}, \param{wxWindow *}{parent=NULL}}
-{\bf NB:} This function is obsolete, please use
+{\bf NB:} This function is obsolete, please use
\helpref{wxWindow::FindWindowByLabel}{wxwindowfindwindowbylabel} instead.
Find a window by its label. Depending on the type of window, the label may be a window title
<wx/utils.h>
+
\membersection{::wxFindWindowByName}\label{wxfindwindowbyname}
\func{wxWindow *}{wxFindWindowByName}{\param{const wxString\& }{name}, \param{wxWindow *}{parent=NULL}}
-{\bf NB:} This function is obsolete, please use
+{\bf NB:} This function is obsolete, please use
\helpref{wxWindow::FindWindowByName}{wxwindowfindwindowbyname} instead.
Find a window by its name (as given in a window constructor or {\bf Create} function call).
<wx/utils.h>
+
\membersection{::wxFindWindowAtPoint}\label{wxfindwindowatpoint}
\func{wxWindow *}{wxFindWindowAtPoint}{\param{const wxPoint\& }{pt}}
Find the deepest window at the given mouse position in screen coordinates,
returning the window if found, or NULL if not.
+
\membersection{::wxFindWindowAtPointer}\label{wxfindwindowatpointer}
\func{wxWindow *}{wxFindWindowAtPointer}{\param{wxPoint\& }{pt}}
Find the deepest window at the mouse pointer position, returning the window
and current pointer position in screen coordinates.
+
\membersection{::wxGetActiveWindow}\label{wxgetactivewindow}
\func{wxWindow *}{wxGetActiveWindow}{\void}
<wx/windows.h>
+
\membersection{::wxGetDisplayName}\label{wxgetdisplayname}
\func{wxString}{wxGetDisplayName}{\void}
<wx/utils.h>
+
\membersection{::wxGetMousePosition}\label{wxgetmouseposition}
\func{wxPoint}{wxGetMousePosition}{\void}
<wx/utils.h>
+
\membersection{::wxGetResource}\label{wxgetresource}
\func{bool}{wxGetResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
<wx/utils.h>
+
\membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
\func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}
<wx/window.h>
+
\membersection{::wxLoadUserResource}\label{wxloaduserresource}
\func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
where {\tt file.ext} is a file that the resource compiler can find.
-One use of this is to store {\tt .wxr} files instead of including the data in the C++ file; some compilers
-cannot cope with the long strings in a {\tt .wxr} file. The resource data can then be parsed
-using \helpref{wxResourceParseString}{wxresourceparsestring}.
-
This function is available under Windows only.
\wxheading{Include files}
<wx/utils.h>
+
\membersection{::wxPostDelete}\label{wxpostdelete}
\func{void}{wxPostDelete}{\param{wxObject *}{object}}
<wx/utils.h>
+
\membersection{::wxPostEvent}\label{wxpostevent}
\func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}}
<wx/app.h>
+
\membersection{::wxSetDisplayName}\label{wxsetdisplayname}
\func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}}
<wx/utils.h>
+
\membersection{::wxStripMenuCodes}\label{wxstripmenucodes}
\func{wxString}{wxStripMenuCodes}{\param{const wxString\& }{in}}
\func{void}{wxStripMenuCodes}{\param{char *}{in}, \param{char *}{out}}
-{\bf NB:} This function is obsolete, please use
+{\bf NB:} This function is obsolete, please use
\helpref{wxMenuItem::GetLabelFromText}{wxmenuitemgetlabelfromtext} instead.
Strips any menu codes from {\it in} and places the result
<wx/utils.h>
+
+\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}
+
+<wx/longlong.h>
+
+\wxheading{See also}
+
+\helpref{wxLL}{wxll}, \helpref{wxLongLong}{wxlonglong}
+
+
\membersection{::wxWriteResource}\label{wxwriteresource}
\func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
<wx/utils.h>
+
+
\section{Byte order macros}\label{byteordermacros}
The endian-ness issues (that is the difference between big-endian and
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}}
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}}
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}}
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
\helpref{RTTI overview}{runtimeclassoverview}
+
\membersection{CLASSINFO}\label{classinfo}
\func{wxClassInfo *}{CLASSINFO}{className}
<wx/object.h>
+
\membersection{DECLARE\_ABSTRACT\_CLASS}\label{declareabstractclass}
\func{}{DECLARE\_ABSTRACT\_CLASS}{className}
<wx/object.h>
+
\membersection{DECLARE\_APP}\label{declareapp}
\func{}{DECLARE\_APP}{className}
-This is used in headers to create a forward declaration of the wxGetApp function implemented
-by IMPLEMENT\_APP. It creates the declaration {\tt className\& wxGetApp(void)}.
+This is used in headers to create a forward declaration of the
+\helpref{wxGetApp}{wxgetapp} function implemented by
+\helpref{IMPLEMENT\_APP}{implementapp}. It creates the declaration
+{\tt className\& wxGetApp(void)}.
Example:
<wx/app.h>
+
\membersection{DECLARE\_CLASS}\label{declareclass}
\func{}{DECLARE\_CLASS}{className}
<wx/object.h>
+
\membersection{DECLARE\_DYNAMIC\_CLASS}\label{declaredynamicclass}
\func{}{DECLARE\_DYNAMIC\_CLASS}{className}
DECLARE_DYNAMIC_CLASS(wxFrame)
private:
- const wxString\& frameTitle;
+ const wxString& frameTitle;
public:
...
};
<wx/object.h>
+
\membersection{IMPLEMENT\_ABSTRACT\_CLASS}\label{implementabstractclass}
\func{}{IMPLEMENT\_ABSTRACT\_CLASS}{className, baseClassName}
<wx/object.h>
+
\membersection{IMPLEMENT\_ABSTRACT\_CLASS2}\label{implementabstractclass2}
\func{}{IMPLEMENT\_ABSTRACT\_CLASS2}{className, baseClassName1, baseClassName2}
<wx/object.h>
+
\membersection{IMPLEMENT\_APP}\label{implementapp}
\func{}{IMPLEMENT\_APP}{className}
<wx/app.h>
+
\membersection{IMPLEMENT\_CLASS}\label{implementclass}
\func{}{IMPLEMENT\_CLASS}{className, baseClassName}
<wx/object.h>
+
\membersection{IMPLEMENT\_CLASS2}\label{implementclass2}
\func{}{IMPLEMENT\_CLASS2}{className, baseClassName1, baseClassName2}
<wx/object.h>
+
\membersection{IMPLEMENT\_DYNAMIC\_CLASS}\label{implementdynamicclass}
\func{}{IMPLEMENT\_DYNAMIC\_CLASS}{className, baseClassName}
<wx/object.h>
+
\membersection{IMPLEMENT\_DYNAMIC\_CLASS2}\label{implementdynamicclass2}
\func{}{IMPLEMENT\_DYNAMIC\_CLASS2}{className, baseClassName1, baseClassName2}
<wx/object.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}
<wx/object.h>
+
\membersection{wxDynamicCast}\label{wxdynamiccast}
\func{classname *}{wxDynamicCast}{ptr, classname}
\helpref{wxConstCast}{wxconstcast}\\
\helpref{wxStatiicCast}{wxstaticcast}
+
\membersection{wxDynamicCastThis}\label{wxdynamiccastthis}
\func{classname *}{wxDynamicCastThis}{classname}
\helpref{wxDynamicCast}{wxdynamiccast}
+
\membersection{wxStaticCast}\label{wxstaticcast}
\func{classname *}{wxStaticCast}{ptr, classname}
\helpref{wxDynamicCast}{wxdynamiccast}\\
\helpref{wxConstCast}{wxconstcast}
-\section{Resource functions}\label{resourcefuncs}
-
-\overview{Resource functions}{resourceformats}
-
-This section details functions for manipulating wxWindows (.WXR) resource
-files and loading user interface elements from resources.
-
-\normalbox{Please note that this use of the word `resource' is different from that used when talking
-about initialisation file resource reading and writing, using such functions
-as wxWriteResource and wxGetResource. It is just an unfortunate clash of terminology.}
-
-\helponly{For an overview of the wxWindows resource mechanism, see \helpref{the wxWindows resource system}{resourceformats}.}
-
-See also \helpref{wxWindow::LoadFromResource}{wxwindowloadfromresource} for
-loading from resource data.
-
-\membersection{::wxResourceAddIdentifier}\label{wxresourceaddidentifier}
-
-\func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
-
-Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
-{\tt\#}defining a name to an integer). Unlikely to be used by an application except
-perhaps for implementing resource functionality for interpreted languages.
-
-\membersection{::wxResourceClear}\label{wxresourceclear}
-
-\func{void}{wxResourceClear}{\void}
-
-Clears the wxWindows resource table.
-
-\membersection{::wxResourceCreateBitmap}\label{wxresourcecreatebitmap}
-
-\func{wxBitmap *}{wxResourceCreateBitmap}{\param{const wxString\& }{resource}}
-
-Creates a new bitmap from a file, static data, or Windows resource, given a valid
-wxWindows bitmap resource identifier. For example, if the .WXR file contains
-the following:
-
-\begin{verbatim}
-static const wxString\& project_resource = "bitmap(name = 'project_resource',\
- bitmap = ['project', wxBITMAP_TYPE_BMP_RESOURCE, 'WINDOWS'],\
- bitmap = ['project.xpm', wxBITMAP_TYPE_XPM, 'X']).";
-\end{verbatim}
-
-then this function can be called as follows:
-
-\begin{verbatim}
- wxBitmap *bitmap = wxResourceCreateBitmap("project_resource");
-\end{verbatim}
-
-\membersection{::wxResourceCreateIcon}\label{wxresourcecreateicon}
-
-\func{wxIcon *}{wxResourceCreateIcon}{\param{const wxString\& }{resource}}
-
-Creates a new icon from a file, static data, or Windows resource, given a valid
-wxWindows icon resource identifier. For example, if the .WXR file contains
-the following:
-
-\begin{verbatim}
-static const wxString\& project_resource = "icon(name = 'project_resource',\
- icon = ['project', wxBITMAP_TYPE_ICO_RESOURCE, 'WINDOWS'],\
- icon = ['project', wxBITMAP_TYPE_XBM_DATA, 'X']).";
-\end{verbatim}
-
-then this function can be called as follows:
-
-\begin{verbatim}
- wxIcon *icon = wxResourceCreateIcon("project_resource");
-\end{verbatim}
-
-\membersection{::wxResourceCreateMenuBar}\label{wxresourcecreatemenubar}
-
-\func{wxMenuBar *}{wxResourceCreateMenuBar}{\param{const wxString\& }{resource}}
-
-Creates a new menu bar given a valid wxWindows menubar resource
-identifier. For example, if the .WXR file contains the following:
-
-\begin{verbatim}
-static const wxString\& menuBar11 = "menu(name = 'menuBar11',\
- menu = \
- [\
- ['&File', 1, '', \
- ['&Open File', 2, 'Open a file'],\
- ['&Save File', 3, 'Save a file'],\
- [],\
- ['E&xit', 4, 'Exit program']\
- ],\
- ['&Help', 5, '', \
- ['&About', 6, 'About this program']\
- ]\
- ]).";
-\end{verbatim}
-
-then this function can be called as follows:
-
-\begin{verbatim}
- wxMenuBar *menuBar = wxResourceCreateMenuBar("menuBar11");
-\end{verbatim}
-
-
-\membersection{::wxResourceGetIdentifier}\label{wxresourcegetidentifier}
-
-\func{int}{wxResourceGetIdentifier}{\param{const wxString\& }{name}}
-
-Used for retrieving the integer value associated with an identifier.
-A zero value indicates that the identifier was not found.
-
-See \helpref{wxResourceAddIdentifier}{wxresourceaddidentifier}.
-
-\membersection{::wxResourceParseData}\label{wxresourcedata}
-
-\func{bool}{wxResourceParseData}{\param{const wxString\& }{resource}, \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
-C++ program, then this function must be called for each variable
-containing the resource data, to make it known to wxWindows.
-
-{\it resource} should contain data in the following form:
-
-\begin{verbatim}
-dialog(name = 'dialog1',
- style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
- title = 'Test dialog box',
- x = 312, y = 234, width = 400, height = 300,
- modal = 0,
- control = [1000, wxStaticBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
- [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
- control = [1001, wxTextCtrl, '', 'wxTE_MULTILINE', 'text3',
- 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
- [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
- [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
-\end{verbatim}
-
-This function will typically be used after including a {\tt .wxr} file into
-a C++ program as follows:
-
-\begin{verbatim}
-#include "dialog1.wxr"
-\end{verbatim}
-
-Each of the contained resources will declare a new C++ variable, and each
-of these variables should be passed to wxResourceParseData.
-
-\membersection{::wxResourceParseFile}\label{wxresourceparsefile}
-\func{bool}{wxResourceParseFile}{\param{const wxString\& }{filename}, \param{wxResourceTable *}{table = NULL}}
-
-Parses a file containing one or more wxWindows resource objects
-in C++-compatible syntax. Use this function to dynamically load
-wxWindows resource data.
-
-\membersection{::wxResourceParseString}\label{wxresourceparsestring}
-
-\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
-C++ program, then this function must be called for each variable
-containing the resource data, to make it known to wxWindows.
-
-{\it resource} should contain data with the following form:
-
-\begin{verbatim}
-dialog(name = 'dialog1',
- style = 'wxCAPTION | wxDEFAULT_DIALOG_STYLE',
- title = 'Test dialog box',
- x = 312, y = 234, width = 400, height = 300,
- modal = 0,
- control = [1000, wxStaticBox, 'Groupbox', '0', 'group6', 5, 4, 380, 262,
- [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]],
- control = [1001, wxTextCtrl, '', 'wxTE_MULTILINE', 'text3',
- 156, 126, 200, 70, 'wxWindows is a multi-platform, GUI toolkit.',
- [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0],
- [11, 'wxSWISS', 'wxNORMAL', 'wxNORMAL', 0]]).
-\end{verbatim}
-
-This function will typically be used after calling \helpref{wxLoadUserResource}{wxloaduserresource} to
-load an entire {\tt .wxr file} into a string.
-
-\membersection{::wxResourceRegisterBitmapData}\label{registerbitmapdata}
-
-\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}}
-
-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}\label{wxresourceregistericondata}
-
-Another name for \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}.
\section{Log functions}\label{logfunctions}
<wx/log.h>
+
\membersection{::wxDebugMsg}\label{wxdebugmsg}
\func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
<wx/utils.h>
+
\membersection{::wxError}\label{wxerror}
\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
-{\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
+{\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror}
instead.
Displays {\it msg} and continues. This writes to standard error under
<wx/utils.h>
+
\membersection{::wxFatalError}\label{wxfatalerror}
\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}}
-{\bf NB:} This function is now obsolete, please use
+{\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,
<wx/utils.h>
+
\membersection{::wxLogError}\label{wxlogerror}
\func{void}{wxLogError}{\param{const char *}{formatString}, \param{...}{}}
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{...}{}}
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{...}{}}
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{...}{}}
that the later error messages make the informational messages preceding them
meaningless.
+
\membersection{::wxLogVerbose}\label{wxlogverbose}
\func{void}{wxLogVerbose}{\param{const char *}{formatString}, \param{...}{}}
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{...}{}}
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{...}{}}
\helpref{wxSysErrorCode}{wxsyserrorcode},
\helpref{wxSysErrorMsg}{wxsyserrormsg}
+
\membersection{::wxLogDebug}\label{wxlogdebug}
\func{void}{wxLogDebug}{\param{const char *}{formatString}, \param{...}{}}
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{...}{}}
\item wxTraceOleCalls: trace OLE method calls (Win32 only)
\end{itemize}
+
\membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
\func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}
This function shows a message to the user in a safe way and should be safe to
call even before the application has been initialized or if it is currently in
some other strange state (for example, about to crash). Under Windows this
-function shows a message box using a native dialog instead of
+function shows a message box using a native dialog instead of
\helpref{wxMessageBox}{wxmessagebox} (which might be unsafe to call), elsewhere
it simply prints the message to the standard output using the title as prefix.
<wx/log.h>
+
\membersection{::wxSysErrorCode}\label{wxsyserrorcode}
\func{unsigned long}{wxSysErrorCode}{\void}
\helpref{wxSysErrorMsg}{wxsyserrormsg},
\helpref{wxLogSysError}{wxlogsyserror}
+
\membersection{::wxSysErrorMsg}\label{wxsyserrormsg}
\func{const wxChar *}{wxSysErrorMsg}{\param{unsigned long }{errCode = 0}}
\helpref{wxSysErrorCode}{wxsyserrorcode},
\helpref{wxLogSysError}{wxlogsyserror}
+
\membersection{WXTRACE}\label{trace}
\wxheading{Include files}
<wx/memory.h>
+
\membersection{WXTRACELEVEL}\label{tracelevel}
\func{}{WXTRACELEVEL}{level, formatString, ...}
<wx/memory.h>
+
\membersection{::wxTrace}\label{wxtrace}
\func{void}{wxTrace}{\param{const wxString\& }{fmt}, \param{...}{}}
<wx/memory.h>
+
\membersection{::wxTraceLevel}\label{wxtracelevel}
\func{void}{wxTraceLevel}{\param{int}{ level}, \param{const wxString\& }{fmt}, \param{...}{}}
<wx/memory.h>
+
+
\section{Time functions}\label{timefunctions}
The functions in this section deal with getting the current time and
\helpref{wxDateTime::Now}{wxdatetimenow} or
\helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
+
\membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
-\func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = TRUE}}
+\func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = true}}
Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
-If {\it resetTimer} is TRUE (the default), the timer is reset to zero
+If {\it resetTimer} is true (the default), the timer is reset to zero
by this call.
See also \helpref{wxTimer}{wxtimer}.
<wx/timer.h>
+
\membersection{::wxGetLocalTime}\label{wxgetlocaltime}
\func{long}{wxGetLocalTime}{\void}
<wx/timer.h>
+
\membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
\func{wxLongLong}{wxGetLocalTimeMillis}{\void}
<wx/timer.h>
+
\membersection{::wxGetUTCTime}\label{wxgetutctime}
\func{long}{wxGetUTCTime}{\void}
<wx/timer.h>
+
\membersection{::wxNow}\label{wxnow}
\func{wxString}{wxNow}{\void}
<wx/utils.h>
+
\membersection{::wxSleep}\label{wxsleep}
\func{void}{wxSleep}{\param{int}{ secs}}
<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}}
<wx/utils.h>
+
+
\section{Debugging macros and functions}\label{debugmacros}
Useful macros and functions for error checking and defensive programming.
<wx/debug.h>
+
\membersection{::wxOnAssert}\label{wxonassert}
-\func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{msg = NULL}}
+\func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
This function is called whenever one of debugging macros fails (i.e. condition
is false in an assertion). It is only defined in the debug mode, in release
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
+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}}
-Assert macro. An error message will be generated if the condition is FALSE in
+Assert macro. An error message will be generated if the condition is false in
debug mode, but nothing will be done in the release build.
Please note that the condition in wxASSERT() should have no side effects
\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
+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.
wxASSERT_MIN_BITSIZE(wchar_t, 16);
\end{verbatim}
+
\membersection{wxASSERT\_MSG}\label{wxassertmsg}
\func{}{wxASSERT\_MSG}{\param{}{condition}, \param{}{msg}}
-Assert macro with message. An error message will be generated if the condition is FALSE.
+Assert macro with message. An error message will be generated if the condition is false.
\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}}
the {\it msg} identifier - please note that it must be a valid C++ identifier
and not a string unlike in the other cases.
-This macro is mostly useful for testing the expressions involving the
+This macro is mostly useful for testing the expressions involving the
{\tt sizeof} operator as they can't be tested by the preprocessor but it is
sometimes desirable to test them at the compile time.
Note that this macro internally declares a struct whose name it tries to make
unique by using the {\tt \_\_LINE\_\_} in it but it may still not work if you
use it on the same line in two different source files. In this case you may
-either change the line in which either of them appears on or use the
+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}}
-This macro is identical to \helpref{wxCOMPILE\_TIME\_ASSERT2}{wxcompiletimeassert2}
+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}
\func{}{wxFAIL}{\void}
See also: \helpref{wxFAIL\_MSG}{wxfailmsg}
+
\membersection{wxFAIL\_MSG}\label{wxfailmsg}
\func{}{wxFAIL\_MSG}{\param{}{msg}}
\helpref{wxFAIL}{wxfail}
+
\membersection{wxCHECK}\label{wxcheck}
\func{}{wxCHECK}{\param{}{condition}, \param{}{retValue}}
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}}
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}}
This macro should be used in void functions instead of
\helpref{wxCHECK\_MSG}{wxcheckmsg}.
+
\membersection{wxCHECK2}\label{wxcheck2}
\func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}}
This check is done even in release mode.
+
\membersection{wxCHECK2\_MSG}\label{wxcheck2msg}
\func{}{wxCHECK2}{\param{}{condition}, \param{}{operation}, \param{}{msg}}
\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}
<wx/debug.h>
+
+
+\membersection{::wxIsDebuggerRunning}\label{wxisdebuggerrunning}
+
+\func{bool}{wxIsDebuggerRunning}{\void}
+
+Returns {\tt true} if the program is running under debugger, {\tt false}
+otherwise.
+
+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
<wx/utils.h>
+
\membersection{wxGetenv}\label{wxgetenvmacro}
\func{wxChar *}{wxGetEnv}{\param{const wxString\&}{ var}}
with \helpref{wxSetEnv}{wxsetenv}, use \helpref{wxGetEnv}{wxgetenv} function
instead.
+
\membersection{wxGetEnv}\label{wxgetenv}
\func{bool}{wxGetEnv}{\param{const wxString\&}{ var}, \param{wxString *}{value}}
{\it value} may be {\tt NULL} if you just want to know if the variable exists
and are not interested in its value.
-Returns {\tt TRUE} if the variable exists, {\tt FALSE} otherwise.
+Returns {\tt true} if the variable exists, {\tt false} otherwise.
+
\membersection{wxSetEnv}\label{wxsetenv}
Sets the value of the environment variable {\it var} (adding it if necessary)
to {\it value}.
-Returns {\tt TRUE} on success.
+Returns {\tt true} on success.
+
\membersection{wxUnsetEnv}\label{wxunsetenv}
\helpref{wxGetEnv}{wxgetenv} will return {\tt NULL} after the call to this
function.
-Returns {\tt TRUE} on success.
+Returns {\tt true} on success.
projects / wxWidgets.git / blobdiff