\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{wxFindWindowByLabel}{wxfindwindowbylabel}\\
\helpref{wxFindWindowByName}{wxfindwindowbyname}\\
\helpref{wxGetActiveWindow}{wxgetactivewindow}\\
+\helpref{wxGetApp}{wxgetapp}\\
\helpref{wxGetClipboardData}{wxgetclipboarddata}\\
\helpref{wxGetClipboardFormatName}{wxgetclipboardformatname}\\
\helpref{wxGetColourFromUser}{wxgetcolourfromuser}\\
\helpref{wxStrlen}{wxstrlen}\\
\helpref{wxSysErrorCode}{wxsyserrorcode}\\
\helpref{wxSysErrorMsg}{wxsyserrormsg}\\
+\helpref{wxT}{wxt}\\
\helpref{wxToLower}{wxtolower}\\
\helpref{wxToUpper}{wxtoupper}\\
\helpref{wxTraceLevel}{wxtracelevel}\\
\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}
}
\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
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}
\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.
\membersection{::wxSafeYield}\label{wxsafeyield}
\func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}, \param{bool}{
- onlyIfNeeded = FALSE}}
+ 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
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
\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}
\func{bool}{wxDirExists}{\param{const wxString\& }{dirname}}
-Returns TRUE if the directory exists.
+Returns true if the directory exists.
\membersection{::wxDos2UnixFilename}\label{wxdos2unixfilename}
\func{bool}{wxFileExists}{\param{const wxString\& }{filename}}
-Returns TRUE if the file exists. It also returns TRUE if the file is
+Returns true if the file exists. It also returns true if the file is
a directory.
\membersection{::wxFileModificationTime}\label{wxfilemodificationtime}
\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}
\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}
\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{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.
\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.
\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}
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}
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}
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}
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}
This function is deprecated, use \helpref{wxString}{wxstring} class instead.
+\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 (and also common in Unix world) syntax is
+provided: the \helpref{\_()}{underscore} macro is defined to do the same thing
+as wxGetTranslation.
+
\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{::wxStricmp}\label{wxstricmp}
\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}
same thing (i.e. returns the length of the string) except that it returns 0 if
{\it p} is the {\tt NULL} pointer.
-\membersection{::wxGetTranslation}\label{wxgettranslation}
-
-\func{const char *}{wxGetTranslation}{\param{const char * }{str}}
-
-This function returns the translation of string {\it str} in the current
-\helpref{locale}{wxlocale}. If the string is not found in any of the loaded
-message catalogs (see \helpref{internationalization overview}{internationalization}), the
-original string is returned. In debug build, an error message is logged - this
-should help to find the strings which were not yet translated. As this function
-is used very often, an alternative syntax is provided: the \_() macro is
-defined as wxGetTranslation().
-
\membersection{::wxSnprintf}\label{wxsnprintf}
\func{int}{wxSnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{}{...}}
\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}}
\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}!
+
+
+\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}!
+
+\membersection{\_}\label{underscore}
+
\section{Dialog functions}\label{dialogfunctions}
Below are a number of convenience functions for getting input from the
\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}
\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}
\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}
\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}
\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.
\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
\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}.
\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. The return value is the
state of the ``Show tips at startup'' checkbox.
\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.}
\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}
\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}
\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}
\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}.
\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:
\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}.
\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
\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}
{\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