Alphabetize wxWindow members list

[wxWidgets.git] / docs / latex / wx / function.tex

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index ee09e36d365f27b1c978d595f7ab8f3316e1219a..a6da0b19e4a04d0f581b50570707180448d93e1c 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -252,6 +252,7 @@ the corresponding topic.
 \helpref{wx\_const\_cast}{wxconstcastraw}\\
 \helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw}\\
 \helpref{wx\_static\_cast}{wxstaticcastraw}\\
 \helpref{wx\_const\_cast}{wxconstcastraw}\\
 \helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw}\\
 \helpref{wx\_static\_cast}{wxstaticcastraw}\\

+\helpref{wx\_truncate\_cast}{wxtruncatecast}\\

 \helpref{\_}{underscore}\\
 \helpref{wxPLURAL}{wxplural}\\
 \helpref{\_T}{underscoret}
 \helpref{\_}{underscore}\\
 \helpref{wxPLURAL}{wxplural}\\
 \helpref{\_T}{underscoret}


@@ -939,6 +940,8 @@ Returns true if the file exists and is a plain file.
 
 Returns time of last modification of given file.
 
 
 Returns time of last modification of given file.
 

+The return value is $0$ if an error occured (e.g. file not found).
+

 
 \membersection{::wxFileNameFromPath}\label{wxfilenamefrompath}
 
 
 \membersection{::wxFileNameFromPath}\label{wxfilenamefrompath}
 


@@ -1068,7 +1071,9 @@ Returns the directory part of the filename.
 
 \membersection{::wxUnix2DosFilename}\label{wxunix2dosfilename}
 
 
 \membersection{::wxUnix2DosFilename}\label{wxunix2dosfilename}
 

-\func{void}{wxUnix2DosFilename}{\param{const wxString\& }{s}}
+\func{void}{wxUnix2DosFilename}{\param{wxChar *}{s}}
+
+This function is deprecated, use \helpref{wxFileName}{wxfilename} instead.

 
 Converts a Unix to a DOS filename by replacing forward
 slashes with backslashes.
 
 Converts a Unix to a DOS filename by replacing forward
 slashes with backslashes.


@@ -1326,7 +1331,8 @@ Return the (current) user's home directory.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxGetUserHome}{wxgetuserhome}
+\helpref{wxGetUserHome}{wxgetuserhome}\\
+\helpref{wxStandardPaths}{wxstandardpaths}

 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 


@@ -2550,7 +2556,7 @@ Empties the clipboard.
 
 \membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}
 
 
 \membersection{::wxEnumClipboardFormats}\label{wxenumclipboardformats}
 

-\func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
+\func{int}{wxEnumClipboardFormats}{\param{int}{ dataFormat}}

 
 Enumerates the formats found in a list of available formats that belong
 to the clipboard. Each call to this  function specifies a known
 
 Enumerates the formats found in a list of available formats that belong
 to the clipboard. Each call to this  function specifies a known


@@ -2571,7 +2577,7 @@ wxOpenClipboard function.
 
 \membersection{::wxGetClipboardData}\label{wxgetclipboarddata}
 
 
 \membersection{::wxGetClipboardData}\label{wxgetclipboarddata}
 

-\func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
+\func{wxObject *}{wxGetClipboardData}{\param{int}{ dataFormat}}

 
 Gets data from the clipboard.
 
 
 Gets data from the clipboard.
 


@@ -2587,7 +2593,7 @@ The clipboard must have previously been opened for this call to succeed.
 
 \membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}
 
 
 \membersection{::wxGetClipboardFormatName}\label{wxgetclipboardformatname}
 

-\func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
+\func{bool}{wxGetClipboardFormatName}{\param{int}{ dataFormat}, \param{const wxString\& }{formatName}, \param{int}{ maxCount}}

 
 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
 
 Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
 length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.


@@ -2595,7 +2601,7 @@ length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard
 
 \membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
 
 
 \membersection{::wxIsClipboardFormatAvailable}\label{wxisclipboardformatavailable}
 

-\func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
+\func{bool}{wxIsClipboardFormatAvailable}{\param{int}{ dataFormat}}

 
 Returns true if the given data format is available on the clipboard.
 
 
 Returns true if the given data format is available on the clipboard.
 


@@ -2616,7 +2622,7 @@ Registers the clipboard data format name and returns an identifier.
 
 \membersection{::wxSetClipboardData}\label{wxsetclipboarddata}
 
 
 \membersection{::wxSetClipboardData}\label{wxsetclipboarddata}
 

