Applied Patch #1502804: wx*PickerCtrl documentation fixes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39639 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2006-06-08 19:10:00 +00:00
parent df39467f88
commit aaa6f9ba6b
5 changed files with 29 additions and 37 deletions

View File

@@ -53,8 +53,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 +68,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 +92,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 +106,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.}
@@ -135,7 +135,7 @@ Returns the currently selected file.
\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.
{\tt wxFLP\_FILE\_MUST\_EXIST} style was given.