wxEvent::Skip() clarification added

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

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index 3ec711a247571a885e439438716b0e0634dee835..1c17ad10741fa4758bbd420332f112cb7d75d360 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -351,15 +351,15 @@ the front when the dialog box is popped up.
 
 \membersection{::wxFileSelector}\label{wxfileselector}
 
 
 \membersection{::wxFileSelector}\label{wxfileselector}
 

-\func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = NULL},\\
-  \param{const wxString\& }{default\_filename = NULL}, \param{const wxString\& }{default\_extension = NULL},\\
-  \param{const wxString\& }{wildcard = ``*.*''}, \param{int }{flags = 0}, \param{wxWindow *}{parent = NULL},\\
+\func{wxString}{wxFileSelector}{\param{const wxString\& }{message}, \param{const wxString\& }{default\_path = ""},\\
+  \param{const wxString\& }{default\_filename = ""}, \param{const wxString\& }{default\_extension = ""},\\
+  \param{const wxString\& }{wildcard = ``*.*''}, \param{int }{flags = 0}, \param{wxWindow *}{parent = ""},\\

   \param{int}{ x = -1}, \param{int}{ y = -1}}
 
 Pops up a file selector box. In Windows, this is the common file selector
 dialog. In X, this is a file selector box with somewhat less functionality.
 The path and filename are distinct elements of a full file pathname.
   \param{int}{ x = -1}, \param{int}{ y = -1}}
 
 Pops up a file selector box. In Windows, this is the common file selector
 dialog. In X, this is a file selector box with somewhat less functionality.
 The path and filename are distinct elements of a full file pathname.

-If path is NULL, the current directory will be used. If filename is NULL,
+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,
 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,


@@ -380,11 +380,11 @@ types of file with a description for each, such as:
  "BMP files (*.bmp) | *.bmp | GIF files (*.gif) | *.gif"
 \end{verbatim}
 
  "BMP files (*.bmp) | *.bmp | GIF files (*.gif) | *.gif"
 \end{verbatim}
 

-The application must check for a NULL return value (the user pressed
+The application must check for an empty return value (the user pressed

 Cancel). For example:
 
 \begin{verbatim}
 Cancel). For example:
 
 \begin{verbatim}

-const wxString\& s = wxFileSelector("Choose a file to open");
+const wxString& s = wxFileSelector("Choose a file to open");

 if (s)
 {
   ...
 if (s)
 {
   ...


@@ -1434,6 +1434,18 @@ This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}
 
 <wx/memory.h>
 
 
 <wx/memory.h>
 

+\membersection{::wxUsleep}\label{wxusleep}
+
+\func{void}{wxUsleep}{\param{unsigned long}{ milliseconds}}
+
+Sleeps for the specified number of milliseconds. Notice that usage of this
+function is encouraged instead of calling usleep(3) directly because the
+standard usleep() function is not MT safe.
+
+\wxheading{Include files}
+
+<wx/utils.h>
+

 \membersection{::wxWriteResource}\label{wxwriteresource}
 
 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},
 \membersection{::wxWriteResource}\label{wxwriteresource}
 
 \func{bool}{wxWriteResource}{\param{const wxString\& }{section}, \param{const wxString\& }{entry},