X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0bbe4e299cbd52fa9bef7819ec533cc6be9348f6..27bb2b7cea271d91e272452ff361f948e38dc539:/docs/latex/wx/function.tex diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 2e04f4c8d6..f682056732 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -84,7 +84,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}\\ @@ -143,6 +145,7 @@ the corresponding topic. \helpref{wxIsBusy}{wxisbusy}\\ \helpref{wxIsClipboardFormatAvailable}{wxisclipboardformatavailable}\\ \helpref{wxIsEmpty}{wxisempty}\\ +\helpref{wxIsNaN}{wxisnan}\\ \helpref{wxIsWild}{wxiswild}\\ \helpref{wxKill}{wxkill}\\ \helpref{wxLoadUserResource}{wxloaduserresource}\\ @@ -343,6 +346,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}} @@ -519,8 +537,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} @@ -1124,7 +1147,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.} @@ -1870,6 +1895,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). @@ -2690,8 +2737,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: