X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0597e7f977c87d107e24bf3e95ebfa3d60efc249..52de37c78f31bc03f8b96090932c7ce8c3907d29:/docs/latex/wx/function.tex?ds=sidebyside

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index c6db80094d..c1056d214f 100644
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -20,7 +20,6 @@ the corresponding topic.
 \section{Alphabetical functions and macros list}\label{functionsalphabetically}
 
 \helpref{CLASSINFO}{classinfo}\\
-\helpref{copystring}{copystring}\\
 \helpref{DECLARE\_ABSTRACT\_CLASS}{declareabstractclass}\\
 \helpref{DECLARE\_APP}{declareapp}\\
 \helpref{DECLARE\_CLASS}{declareclass}\\
@@ -118,7 +117,6 @@ the corresponding topic.
 \helpref{wxGetDisplayName}{wxgetdisplayname}\\
 \helpref{wxGetDisplaySize}{wxdisplaysize}\\
 \helpref{wxGetDisplaySizeMM}{wxdisplaysizemm}\\
-\helpref{wxGetElapsedTime}{wxgetelapsedtime}\\
 \helpref{wxGetEmailAddress}{wxgetemailaddress}\\
 \helpref{wxGetEnv}{wxgetenv}\\
 \helpref{wxGetFileKind}{wxgetfilekind}\\
@@ -240,7 +238,6 @@ the corresponding topic.
 \helpref{wxSnprintf}{wxsnprintf}\\
 \helpref{wxSplit}{wxsplit}\\
 \helpref{wxSplitPath}{wxsplitfunction}\\
-\helpref{wxStartTimer}{wxstarttimer}\\
 \helpref{wxStaticCast}{wxstaticcast}\\
 \helpref{wxStrcmp}{wxstrcmp}\\
 \helpref{wxStricmp}{wxstricmp}\\
@@ -351,7 +348,7 @@ Same as \helpref{wxCHECK\_VERSION}{wxcheckversion} but also checks that
 
 \membersection{wxCHECK\_W32API\_VERSION}\label{wxcheckw32apiversion}
 
-\func{bool}{wxCHECK\_GCC\_VERSION}{\param{}{major, minor, release}}
+\func{bool}{wxCHECK\_W32API\_VERSION}{\param{}{major, minor, release}}
 
 Returns $1$ if the version of w32api headers used is major.minor.release or
 greater. Otherwise, and also if we are not compiling with mingw32/cygwin under
@@ -438,6 +435,15 @@ least the GUI part of) the library can't be used at all.
 Notice that parameters \arg{argc} and \arg{argv} may be modified by this
 function.
 
+An additional overload of wxEntryStart() is provided under MSW only: it is
+meant to be called with the parameters passed to \texttt{WinMain()}.
+
+\func{bool}{wxEntryStart}{\param{HINSTANCE }{hInstance}, \param{HINSTANCE }{hPrevInstance = \NULL}, \param{char *}{pCmdLine = \NULL}, \param{int }{nCmdShow = \texttt{SW\_SHOWNORMAL}}}
+
+(notice that under Windows CE platform, and only there, the type of 
+\arg{pCmdLine} is \texttt{wchar\_t *}, otherwise it is \texttt{char *}, even in
+Unicode build).
+
 \wxheading{Include files}
 
 <wx/init.h>
@@ -647,6 +653,13 @@ needed). Calling \helpref{wxKill}{wxkill} passing wxKILL\_CHILDREN will
 kill this process as well as all of its children (except those which have
 started their own session).
 
+The {\tt wxEXEC\_NOEVENTS} flag prevents processing of any events from taking
+place while the child process is running. It should be only used for very
+short-lived processes as otherwise the application windows risk becoming
+unresponsive from the users point of view. As this flag only makes sense with
+{\tt wxEXEC\_SYNC}, {\tt wxEXEC\_BLOCK} equal to the sum of both of these flags
+is provided as a convenience.
+
 Finally, you may use the third overloaded version of this function to execute
 a process (always synchronously, the contents of \arg{flags} is or'd with
 \texttt{wxEXEC\_SYNC}) and capture its output in the array \arg{output}. The
