X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/34c07b8b63651e46aabb7809c25d95dd40736687..4fcbc84d657413b157ac3ef89bf8fbccbcf899ba:/docs/latex/wx/dirpicker.tex?ds=sidebyside diff --git a/docs/latex/wx/dirpicker.tex b/docs/latex/wx/dirpicker.tex index 67b3931ecf..02bf6c9c5b 100644 --- a/docs/latex/wx/dirpicker.tex +++ b/docs/latex/wx/dirpicker.tex @@ -28,6 +28,10 @@ It is only available if \texttt{wxUSE\_DIRPICKERCTRL} is set to $1$ (the default +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Window styles} \twocolwidtha{5cm}% @@ -46,6 +50,9 @@ The text control is automatically synchronized with button's value. Use function \wxheading{Event handling} +To process a directory 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\_DIRPICKER\_CHANGED(id, func)}}{The user changed the @@ -114,6 +121,14 @@ all the parameters. \true if the control was successfully created or \false if creation failed. + +\membersection{wxFilePickerCtrl::GetDirName}\label{wxfilepickerctrlgetdirname} + +\constfunc{wxFileName}{GetDirName}{\void} + +Returns the absolute path of the currently selected directory as a \helpref{wxFileName}{wxfilename} object. +This function is equivalent to \helpref{GetPath}{wxdirpickerctrlgetpath} + \membersection{wxDirPickerCtrl::GetPath}\label{wxdirpickerctrlgetpath} @@ -122,11 +137,20 @@ all the parameters. Returns the absolute path of the currently selected directory. +\membersection{wxFilePickerCtrl::SetDirName}\label{wxfilepickerctrlsetdirname} + +\func{void}{SetDirName}{\param{const wxFileName \&}{dirname}} + +Just like \helpref{SetPath}{wxdirpickerctrlsetpath} but this function takes a +\helpref{wxFileName}{wxfilename} object. + + \membersection{wxDirPickerCtrl::SetPath}\label{wxdirpickerctrlsetpath} \func{void}{SetPath}{\param{const wxString \&}{dirname}} -Sets the absolute path of the currently selected directory. This must be a valid directory if +Sets the absolute path of (the default converter uses current locale's +charset)the currently selected directory. This must be a valid directory if {\tt wxDIRP\_DIR\_MUST\_EXIST} style was given.