X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6f97a409caf1c054da942e6449a12392cec49767..50c538600e7586c256fe0145ac8054f045be6fbb:/docs/latex/wx/function.tex?ds=sidebyside diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index f65752f255..5d553b30d0 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -2,12 +2,10 @@ \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}% \setfooter{\thepage}{}{}{}{}{\thepage} -The functions and macros defined in wxWindows are described here: you can +The functions and macros defined in wxWidgets are described here: you can 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}\\ @@ -23,7 +21,6 @@ the corresponding topic. \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}\\ @@ -41,6 +38,7 @@ the corresponding topic. \helpref{wxCHECK\_MSG}{wxcheckmsg}\\ \helpref{wxCHECK\_RET}{wxcheckret}\\ \helpref{wxCHECK\_VERSION}{wxcheckversion}\\ +\helpref{wxCHECK\_VERSION\_FULL}{wxcheckversionfull}\\ \helpref{wxCHECK\_W32API\_VERSION}{wxcheckw32apiversion}\\ \helpref{wxClientDisplayRect}{wxclientdisplayrect}\\ \helpref{wxClipboardOpen}{functionwxclipboardopen}\\ @@ -111,6 +109,7 @@ the corresponding topic. \helpref{wxGetFullHostName}{wxgetfullhostname}\\ \helpref{wxGetHomeDir}{wxgethomedir}\\ \helpref{wxGetHostName}{wxgethostname}\\ +\helpref{wxGetKeyState}{wxgetkeystate}\\ \helpref{wxGetLocalTimeMillis}{wxgetlocaltimemillis}\\ \helpref{wxGetLocalTime}{wxgetlocaltime}\\ \helpref{wxGetMousePosition}{wxgetmouseposition}\\ @@ -176,6 +175,8 @@ the corresponding topic. \helpref{wxMakeMetafilePlaceable}{wxmakemetafileplaceable}\\ \helpref{wxMatchWild}{wxmatchwild}\\ \helpref{wxMessageBox}{wxmessagebox}\\ +\helpref{wxMilliSleep}{wxmillisleep}\\ +\helpref{wxMicroSleep}{wxmicrosleep}\\ \helpref{wxMkdir}{wxmkdir}\\ \helpref{wxMutexGuiEnter}{wxmutexguienter}\\ \helpref{wxMutexGuiLeave}{wxmutexguileave}\\ @@ -183,6 +184,7 @@ the corresponding topic. \helpref{wxNow}{wxnow}\\ \helpref{wxOnAssert}{wxonassert}\\ \helpref{wxOpenClipboard}{wxopenclipboard}\\ +\helpref{wxParseCommonDialogsFilter}{wxparsecommondialogsfilter}\\ \helpref{wxPathOnly}{wxpathonly}\\ \helpref{wxPostDelete}{wxpostdelete}\\ \helpref{wxPostEvent}{wxpostevent}\\ @@ -237,6 +239,8 @@ the corresponding topic. \helpref{wxWakeUpIdle}{wxwakeupidle}\\ \helpref{wxWriteResource}{wxwriteresource}\\ \helpref{wxYield}{wxyield}\\ +\helpref{wx\_const\_cast}{wxconstcastraw}\\ +\helpref{wx\_static\_cast}{wxstaticcastraw}\\ \helpref{\_}{underscore}\\ \helpref{\_T}{underscoret} @@ -244,35 +248,49 @@ the corresponding topic. \section{Version macros}\label{versionfunctions} -The following constants are defined in wxWindows: +The following constants are defined in wxWidgets: \begin{itemize}\itemsep=0pt -\item {\tt wxMAJOR\_VERSION} is the major version of wxWindows -\item {\tt wxMINOR\_VERSION} is the minor version of wxWindows +\item {\tt wxMAJOR\_VERSION} is the major version of wxWidgets +\item {\tt wxMINOR\_VERSION} is the minor version of wxWidgets \item {\tt wxRELEASE\_NUMBER} is the release number +\item {\tt wxSUBRELEASE\_NUMBER} is the subrelease number which is $0$ for all +official releases \end{itemize} -For example, the values or these constants for wxWindows 2.1.15 are 2, 1 and +For example, the values or these constants for wxWidgets 2.1.15 are 2, 1 and 15. Additionally, {\tt wxVERSION\_STRING} is a user-readable string containing -the full wxWindows version and {\tt wxVERSION\_NUMBER} is a combination of the +the full wxWidgets version and {\tt wxVERSION\_NUMBER} is a combination of the three version numbers above: for 2.1.15, it is 2115 and it is 2200 for -wxWindows 2.2. +wxWidgets 2.2. + +The subrelease number is only used for the sources in between official releases +and so normally is not useful. \wxheading{Include files} or +\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\_VERSION}\label{wxcheckversion} \func{bool}{wxCHECK\_VERSION}{\param{}{major, minor, release}} -This is a macro which evaluates to true if the current wxWindows version is at +This is a macro which evaluates to true if the current wxWidgets version is at least major.minor.release. -For example, to test if the program is compiled with wxWindows 2.2 or higher, +For example, to test if the program is compiled with wxWidgets 2.2 or higher, the following can be done: \begin{verbatim} @@ -288,13 +306,12 @@ the following can be done: \end{verbatim} -\membersection{wxCHECK\_GCC\_VERSION}\label{wxcheckgccversion} +\membersection{wxCHECK\_VERSION\_FULL}\label{wxcheckversionfull} -\func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor, release}} +\func{bool}{wxCHECK\_VERSION\_FULL}{\param{}{major, minor, release, subrel}} -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$. +Same as \helpref{wxCHECK\_VERSION}{wxcheckversion} but also checks that +\texttt{wxSUBRELEASE\_NUMBER} is at least \arg{subrel}. \membersection{wxCHECK\_W32API\_VERSION}\label{wxcheckw32apiversion} @@ -315,31 +332,31 @@ 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 -are not using the default wxWindows entry code (e.g. main or WinMain). For example, -you can initialize wxWindows from an Microsoft Foundation Classes application using +This initializes wxWidgets in a platform-dependent way. Use this if you +are not using the default wxWidgets entry code (e.g. main or WinMain). For example, +you can initialize wxWidgets from an Microsoft Foundation Classes application using this function. \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance}, \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = true}} -wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is false, the -function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows +wxWidgets initialization under Windows (non-DLL). If {\it enterLoop} is false, the +function will return immediately after calling wxApp::OnInit. Otherwise, the wxWidgets message loop will be entered. \func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance}, \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}} -wxWindows initialization under Windows (for applications constructed as a DLL). +wxWidgets initialization under Windows (for applications constructed as a DLL). \func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}} -wxWindows initialization under Unix. +wxWidgets initialization under Unix. \wxheading{Remarks} -To clean up wxWindows, call wxApp::OnExit followed by the static function -wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows: +To clean up wxWidgets, call wxApp::OnExit followed by the static function +wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWidgets: \begin{verbatim} int CTheApp::ExitInstance() @@ -362,7 +379,7 @@ int CTheApp::ExitInstance() \func{wxAppDerivedClass\&}{wxGetApp}{\void} -This function doesn't exist in wxWindows but it is created by using +This function doesn't exist in wxWidgets 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}. @@ -408,7 +425,7 @@ 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. +{\tt main()} function before calling any other wxWidgets functions. If the function returns {\tt false} the initialization could not be performed, in this case the library cannot be used and @@ -581,7 +598,7 @@ single string.} 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},\rtfsp {\tt wxEXEC\_SYNC} and {\tt wxEXEC\_NOHIDE}} \docparam{callback}{An optional pointer to \helpref{wxProcess}{wxprocess}} @@ -635,7 +652,7 @@ enum wxSignal \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 +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 @@ -797,7 +814,7 @@ other threads start calling it, if this is not the case this approach can \func{}{wxENTER\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}} -This macro is equivalent to \helpref{cs.Enter()}{wxcriticalsectionenter} if +This macro is equivalent to \helpref{cs.Enter()}{wxcriticalsectionenter} if {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. @@ -815,7 +832,7 @@ Returns {\tt true} if this thread is the main one. Always returns {\tt true} if \func{}{wxLEAVE\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}} -This macro is equivalent to \helpref{cs.Leave()}{wxcriticalsectionleave} if +This macro is equivalent to \helpref{cs.Leave()}{wxcriticalsectionleave} if {\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$. @@ -971,10 +988,10 @@ directory doesn't exist). \wxheading{Portability} -This function is implemented for Win16 (only for drives less than 2Gb), Win32, +This function is implemented for Win32, Mac OS and generic Unix provided the system has {\tt statfs()} function. -This function first appeared in wxWindows 2.3.2. +This function first appeared in wxWidgets 2.3.2. \membersection{::wxGetOSDirectory}\label{wxgetosdirectory} @@ -1078,7 +1095,7 @@ Returns true if the pattern contains wildcards. See \helpref{wxMatchWild}{wxmatc \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 +Returns true if the \arg{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}. @@ -1087,24 +1104,38 @@ with wildcard characters. See \helpref{wxIsWild}{wxiswild}. \func{bool}{wxMkdir}{\param{const wxString\& }{dir}, \param{int }{perm = 0777}} -Makes the directory {\it dir}, returning true if successful. +Makes the directory \arg{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{::wxParseCommonDialogsFilter}\label{wxparsecommondialogsfilter} + +\func{int}{wxParseCommonDialogsFilter}{\param{const wxString\& }{wildCard}, \param{wxArrayString\& }{descriptions}, \param{wxArrayString\& }{filters}} + +Parses the \arg{wildCard}, returning the number of filters. +Returns 0 if none or if there's a problem. +The arrays will contain an equal number of items found before the error. +On platforms where native dialogs handle only one filter per entry, +entries in arrays are automatically adjusted. +\arg{wildCard} is in the form: +\begin{verbatim} + "All files (*)|*|Image Files (*.jpeg *.png)|*.jpg;*.png" +\end{verbatim} + \membersection{::wxRemoveFile}\label{wxremovefile} \func{bool}{wxRemoveFile}{\param{const wxString\& }{file}} -Removes {\it file}, returning true if successful. +Removes \arg{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 \arg{file1} to \arg{file2}, returning true if successful. \membersection{::wxRmdir}\label{wxrmdir} @@ -1251,7 +1282,7 @@ the domain name. Under Windows or NT, this function first looks in the environment variable SYSTEM\_NAME; if this is not found, the entry {\bf HostName}\rtfsp -in the {\bf wxWindows} section of the WIN.INI file is tried. +in the {\bf wxWidgets} 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 @@ -1277,7 +1308,7 @@ something like "jsmith". It uniquely identifies the current user (on this system Under Windows or NT, this function first looks in the environment variables USER and LOGNAME; if neither of these is found, the entry {\bf UserId}\rtfsp -in the {\bf wxWindows} section of the WIN.INI file is tried. +in the {\bf wxWidgets} 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 @@ -1362,7 +1393,7 @@ Returns the home directory for the given user. If the username is empty This function returns the full user name (something like "Mr. John Smith"). Under Windows or NT, this function looks for the entry {\bf UserName}\rtfsp -in the {\bf wxWindows} section of the WIN.INI file. If PenWindows +in the {\bf wxWidgets} section of the WIN.INI file. If PenWindows is running, the entry {\bf Current} in the section {\bf User} of the PENWIN.INI file is used. @@ -1393,22 +1424,6 @@ deleted with the {\it delete} operator. 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}} @@ -1432,10 +1447,11 @@ 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. +otherwise \arg{strPlural}. See \urlref{GNU gettext manual}{http://www.gnu.org/manual/gettext/html\_chapter/gettext\_10.html\#SEC150} for additional information on plural forms handling. +Both versions call \helpref{wxLocale::GetString}{wxlocalegetstring}. + \membersection{::wxIsEmpty}\label{wxisempty} \func{bool}{wxIsEmpty}{\param{const char *}{ p}} @@ -1544,35 +1560,39 @@ build. In fact, its definition is: \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 +value of its argument (except 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 +the string for extraction but also expands into a \helpref{wxGetTranslation}{wxgettranslation} function call which means that it -cannot be used in some situations, notably for the static arrays +cannot be used in some situations, notably for static array 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 +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 @@ -1580,8 +1600,6 @@ 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{::wxVsnprintf}\label{wxvsnprintf} \func{int}{wxVsnprintf}{\param{wxChar *}{buf}, \param{size\_t }{len}, \param{const wxChar *}{format}, \param{va\_list }{argPtr}} @@ -1606,11 +1624,6 @@ 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} @@ -1619,7 +1632,7 @@ Don't confuse this macro with \helpref{\_T()}{underscoret}! \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 +wxWidgets 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()}). @@ -1725,7 +1738,7 @@ If path is empty, the current directory will be used. If filename is empty, no default filename will be supplied. The wildcard determines what files are displayed in the file selector, and file extension supplies a type extension for the required filename. Flags may be a combination of wxOPEN, -wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0. +wxSAVE, wxOVERWRITE\_PROMPT, wxFILE\_MUST\_EXIST, wxMULTIPLE or 0. Both the Unix and Windows versions implement a wildcard filter. Typing a filename containing wildcards (*, ?) in the filename text item, and @@ -1879,7 +1892,7 @@ Dialog is centered on its {\it parent} unless an explicit position is given in \wxheading{Include files} - + \membersection{::wxGetPasswordFromUser}\label{wxgetpasswordfromuser} @@ -2272,7 +2285,7 @@ the equivalent of the following code to the start of the metafile data: SetWindowExt(dc, maxX - minX, maxY - minY); \end{verbatim} -This simulates the wxMM\_TEXT mapping mode, which wxWindows assumes. +This simulates the wxMM\_TEXT mapping mode, which wxWidgets assumes. Placeable metafiles may be imported by many Windows applications, and can be used in RTF (Rich Text Format) files. @@ -2551,7 +2564,7 @@ This macro returns the concatenation of two tokens \arg{x} and \arg{y}. \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 +{\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 @@ -2580,6 +2593,19 @@ 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{::wxGetKeyState}\label{wxgetkeystate} + +\func{bool}{wxGetKeyState}{\param{wxKeyCode }{key}} + +Returns \true if the key parameter is currently pressed on the keyboard, or +with modifier keys, (caps lock, etc) if the key is active (the led light is +on). + +\wxheading{Include files} + + + + \membersection{wxLL}\label{wxll} \func{wxLongLong\_t}{wxLL}{\param{}{number}} @@ -2651,7 +2677,7 @@ the given {\bf id}. \func{void}{wxDDECleanUp}{\void} -Called when wxWindows exits, to clean up the DDE system. This no longer needs to be +Called when wxWidgets exits, to clean up the DDE system. This no longer needs to be called by the application. See also \helpref{wxDDEInitialize}{wxddeinitialize}. @@ -2668,9 +2694,9 @@ See also \helpref{wxDDEInitialize}{wxddeinitialize}. Initializes the DDE system. May be called multiple times without harm. This no longer needs to be called by the application: it will be called -by wxWindows if necessary. +by wxWidgets if necessary. -See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection}, +See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},\rtfsp \helpref{wxDDECleanUp}{wxddecleanup}. \wxheading{Include files} @@ -3042,7 +3068,7 @@ data in big-endian format. \section{RTTI functions}\label{rttimacros} -wxWindows uses its own RTTI ("run-time type identification") system which +wxWidgets uses its own RTTI ("run-time type identification") system which predates the current standard C++ RTTI and so is kept for backwards compatibility reasons but also because it allows some things which the standard RTTI doesn't directly support (such as creating a class from its @@ -3050,7 +3076,7 @@ name). The standard C++ RTTI can be used in the user code without any problems and in general you shouldn't need to use the functions and the macros in this section -unless you are thinking of modifying or adding any wxWindows classes. +unless you are thinking of modifying or adding any wxWidgets classes. \wxheading{See also} @@ -3194,7 +3220,7 @@ a class that has run-time type information and two base classes. The same as IMP \func{}{IMPLEMENT\_APP}{className} This is used in the application class implementation file to make the application class known to -wxWindows for dynamic construction. You use this instead of +wxWidgets for dynamic construction. You use this instead of Old form: @@ -3287,6 +3313,7 @@ supports {\it const\_cast} or into an old, C-style cast, otherwise. \wxheading{See also} +\helpref{wx\_const\_cast}{wxconstcastraw}\\ \helpref{wxDynamicCast}{wxdynamiccast}\\ \helpref{wxStaticCast}{wxstaticcast} @@ -3374,17 +3401,49 @@ 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 result of executing an equivalent of {\tt static\_cast(ptr)}. +\wxheading{See also} + +\helpref{wx\_static\_cast}{wxstaticcastraw}\\ \helpref{wxDynamicCast}{wxdynamiccast}\\ \helpref{wxConstCast}{wxconstcast} +\membersection{wx\_const\_cast}\label{wxconstcastraw} + +\func{T}{wx\_const\_cast}{T, x} + +Same as \texttt{const\_cast(x)} if the compiler supports const cast or +\texttt{(T)x} for old compilers. Unlike \helpref{wxConstCast}{wxconstcast}, +the cast it to the type \arg{T} and not to \texttt{T *} and also the order of +arguments is the same as for the standard cast. + +\wxheading{See also} + +\helpref{wx\_static\_cast}{wxstaticcastraw}\\ + + +\membersection{wx\_static\_cast}\label{wxstaticcastraw} + +\func{T}{wx\_static\_cast}{T, x} + +Same as \texttt{static\_cast(x)} if the compiler supports static cast or +\texttt{(T)x} for old compilers. Unlike \helpref{wxStaticCast}{wxstaticcast}, +there are no checks being done and the meaning of the macro arguments is exactly +the same as for the standard static cast, i.e. \arg{T} is the full type name and +star is not appended to it. + +\wxheading{See also} + +\helpref{wx\_const\_cast}{wxconstcastraw}\\ + + \section{Log functions}\label{logfunctions} These functions provide a variety of logging functions: see \helpref{Log classes overview}{wxlogoverview} for further information. The functions use (implicitly) the currently active log target, so their descriptions here may not apply if the log target is not the -standard one (installed by wxWindows in the beginning of the program). +standard one (installed by wxWidgets in the beginning of the program). \wxheading{Include files} @@ -3418,14 +3477,14 @@ instead. \membersection{::wxError}\label{wxerror} -\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}} +\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Internal Error"}} {\bf NB:} This function is now obsolete, please use \helpref{wxLogError}{wxlogerror} instead. Displays {\it msg} and continues. This writes to standard error under Unix, and pops up a message box under Windows. Used for internal -wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}. +wxWidgets errors. See also \helpref{wxFatalError}{wxfatalerror}. \wxheading{Include files} @@ -3434,14 +3493,14 @@ wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}. \membersection{::wxFatalError}\label{wxfatalerror} -\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Fatal Error"}} +\func{void}{wxFatalError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWidgets Fatal Error"}} {\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, and pops up a message box under Windows. Used for fatal internal -wxWindows errors. See also \helpref{wxError}{wxerror}. +wxWidgets errors. See also \helpref{wxError}{wxerror}. \wxheading{Include files} @@ -3527,7 +3586,7 @@ If the target frame doesn't have a statusbar, the message will be lost. \func{void}{wxVLogSysError}{\param{const char *}{formatString}, \param{va\_list }{argPtr}} -Mostly used by wxWindows itself, but might be handy for logging errors after +Mostly used by wxWidgets itself, but might be handy for logging errors after system call (API function) failure. It logs the specified message text as well as the last system error code ({\it errno} or {\it ::GetLastError()} depending on the platform) and the corresponding error message. The second form @@ -3580,7 +3639,7 @@ the mask has been previously enabled by the call to \helpref{AddTraceMask}{wxlogaddtracemask} or by setting \helpref{{\tt WXTRACE} environment variable}{envvars}. The predefined string trace masks -used by wxWindows are: +used by wxWidgets are: \begin{itemize}\itemsep=0pt \item wxTRACE\_MemAlloc: trace memory allocation (new/delete) @@ -3800,6 +3859,33 @@ Returns the number of seconds since GMT 00:00:00 Jan 1st 1970. +\membersection{::wxMicroSleep}\label{wxmicrosleep} + +\func{void}{wxMicroSleep}{\param{unsigned long}{ microseconds}} + +Sleeps for the specified number of microseconds. The microsecond resolution may +not, in fact, be available on all platforms (currently only Unix platforms with +nanosleep(2) may provide it) in which case this is the same as +\helpref{wxMilliSleep}{wxmillisleep}(\arg{microseconds}$/1000$). + +\wxheading{Include files} + + + + +\membersection{::wxMilliSleep}\label{wxmillisleep} + +\func{void}{wxMilliSleep}{\param{unsigned long}{ milliseconds}} + +Sleeps for the specified number of milliseconds. Notice that usage of this +function is encouraged instead of calling usleep(3) directly because the +standard usleep() function is not MT safe. + +\wxheading{Include files} + + + + \membersection{::wxNow}\label{wxnow} \func{wxString}{wxNow}{\void} @@ -3839,20 +3925,17 @@ See also \helpref{wxTimer}{wxtimer}. \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}} -Sleeps for the specified number of milliseconds. Notice that usage of this -function is encouraged instead of calling usleep(3) directly because the -standard usleep() function is not MT safe. - -\wxheading{Include files} - - +This function is deprecated because its name is misleading: notice that the +argument is in milliseconds, not microseconds. Please use either +\helpref{wxMilliSleep}{wxmillisleep} or \helpref{wxMicroSleep}{wxmicrosleep} +depending on the resolution you need. \section{Debugging macros and functions}\label{debugmacros} Useful macros and functions for error checking and defensive programming. -wxWindows defines three families of the assert-like macros: +wxWidgets defines three families of the assert-like macros: the wxASSERT and wxFAIL macros only do anything if \_\_WXDEBUG\_\_ is defined (in other words, in the debug build) but disappear completely in the release build. On the other hand, the wxCHECK macros stay event in release builds but a