X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ec376c8fd9ff813392030426acd2317c6fa6527e..d60156ac9d764d9ee6cf866a87084732d341abb9:/docs/latex/wx/filepicker.tex diff --git a/docs/latex/wx/filepicker.tex b/docs/latex/wx/filepicker.tex index 855a22d6b2..e7831f37ff 100644 --- a/docs/latex/wx/filepicker.tex +++ b/docs/latex/wx/filepicker.tex @@ -32,7 +32,9 @@ It is only available if \texttt{wxUSE\_FILEPICKERCTRL} is set to $1$ (the defaul \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}). @@ -53,8 +55,8 @@ NB: the wxFD\_MULTIPLE style of wxFileDialog is not supported! \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} @@ -68,14 +70,14 @@ was given).} \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{long}{ style = wxFILEP\_DEFAULT\_STYLE},\rtfsp +\param{long}{ style = wxFLP\_DEFAULT\_STYLE},\rtfsp \param{const wxValidator\& }{validator = wxDefaultValidator}, \param{const wxString\& }{name = ``filepickerctrl"}} @@ -92,7 +94,7 @@ all the parameters. \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"}} @@ -106,13 +108,13 @@ all the parameters. \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{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.} @@ -127,15 +129,15 @@ all the parameters. \constfunc{wxString}{GetPath}{\void} -Returns the currently selected file. +Returns the absolute path of the currently selected file. \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. @@ -185,11 +187,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. +