X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5a70d3f578cdd6939616505d5a38c001a5cc7692..6ab069f2b68cd266b31122d6a73a0878fd4760fe:/docs/latex/wx/function.tex diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index 18d99ced49..2a47fedae5 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -133,7 +133,6 @@ the corresponding topic. \helpref{wxGetMousePosition}{wxgetmouseposition}\\ \helpref{wxGetMouseState}{wxgetmousestate}\\ \helpref{wxGetMultipleChoices}{wxgetmultiplechoices}\\ -\helpref{wxGetMultipleChoice}{wxgetmultiplechoice}\\ \helpref{wxGetNumberFromUser}{wxgetnumberfromuser}\\ \helpref{wxGetOSDirectory}{wxgetosdirectory}\\ \helpref{wxGetOsDescription}{wxgetosdescription}\\ @@ -312,10 +311,10 @@ and so normally is not useful. \membersection{wxCHECK\_GCC\_VERSION}\label{wxcheckgccversion} -\func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor, release}} +\func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor}} 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 +compiler (g++) version major.minor or greater. Otherwise, and also if the compiler is not GNU C++ at all, returns $0$. @@ -996,7 +995,8 @@ Returns true if the file exists and is a plain file. Returns time of last modification of given file. -The return value is $0$ if an error occured (e.g. file not found). +The function returns \texttt{(time\_t)}$-1$ if an error occurred (e.g. file not +found). \membersection{::wxFileNameFromPath}\label{wxfilenamefrompath} @@ -1113,7 +1113,7 @@ or drive name at the beginning. \membersection{::wxDirExists}\label{functionwxdirexists} -\func{bool}{wxDirExists}{\param{const wxChar *}{dirname}} +\func{bool}{wxDirExists}{\param{const wxString\& }{dirname}} Returns true if \arg{dirname} exists and is a directory. @@ -1273,6 +1273,11 @@ Removes the directory {\it dir}, returning true if successful. Does not work und The {\it flags} parameter is reserved for future use. +Please notice that there is also a wxRmDir() function which simply wraps the +standard POSIX rmdir() function and so return an integer error code instead of +a boolean value (but otherwise is currently identical to wxRmdir), don't +confuse these two functions. + \membersection{::wxSetWorkingDirectory}\label{wxsetworkingdirectory} @@ -2182,33 +2187,6 @@ is centred; if false, the message is left-justified. -\membersection{::wxGetMultipleChoice}\label{wxgetmultiplechoice} - -\func{int}{wxGetMultipleChoice}{\param{const wxString\& }{message}, \param{const wxString\& }{caption}, \param{int}{ n}, \param{const wxString\& }{choices[]},\\ - \param{int }{nsel}, \param{int *}{selection}, - \param{wxWindow *}{parent = NULL}, \param{int}{ x = -1}, \param{int}{ y = -1},\\ - \param{bool}{ centre = true}, \param{int }{width=150}, \param{int }{height=200}} - -Pops up a dialog box containing a message, OK/Cancel buttons and a multiple-selection -listbox. The user may choose one or more item(s) and press OK or Cancel. - -The number of initially selected choices, and array of the selected indices, -are passed in; this array will contain the user selections on exit, with -the function returning the number of selections. {\it selection} must be -as big as the number of choices, in case all are selected. - -If Cancel is pressed, -1 is returned. - -{\it choices} is an array of {\it n} strings for the listbox. - -If {\it centre} is true, the message text (which may include new line characters) -is centred; if false, the message is left-justified. - -\wxheading{Include files} - - - - \membersection{::wxGetSingleChoice}\label{wxgetsinglechoice} \func{wxString}{wxGetSingleChoice}{\param{const wxString\& }{message},\\ @@ -2913,6 +2891,12 @@ printed. Example of using it: \func{long}{wxNewId}{\void} +This function is deprecated as the ids generated by it can conflict with the +ids defined by the user code, use \texttt{wxID\_ANY} to assign ids which are +guaranteed to not conflict with the user-defined ids for the controls and menu +items you create instead of using this function. + + Generates an integer identifier unique to this run of the program. \wxheading{Include files} @@ -3089,7 +3073,7 @@ always returns \NULL in the other ports). \wxheading{Include files} - + \membersection{::wxGetBatteryState}\label{wxgetbatterystate}