don't use _T() inside wxGetTranslation() and related macros (wxTRANSLATE, _, ......

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

diff --git a/docs/latex/wx/filepicker.tex b/docs/latex/wx/filepicker.tex
index 855a22d6b2935ee37638e4e8a79b9353948e971d..a6fd8cb523e46815445b73d0f4e036edaefcdd2a 100644 (file)
--- a/docs/latex/wx/filepicker.tex
+++ b/docs/latex/wx/filepicker.tex
@@ -28,11 +28,17 @@ It is only available if \texttt{wxUSE\_FILEPICKERCTRL} is set to $1$ (the defaul
 
 <wx/filepicker.h>
 
 
 <wx/filepicker.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{Window styles}
 
 \twocolwidtha{5cm}%
 \begin{twocollist}\itemsep=0pt
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}%
 \begin{twocollist}\itemsep=0pt

-\twocolitem{\windowstyle{wxFLP\_DEFAULT\_STYLE}}{Default style.}
+\twocolitem{\windowstyle{wxFLP\_DEFAULT\_STYLE}}{The default style: includes
+wxFLP\_OPEN | wxFLP\_FILE\_MUST\_EXIST and, under wxMSW only,
+wxFLP\_USE\_TEXTCTRL.}

 \twocolitem{\windowstyle{wxFLP\_USE\_TEXTCTRL}}{Creates a text control to the left of the
 picker button which is completely managed by the \helpref{wxFilePickerCtrl}{wxfilepickerctrl}
 and which can be used by the user to specify a path (see \helpref{SetPath}{wxfilepickerctrlsetpath}).
 \twocolitem{\windowstyle{wxFLP\_USE\_TEXTCTRL}}{Creates a text control to the left of the
 picker button which is completely managed by the \helpref{wxFilePickerCtrl}{wxfilepickerctrl}
 and which can be used by the user to specify a path (see \helpref{SetPath}{wxfilepickerctrlsetpath}).


@@ -49,12 +55,15 @@ NB: the wxFD\_MULTIPLE style of wxFileDialog is not supported!
 
 \wxheading{Event handling}
 
 
 \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
 selected in the control either using the button or using text control (see
 \twocolwidtha{7cm}%
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_FILEPICKER\_CHANGED(id, func)}}{The user changed the file
 selected in the control either using the button or using text control (see

-wxFILEP\_USE\_TEXTCTRL; note that in this case the event is fired only if the
-user's input is valid, e.g. an existing file path if wxFILEP\_FILE\_MUST\_EXIST
+wxFLP\_USE\_TEXTCTRL; note that in this case the event is fired only if the
+user's input is valid, e.g. an existing file path if wxFLP\_FILE\_MUST\_EXIST

 was given).}
 \end{twocollist}
 
 was given).}
 \end{twocollist}
 


@@ -68,14 +77,14 @@ was given).}
 
 \membersection{wxFilePickerCtrl::wxFilePickerCtrl}\label{wxfilepickerctrl}
 
 
 \membersection{wxFilePickerCtrl::wxFilePickerCtrl}\label{wxfilepickerctrl}
 

-\func{}{wxfilepickerctrl}{\param{wxWindow *}{parent},\rtfsp
+\func{}{wxFilePickerCtrl}{\param{wxWindow *}{parent},\rtfsp

 \param{wxWindowID}{ id},\rtfsp
 \param{const wxString\& }{path = wxEmptyString},\rtfsp
 \param{const wxString\& }{message = ``Select a file"},\rtfsp
 \param{const wxString\& }{wildcard = ``*.*"},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{wxWindowID}{ id},\rtfsp
 \param{const wxString\& }{path = wxEmptyString},\rtfsp
 \param{const wxString\& }{message = ``Select a file"},\rtfsp
 \param{const wxString\& }{wildcard = ``*.*"},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp

-\param{long}{ style = wxFILEP\_DEFAULT\_STYLE},\rtfsp
+\param{long}{ style = wxFLP\_DEFAULT\_STYLE},\rtfsp

 \param{const wxValidator\& }{validator = wxDefaultValidator},
 \param{const wxString\& }{name = ``filepickerctrl"}}
 
 \param{const wxValidator\& }{validator = wxDefaultValidator},
 \param{const wxString\& }{name = ``filepickerctrl"}}
 


@@ -92,7 +101,7 @@ all the parameters.
 \param{const wxString\& }{wildcard = ``*.*"},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{const wxString\& }{wildcard = ``*.*"},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp

-\param{long}{ style = wxFILEP\_DEFAULT\_STYLE},\rtfsp
+\param{long}{ style = wxFLP\_DEFAULT\_STYLE},\rtfsp

 \param{const wxValidator\& }{validator = wxDefaultValidator},
 \param{const wxString\& }{name = ``filepickerctrl"}}
 
 \param{const wxValidator\& }{validator = wxDefaultValidator},
 \param{const wxString\& }{name = ``filepickerctrl"}}
 


@@ -106,13 +115,13 @@ all the parameters.
 
 \docparam{message}{The message shown to the user in the \helpref{wxFileDialog}{wxfiledialog} shown by the control.}
 
 
 \docparam{message}{The message shown to the user in the \helpref{wxFileDialog}{wxfiledialog} shown by the control.}
 

-\docparam{wildcard}{A wildcard which defines user-selectable files (use the same syntax as for \helpref{wxFileDialog}{wxfiledialog}'s wildcards.}
+\docparam{wildcard}{A wildcard which defines user-selectable files (use the same syntax as for \helpref{wxFileDialog}{wxfiledialog}'s wildcards).}

 
 \docparam{pos}{Initial position.}
 
 \docparam{size}{Initial size.}
 
 
 \docparam{pos}{Initial position.}
 
 \docparam{size}{Initial size.}
 

-\docparam{style}{The window style, see wxFILEP\_* flags.}
+\docparam{style}{The window style, see {\tt wxFLP\_*} flags.}

 
 \docparam{validator}{Validator which can be used for additional date checks.}
 
 
 \docparam{validator}{Validator which can be used for additional date checks.}
 


@@ -123,19 +132,35 @@ all the parameters.
 \true if the control was successfully created or \false if creation failed.
 
 
 \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}
 
 \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}}
 
 
 
 \membersection{wxFilePickerCtrl::SetPath}\label{wxfilepickerctrlsetpath}
 
 \func{void}{SetPath}{\param{const wxString \&}{filename}}
 

-Sets the currently selected file. This must be a valid file if
-wxFILEP\_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.

 
 
 
 
 
 


@@ -156,6 +181,10 @@ This event class is used for the events generated by
 
 <wx/filepicker.h>
 
 
 <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
 \wxheading{Event handling}
 
 To process input from a wxFilePickerCtrl or from a wxDirPickerCtrl, use one of these event handler macros to


@@ -185,11 +214,12 @@ The constructor is not normally used by the user code.
 
 \constfunc{wxString}{GetPath}{\void}
 
 
 \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}}
 
 
 
 \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.
+