X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/10eb1f1eac4f334f4acaae8199178131eeba5f74..a9249b2eb2a40d8c71f828669045c4ddaa8dc5ff:/docs/latex/wx/function.tex diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 07fe1ee4bd..ee3b947473 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -11,7 +11,7 @@ The following constants are defined in wxWindows: \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 wxRELASE\_NUMBER} is the release number +\item {\tt wxRELEASE\_NUMBER} is the release number \end{itemize} For example, the values or these constants for wxWindows 2.1.15 are 2, 1 and @@ -182,7 +182,7 @@ See \helpref{wxFindFirstFile}{wxfindfirstfile} for an example. \func{bool}{wxGetDiskSpace}{\param{const wxString\& }{path}, \param{wxLongLong }{*total = NULL}, \param{wxLongLong }{*free = NULL}} This function returns the total number of bytes and number of free bytes on -the disk containing the directory {\it path} (it should exist). Both +the disk containing the directory {\it path} (it should exist). Both {\it total} and {\it free} parameters may be {\tt NULL} if the corresponding information is not needed. @@ -265,15 +265,19 @@ if the buffer is NULL. \func{bool}{wxGetTempFileName}{\param{const wxString\& }{prefix}, \param{wxString\& }{buf}} -Makes a temporary filename based on {\it prefix}, opens and closes the file, -and places the name in {\it buf}. If {\it buf} is NULL, new store -is allocated for the temporary filename using {\it new}. - -Under Windows, the filename will include the drive and name of the -directory allocated for temporary files (usually the contents of the -TEMP variable). Under Unix, the {\tt /tmp} directory is used. - -It is the application's responsibility to create and delete the file. +%% Makes a temporary filename based on {\it prefix}, opens and closes the file, +%% and places the name in {\it buf}. If {\it buf} is NULL, new store +%% is allocated for the temporary filename using {\it new}. +%% +%% Under Windows, the filename will include the drive and name of the +%% directory allocated for temporary files (usually the contents of the +%% TEMP variable). Under Unix, the {\tt /tmp} directory is used. +%% +%% It is the application's responsibility to create and delete the file. + +These functions are obsolete, please use\rtfsp +\helpref{wxFileName::CreateTempFileName}{wxfilenamecreatetempfilename}\rtfsp +instead. \membersection{::wxIsWild}\label{wxiswild} @@ -606,7 +610,7 @@ is remembered between the 2 program runs.} Pops up a directory selector dialog. The arguments have the same meaning as those of wxDirDialog::wxDirDialog(). The message is displayed at the top, -and the default_path, if specified, is set as the initial selection. +and the default\_path, if specified, is set as the initial selection. The application must check for an empty return value (if the user pressed Cancel). For example: @@ -1698,7 +1702,7 @@ Gets operating system version information. \begin{twocollist}\itemsep=0pt \twocolitemruled{Platform}{Return types} -\twocolitem{Macintosh}{Return value is wxMACINTOSH.} +\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{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.} @@ -1819,15 +1823,15 @@ see \helpref{wxImage}{wximage}. \func{bool}{wxInitialize}{\void} -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 +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. If the function returns {\tt FALSE} the initialization could not be performed, -in this case the library cannot be used and +in this case the library cannot be used and \helpref{wxUninitialize}{wxuninitialize} shouldn't be called neither. -This function may be called several times but +This function may be called several times but \helpref{wxUninitialize}{wxuninitialize} must be called for each successful call to this function. @@ -1878,7 +1882,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 @@ -2504,7 +2508,7 @@ In non-debug mode, this is defined as the normal new operator. \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 +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.