X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6aa358aebb951956f0e0ab645788e00a4b904886..fd495ab3ea1282ddb8bb0cd0fb79fc758ae5fcee:/docs/latex/wx/function.tex?ds=sidebyside diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index d23f7160f2..aab0d2bcb6 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -461,15 +461,34 @@ if successful, FALSE otherwise. Makes a copy of the string {\it s} using the C++ new operator, so it can be deleted with the {\it delete} operator. +\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. + +\membersection{::wxStricmp}\label{wxstricmp} + +\func{int}{wxStricmp}{\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-insensitive. + +This function complements the standard C function {\it strcmp()} which performs +case-sensitive comparison. + \membersection{::wxStringMatch} \func{bool}{wxStringMatch}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2},\\ \param{bool}{ subString = TRUE}, \param{bool}{ exact = FALSE}} -Returns TRUE if the substring {\it s1} is found within {\it s2}, -ignoring case if {\it exact} is FALSE. If {\it subString} is 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. +This function is obsolete, use \helpref{wxString::Find}{wxstringfind} instead. + \membersection{::wxStringEq}\label{wxstringeq} \func{bool}{wxStringEq}{\param{const wxString\& }{s1}, \param{const wxString\& }{s2}} @@ -480,30 +499,15 @@ A macro defined as: #define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0)) \end{verbatim} -\membersection{::IsEmpty}\label{isempty} - -\func{bool}{IsEmpty}{\param{const char *}{ p}} - -Returns TRUE if the string is empty, FALSE otherwise. It is safe to pass NULL -pointer to this function and it will return TRUE for it. - -\membersection{::Stricmp}\label{stricmp} - -\func{int}{Stricmp}{\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-insensitive. - -This function complements the standard C function {\it strcmp()} which performs -case-sensitive comparison. +This function is obsolete, use \helpref{wxString}{wxstring} instead. -\membersection{::Strlen}\label{strlen} +\membersection{::wxStrlen}\label{wxstrlen} -\func{size\_t}{Strlen}{\param{const char *}{ p}} +\func{size\_t}{wxStrlen}{\param{const char *}{ p}} This is a safe version of standard function {\it strlen()}: it does exactly the same thing (i.e. returns the length of the string) except that it returns 0 if -{\it p} is the NULL pointer. +{\it p} is the {\tt NULL} pointer. \membersection{::wxGetTranslation}\label{wxgettranslation} @@ -1749,30 +1753,40 @@ normal way which usually just means that the application will be terminated. Calling wxHandleFatalExceptions() with {\it doIt} equal to FALSE will restore this default behaviour. -\membersection{::wxKill}\label{wxkill} +\membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers} -\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig}} +\func{void}{wxInitAllImageHandlers}{\void} -Under Unix (the only supported platform), equivalent to the Unix kill function. -Returns 0 on success, -1 on failure. +Initializes all available image handlers. For a list of available handlers, +see \helpref{wxImage}{wximage}. -Tip: sending a signal of 0 to a process returns -1 if the process does not exist. -It does not raise a signal in the receiving process. +\wxheading{See also} + +\helpref{wxImage}{wximage}, \helpref{wxImageHandler}{wximagehandler} \wxheading{Include files} - + -\membersection{::wxInitAllImageHandlers}\label{wxinitallimagehandlers} +\membersection{::wxInitialize}\label{wxinitialize} -\func{void}{wxInitAllImageHandlers}{\void} +\func{bool}{wxInitialize}{\void} -Initializes all available image handlers. For a list of available handlers, -see \helpref{wxImage}{wximage}. +This function is used in wxBase only and only if you don't create +\helpref{wxApp}{wxapp} object at all. In this case you must call it from your +{\tt main()} function before calling any other wxWindows functions. -\wxheading{See also} +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. -\helpref{wxImage}{wximage}, \helpref{wxImageHandler}{wximagehandler} +This function may be called several times but +\helpref{wxUninitialize}{wxuninitialize} must be called for each successful +call to this function. + +\wxheading{Include files} + + \membersection{::wxIsBusy}\label{wxisbusy} @@ -1787,6 +1801,63 @@ See also \helpref{wxBusyCursor}{wxbusycursor}. +\membersection{::wxKill}\label{wxkill} + +\func{int}{wxKill}{\param{long}{ pid}, \param{int}{ sig = wxSIGTERM}, \param{wxKillError }{*rc = NULL}} + +Equivalent to the Unix kill function: send the given signal {\it sig} to the +process with PID {\it pid}. The valud signal values are + +\begin{verbatim} +enum wxSignal +{ + wxSIGNONE = 0, // verify if the process exists under Unix + wxSIGHUP, + wxSIGINT, + wxSIGQUIT, + wxSIGILL, + wxSIGTRAP, + wxSIGABRT, + wxSIGEMT, + wxSIGFPE, + wxSIGKILL, // forcefully kill, dangerous! + wxSIGBUS, + wxSIGSEGV, + wxSIGSYS, + wxSIGPIPE, + wxSIGALRM, + wxSIGTERM // terminate the process gently +}; +\end{verbatim} + +{\tt wxSIGNONE}, {\tt wxSIGKILL} and {\tt wxSIGTERM} have the same meaning +under both Unix and Windows but all the other signals are equivalent to +{\tt wxSIGTERM} under Windows. + +Returns 0 on success, -1 on failure. If {\it rc} parameter is not NULL, it will +be filled with an element of {\tt wxKillError} enum: + +\begin{verbatim} +enum wxKillError +{ + wxKILL_OK, // no error + wxKILL_BAD_SIGNAL, // no such signal + wxKILL_ACCESS_DENIED, // permission denied + wxKILL_NO_PROCESS, // no such process + wxKILL_ERROR // another, unspecified error +}; +\end{verbatim} + +\wxheading{See also} + +\helpref{wxProcess::Kill}{wxprocesskill},\rtfsp +\helpref{wxProcess::Exists}{wxprocessexists},\rtfsp +\helpref{Exec sample}{sampleexec} + +\wxheading{Include files} + + + \membersection{::wxLoadUserResource}\label{wxloaduserresource} \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}} @@ -1979,6 +2050,31 @@ This function is now obsolete, replaced by \helpref{Log functions}{logfunctions} +\membersection{::wxTrap}\label{wxtrap} + +\func{void}{wxTrap}{\void} + +In debug mode (when {\tt \_\_WXDEBUG\_\_} is defined) this function generates a +debugger exception meaning that the control is passed to the debugger if one is +attached to the process. Otherwise the program just terminates abnormally. + +In release mode this function does nothing. + +\wxheading{Include files} + + + +\membersection{::wxUninitialize}\label{wxuninitialize} + +\func{void}{wxUninitialize}{\void} + +This function is for use in console (wxBase) programs only. It must be called +once for each previous successful call to \helpref{wxInitialize}{wxinitialize}. + +\wxheading{Include files} + + + \membersection{::wxUsleep}\label{wxusleep} \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}} @@ -2341,7 +2437,7 @@ avoid using {\tt \#ifdef}s when creating bitmaps. \membersection{wxConstCast}\label{wxconstcast} -\func{}{wxConstCast}{ptr, classname} +\func{classname *}{wxConstCast}{ptr, classname} This macro expands into {\tt const\_cast(ptr)} if the compiler supports {\it const\_cast} or into an old, C-style cast, otherwise. @@ -2370,14 +2466,15 @@ In non-debug mode, this is defined as the normal new operator. \membersection{wxDynamicCast}\label{wxdynamiccast} -\func{}{wxDynamicCast}{ptr, classname} +\func{classname *}{wxDynamicCast}{ptr, classname} This macro returns the pointer {\it ptr} cast to the type {\it classname *} if -the pointer is of this type (the check is done during the run-time) or NULL -otherwise. Usage of this macro is preferred over obsoleted wxObject::IsKindOf() -function. +the pointer is of this type (the check is done during the run-time) or +{\tt NULL} otherwise. Usage of this macro is preferred over obsoleted +wxObject::IsKindOf() function. -The {\it ptr} argument may be NULL, in which case NULL will be returned. +The {\it ptr} argument may be {\tt NULL}, in which case {\tt NULL} will be +returned. Example: @@ -2397,9 +2494,23 @@ Example: \wxheading{See also} \helpref{RTTI overview}{runtimeclassoverview}\\ +\helpref{wxDynamicCastThis}{wxdynamiccastthis}\\ \helpref{wxConstCast}{wxconstcast}\\ \helpref{wxStatiicCast}{wxstaticcast} +\membersection{wxDynamicCastThis}\label{wxdynamiccastthis} + +\func{classname *}{wxDynamicCastThis}{classname} + +This macro is equivalent to {\tt wxDynamicCast(this, classname)} but the +latter provokes spurious compilation warnings from some compilers (because it +tests whether {\tt this} pointer is non {\tt NULL} which is always true), so +this macro should be used to avoid them. + +\wxheading{See also} + +\helpref{wxDynamicCast}{wxdynamiccast} + \membersection{wxICON}\label{wxiconmacro} \func{}{wxICON}{iconName} @@ -2419,7 +2530,7 @@ avoid using {\tt \#ifdef}s when creating icons. \membersection{wxStaticCast}\label{wxstaticcast} -\func{}{wxStaticCast}{ptr, classname} +\func{classname *}{wxStaticCast}{ptr, classname} This macro checks that the cast is valid in debug mode (an assert failure will result if {\tt wxDynamicCast(ptr, classname) == NULL}) and then returns the