wxPROCESS_ENTER is deprecated in favour of wxTE_PROCESS_ENTER. So use the latter...

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

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index 46c88f3a113e4312eba5e489840a4d06c0252637..74b7136158eefe052c40059d594b2e39b8411c98 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -524,7 +524,7 @@ the corresponding functions \helpref{::wxPostEvent}{wxpostevent} and
 
 \wxheading{Include files}
 
-<wx/event.h>
+<wx/app.h>
 
 
 
@@ -751,7 +751,7 @@ See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
 
 This function shuts down or reboots the computer depending on the value of the
 {\it flags}. Please notice that doing this requires the corresponding access
-rights (superuser under Unix, {\tt SE\_SHUTDOWN} privelege under Windows NT)
+rights (superuser under Unix, {\tt SE\_SHUTDOWN} privilege under Windows NT)
 and that this function is only implemented under Unix and Win32.
 
 \wxheading{Parameters}
@@ -1189,7 +1189,7 @@ with wildcard characters. See \helpref{wxIsWild}{wxiswild}.
 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.
+supported (Unix) and doesn't have any effect on the other ones.
 
 
 \membersection{::wxParseCommonDialogsFilter}\label{wxparsecommondialogsfilter}
@@ -1215,10 +1215,14 @@ Removes \arg{file}, returning true if successful.
 
 \membersection{::wxRenameFile}\label{wxrenamefile}
 
-\func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}}
+\func{bool}{wxRenameFile}{\param{const wxString\& }{file1}, \param{const wxString\& }{file2}, \param{bool }{overwrite = true}}
 
 Renames \arg{file1} to \arg{file2}, returning true if successful.
 
+If \arg{overwrite} parameter is true (default), the destination file is
+overwritten if it exists, but if \arg{overwrite} is false, the functions fails
+in this case.
+
 
 \membersection{::wxRmdir}\label{wxrmdir}
 
@@ -2955,7 +2959,8 @@ and current pointer position in screen coordinates.
 
 \func{wxWindow *}{wxGetActiveWindow}{\void}
 
-Gets the currently active window (Windows only).
+Gets the currently active window (implemented for MSW and GTK only currently,
+always returns \NULL in the other ports).
 
 \wxheading{Include files}
 
@@ -2970,7 +2975,7 @@ Returns battery state as one of \texttt{wxBATTERY\_NORMAL\_STATE},
 \texttt{wxBATTERY\_LOW\_STATE}, \texttt{wxBATTERY\_CRITICAL\_STATE},
 \texttt{wxBATTERY\_SHUTDOWN\_STATE} or \texttt{wxBATTERY\_UNKNOWN\_STATE}.
 \texttt{wxBATTERY\_UNKNOWN\_STATE} is also the default on platforms where
-this feature is not implemented.
+this feature is not implemented (currently everywhere but MS Windows).
 
 \wxheading{Include files}
 
@@ -2995,7 +3000,7 @@ Under X only, returns the current display name. See also \helpref{wxSetDisplayNa
 Returns the type of power source as one of \texttt{wxPOWER\_SOCKET},
 \texttt{wxPOWER\_BATTERY} or \texttt{wxPOWER\_UNKNOWN}.
 \texttt{wxPOWER\_UNKNOWN} is also the default on platforms where this
-feature is not implemented.
+feature is not implemented (currently everywhere but MS Windows).
 
 \wxheading{Include files}
 
@@ -3727,7 +3732,7 @@ Example:
 
 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
+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}
@@ -4322,7 +4327,7 @@ compilation error messages if the condition they check fail.
 
 \membersection{::wxOnAssert}\label{wxonassert}
 
-\func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
+\func{void}{wxOnAssert}{\param{const char *}{fileName}, \param{int}{ lineNumber}, \param{const char *}{func}, \param{const char *}{cond}, \param{const char *}{msg = NULL}}
 
 This function is called whenever one of debugging macros fails (i.e. condition
 is false in an assertion). It is only defined in the debug mode, in release
@@ -4461,7 +4466,7 @@ This check is done even in release mode.
 Checks that the condition is true, returns with the given return value if not (FAILs in debug mode).
 This check is done even in release mode.
 
-This macro may be only used in non void functions, see also
+This macro may be only used in non-void functions, see also
 \helpref{wxCHECK\_RET}{wxcheckret}.