X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0bbe4e299cbd52fa9bef7819ec533cc6be9348f6..559b61bf8c4109ac0d7d3eddc4604937f2934a81:/docs/latex/wx/function.tex diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 2e04f4c8d6..335c34f955 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -49,6 +49,10 @@ the corresponding topic. \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}\\ @@ -64,6 +68,7 @@ the corresponding topic. \helpref{wxEmptyClipboard}{wxemptyclipboard}\\ \helpref{wxEnableTopLevelWindows}{wxenabletoplevelwindows}\\ \helpref{wxEndBusyCursor}{wxendbusycursor}\\ +\helpref{wxENTER\_CRIT\_SECT}{wxentercritsect}\\ \helpref{wxEntry}{wxentry}\\ \helpref{wxEnumClipboardFormats}{wxenumclipboardformats}\\ \helpref{wxError}{wxerror}\\ @@ -84,7 +89,9 @@ the corresponding topic. \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}\\ @@ -142,9 +149,13 @@ the corresponding topic. \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}\\ @@ -174,17 +185,6 @@ the corresponding topic. \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}\\ @@ -209,6 +209,7 @@ the corresponding topic. \helpref{wxSplitPath}{wxsplitfunction}\\ \helpref{wxStartTimer}{wxstarttimer}\\ \helpref{wxStaticCast}{wxstaticcast}\\ +\helpref{wxStrcmp}{wxstrcmp}\\ \helpref{wxStricmp}{wxstricmp}\\ \helpref{wxStringEq}{wxstringeq}\\ \helpref{wxStringMatch}{wxstringmatch}\\ @@ -343,6 +344,21 @@ int CTheApp::ExitInstance() + +\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}} @@ -443,7 +459,7 @@ the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and \wxheading{Include files} - + \section{Process control functions}\label{processfunctions} @@ -519,8 +535,13 @@ a process (always synchronously) and capture its output in the array {\it output}. The fourth version adds the possibility to additionally capture the messages from standard error output in the {\it errors} array. -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} @@ -658,6 +679,16 @@ and that this function is only implemented under Unix and Win32. \section{Thread functions}\label{threadfunctions} +The functions and macros here mainly exist to make it writing the code which +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} @@ -666,6 +697,85 @@ and that this function is only implemented under Unix and Win32. \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} @@ -1124,7 +1234,9 @@ Gets operating system version information. \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.} @@ -1212,6 +1324,16 @@ as wxGetTranslation. Returns {\tt true} if the pointer is either {\tt NULL} or points to an empty string, {\tt false} otherwise. +\membersection{::wxStrcmp}\label{wxstrcmp} + +\func{int}{wxStrcmp}{\param{const char *}{p1}, \param{const char *}{p2}} + +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} \func{int}{wxStricmp}{\param{const char *}{p1}, \param{const char *}{p2}} @@ -1799,7 +1921,7 @@ See also \helpref{wxBusyCursor}{wxbusycursor}. \membersection{::wxMessageBox}\label{wxmessagebox} -\func{int}{wxMessageBox}{\param{const wxString\& }{message}, \param{const wxString\& }{caption = ``Message"}, \param{int}{ style = wxOK \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 @@ -1811,7 +1933,6 @@ wxCANCEL.} \twocolitem{wxCANCEL}{Puts a Cancel button on the message box. May be combined with wxYES\_NO or wxOK.} \twocolitem{wxOK}{Puts an Ok button on the message box. May be combined with wxCANCEL.} -\twocolitem{wxCENTRE}{Centres the text.} \twocolitem{wxICON\_EXCLAMATION}{Displays an exclamation mark symbol.} \twocolitem{wxICON\_HAND}{Displays an error symbol.} \twocolitem{wxICON\_ERROR}{Displays an error symbol - the same as wxICON\_HAND.} @@ -1835,11 +1956,6 @@ For example: {\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} @@ -1870,6 +1986,28 @@ checkbox which is shown in the tips dialog.} + +\section{Math functions} + +\wxheading{Include files} + + + +\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). @@ -2472,10 +2610,6 @@ myResource TEXT file.ext 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} @@ -2690,8 +2824,10 @@ class wxCommand: public wxObject \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: @@ -2951,201 +3087,6 @@ result of executing an equivalent of {\tt static\_cast(ptr)}. \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} These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for @@ -3771,6 +3712,18 @@ In release mode this function does nothing. + +\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