@@ -1607,17 +1620,6 @@ if successful, \false otherwise.
 
 \section{String functions}\label{stringfunctions}
 
-
-\membersection{::copystring}\label{copystring}
-
-\func{char *}{copystring}{\param{const char *}{s}}
-
-Makes a copy of the string {\it s} using the C++ new operator, so it can be
-deleted with the {\it delete} operator.
-
-This function is deprecated, use \helpref{wxString}{wxstring} class instead.
-
-
 \membersection{::wxGetTranslation}\label{wxgettranslation}
 
 \func{const wxString\& }{wxGetTranslation}{\param{const wxString\& }{str},
@@ -2007,8 +2009,8 @@ The path and filename are distinct elements of a full file pathname.
 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 or wxFILE\_MUST\_EXIST. Note that wxMULTIPLE
+extension for the required filename. Flags may be a combination of wxFD\_OPEN,
+wxFD\_SAVE, wxFD\_OVERWRITE\_PROMPT or wxFD\_FILE\_MUST\_EXIST. Note that wxFD\_MULTIPLE
 can only be used with \helpref{wxFileDialog}{wxfiledialog} and not here as this
 function only returns a single file name.
 
@@ -3257,7 +3259,10 @@ frame or dialog containing it, or {\tt NULL}.
 
 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).
+(currently this is only supported under Windows). The \arg{url} may also be a
+local file path (with or without \texttt{file://} prefix), if it doesn't
+correspond to an existing file and the URL has no scheme \texttt{http://} is
+prepended to it by default.
 
 Returns \true if the application was successfully launched.
 
@@ -4280,29 +4285,8 @@ this value.
 
 \section{Time functions}\label{timefunctions}
 
-The functions in this section deal with getting the current time and
-starting/stopping the global timers. Please note that the timer functions are
-deprecated because they work with one global timer only and
-\helpref{wxTimer}{wxtimer} and/or \helpref{wxStopWatch}{wxstopwatch} classes
-should be used instead. For retrieving the current time, you may also use
-\helpref{wxDateTime::Now}{wxdatetimenow} or
-\helpref{wxDateTime::UNow}{wxdatetimeunow} methods.
-
-
-\membersection{::wxGetElapsedTime}\label{wxgetelapsedtime}
-
-\func{long}{wxGetElapsedTime}{\param{bool}{ resetTimer = true}}
-
-Gets the time in milliseconds since the last \helpref{::wxStartTimer}{wxstarttimer}.
-
-If {\it resetTimer} is true (the default), the timer is reset to zero
-by this call.
-
-See also \helpref{wxTimer}{wxtimer}.
-
-\wxheading{Include files}
-
-<wx/timer.h>
+The functions in this section deal with getting the current time and sleeping
+for the specified time interval.
 
 
 \membersection{::wxGetLocalTime}\label{wxgetlocaltime}
@@ -4317,7 +4301,7 @@ Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
 
 \wxheading{Include files}
 
-<wx/timer.h>
+<wx/stopwatch.h>
 
 
 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
@@ -4333,7 +4317,7 @@ Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
 
 \wxheading{Include files}
 
-<wx/timer.h>
+<wx/stopwatch.h>
 
 
 \membersection{::wxGetUTCTime}\label{wxgetutctime}
@@ -4348,7 +4332,7 @@ Returns the number of seconds since GMT 00:00:00 Jan 1st 1970.
 
 \wxheading{Include files}
 
-<wx/timer.h>
+<wx/stopwatch.h>
 
 
 \membersection{::wxMicroSleep}\label{wxmicrosleep}
@@ -4400,19 +4384,6 @@ Sleeps for the specified number of seconds.
 <wx/utils.h>
 
 
-\membersection{::wxStartTimer}\label{wxstarttimer}
-
-\func{void}{wxStartTimer}{\void}
-
-Starts a stopwatch; use \helpref{::wxGetElapsedTime}{wxgetelapsedtime} to get the elapsed time.
-
-See also \helpref{wxTimer}{wxtimer}.
-
-\wxheading{Include files}
-
-<wx/timer.h>
-
-
 \membersection{::wxUsleep}\label{wxusleep}
 
 \func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
