fix ReceiveTimeout() reference

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

diff --git a/docs/latex/wx/filepicker.tex b/docs/latex/wx/filepicker.tex
index 46b2a7db49822ca69fdda4d2ed18d434ce196749..687439b6ede2bbebaeb89111e13a12963eb800bd 100644 (file)
--- a/docs/latex/wx/filepicker.tex
+++ b/docs/latex/wx/filepicker.tex
@@ -28,6 +28,10 @@ It is only available if \texttt{wxUSE\_FILEPICKERCTRL} is set to $1$ (the defaul
 
 <wx/filepicker.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}%
@@ -51,6 +55,9 @@ NB: the wxFD\_MULTIPLE style of wxFileDialog is not supported!
 
 \wxheading{Event handling}
 
+To process a file picker event, use these event handler macros to direct input to member
+functions that take a \helpref{wxFileDirPickerEvent}{wxfiledirpickerevent} argument.
+
 \twocolwidtha{7cm}%
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_FILEPICKER\_CHANGED(id, func)}}{The user changed the file
@@ -68,7 +75,7 @@ was given).}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxFilePickerCtrl::wxFilePickerCtrl}\label{wxfilepickerctrl}
+\membersection{wxFilePickerCtrl::wxFilePickerCtrl}\label{wxfilepickerctrlctor}
 
 \func{}{wxFilePickerCtrl}{\param{wxWindow *}{parent},\rtfsp
 \param{wxWindowID}{ id},\rtfsp
@@ -125,19 +132,35 @@ all the parameters.
 \true if the control was successfully created or \false if creation failed.
 
 
+\membersection{wxFilePickerCtrl::GetFileName}\label{wxfilepickerctrlgetfilename}
+
+\constfunc{wxFileName}{GetFileName}{\void}
+
+Similar to \helpref{GetPath}{wxfilepickerctrlgetpath} but returns the path of
+the currently selected file as a \helpref{wxFileName}{wxfilename} object.
+
+
 \membersection{wxFilePickerCtrl::GetPath}\label{wxfilepickerctrlgetpath}
 
 \constfunc{wxString}{GetPath}{\void}
 
-Returns the currently selected file.
+Returns the absolute path of the currently selected file.
+
+
+\membersection{wxFilePickerCtrl::SetFileName}\label{wxfilepickerctrlsetfilename}
+
+\func{void}{SetFileName}{\param{const wxFileName \&}{filename}}
+
+This method does the same thing as \helpref{SetPath}{wxfilepickerctrlsetpath} but
+takes a \helpref{wxFileName}{wxfilename} object instead of a string.
 
 
 \membersection{wxFilePickerCtrl::SetPath}\label{wxfilepickerctrlsetpath}
 
 \func{void}{SetPath}{\param{const wxString \&}{filename}}
 
-Sets the currently selected file. This must be a valid file if
-{\tt wxFLP\_FILE\_MUST\_EXIST} style was given.
+Sets the absolute path of the currently selected file. This must be a valid file if
+the {\tt wxFLP\_FILE\_MUST\_EXIST} style was given.
 
 
 
@@ -158,6 +181,10 @@ This event class is used for the events generated by
 
 <wx/filepicker.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{Event handling}
 
 To process input from a wxFilePickerCtrl or from a wxDirPickerCtrl, use one of these event handler macros to
@@ -187,11 +214,12 @@ The constructor is not normally used by the user code.
 
 \constfunc{wxString}{GetPath}{\void}
 
-Retrieve the file/directory the user has just selected.
+Retrieve the absolute path of the file/directory the user has just selected.
 
 
 \membersection{wxFileDirPickerEvent::SetPath}\label{wxfiledirpickereventsetpath}
 
 \func{void}{SetPath}{\param{const wxString \&}{path}}
 
-Set the file/directory associated with the event.
+Set the absolute path of the file/directory associated with the event.
+