-\func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
+\func{bool}{wxSetClipboardData}{\param{int}{ dataFormat}, \param{wxObject*}{ data}, \param{int}{ width}, \param{int}{ height}}

 
 Passes data to the clipboard.
 
 
 Passes data to the clipboard.
 


@@ -2632,8 +2638,6 @@ Passes data to the clipboard.
 The clipboard must have previously been opened for this call to succeed.
 
 
 The clipboard must have previously been opened for this call to succeed.
 
 

-
-

 \section{Miscellaneous functions}\label{miscellany}
 
 
 \section{Miscellaneous functions}\label{miscellany}
 
 


@@ -2838,7 +2842,7 @@ See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient},
 
 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
 
 
 \membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows}
 

-\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = true}}
+\func{void}{wxEnableTopLevelWindows}{\param{bool}{ enable = true}}

 
 This function enables or disables all top level windows. It is used by
 \helpref{::wxSafeYield}{wxsafeyield}.
 
 This function enables or disables all top level windows. It is used by
 \helpref{::wxSafeYield}{wxsafeyield}.


@@ -3010,7 +3014,7 @@ See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxco
 
 \membersection{::wxGetStockLabel}\label{wxgetstocklabel}
 
 
 \membersection{::wxGetStockLabel}\label{wxgetstocklabel}
 

-\func{wxString}{wxGetStockLabel}{\param{wxWindowID }{id}, \param{bool }{withCodes = true}, \param{wxString }{accelerator = wxEmptyString}}
+\func{wxString}{wxGetStockLabel}{\param{wxWindowID }{id}, \param{bool }{withCodes = true}, \param{const wxString\& }{accelerator = wxEmptyString}}

 
 Returns label that should be used for given {\it id} element.
 
 
 Returns label that should be used for given {\it id} element.
 


@@ -3044,16 +3048,19 @@ frame or dialog containing it, or {\tt NULL}.
 
 \membersection{::wxLaunchDefaultBrowser}\label{wxlaunchdefaultbrowser}
 
 
 \membersection{::wxLaunchDefaultBrowser}\label{wxlaunchdefaultbrowser}
 

-\func{bool}{wxLaunchDefaultBrowser}{\param{const wxString\& }{sUrl}}
+\func{bool}{wxLaunchDefaultBrowser}{\param{const wxString\& }{url}, \param{int }{flags = $0$}}

 
 

-Launches the user's default browser and tells it to open the location at {\tt sUrl}.
+Open the \arg{url} in user's default browser. If \arg{flags} parameter contains 
+\texttt{wxBROWSER\_NEW\_WINDOW} flag, a new window is opened for the URL
+(currently this is only supported under Windows).

 
 

-Returns true if the application was successfully launched.
+Returns \true if the application was successfully launched.

 
 \wxheading{Include files}
 
 <wx/utils.h>
 
 
 \wxheading{Include files}
 
 <wx/utils.h>
 

+

 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
 
 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
 
 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}


@@ -3167,7 +3174,7 @@ allows to define unsigned 64 bit compile time constants:
 
 \membersection{wxVaCopy}\label{wxvacopy}
 
 
 \membersection{wxVaCopy}\label{wxvacopy}
 

-\func{void}{wxVaCopy}{\param{va\_list }{argptrDst}, \param{va\_list}{argptrSrc}}
+\func{void}{wxVaCopy}{\param{va\_list }{argptrDst}, \param{va\_list}{ argptrSrc}}

 
 This macro is the same as the standard C99 \texttt{va\_copy} for the compilers
 which support it or its replacement for those that don't. It must be used to
 
 This macro is the same as the standard C99 \texttt{va\_copy} for the compilers
 which support it or its replacement for those that don't. It must be used to


@@ -3660,9 +3667,21 @@ star is not appended to it.
 \wxheading{See also}
 
 \helpref{wx\_const\_cast}{wxconstcastraw},\\
 \wxheading{See also}
 
 \helpref{wx\_const\_cast}{wxconstcastraw},\\

-\helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw}
+\helpref{wx\_reinterpret\_cast}{wxreinterpretcastraw},\\
+\helpref{wx\_truncate\_cast}{wxtruncatecast}

 
 
 
 

+\membersection{wx\_truncate\_cast}\label{wxtruncatecast}
+
+\func{T}{wx\_truncate\_cast}{T, x}
+
+This case doesn't correspond to any standard cast but exists solely to make
+casts which possibly result in a truncation of an integer value more readable.
+
+\wxheading{See also}
+
+\helpref{wx\_static\_cast}{wxstaticcastraw}
+

 
 \section{Log functions}\label{logfunctions}
 
 
 \section{Log functions}\label{logfunctions}