]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/dirpicker.tex
Added wxWrapSizer (modified patch: [1826950] Wrapping Sizer) from Arne Steinarson
[wxWidgets.git] / docs / latex / wx / dirpicker.tex
index 89364c49f22b89d9e88b8bdb999a7a2855beefdf..ca09776d09b751570f9ef3901ba0b4b72c99b4b7 100644 (file)
@@ -28,6 +28,10 @@ It is only available if \texttt{wxUSE\_DIRPICKERCTRL} is set to $1$ (the default
 
 <wx/filepicker.h>
 
+\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
@@ -62,7 +69,7 @@ the user's input is valid, e.g. an existing directory path).}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxDirPickerCtrl::wxDirPickerCtrl}\label{wxdirpickerctrl}
+\membersection{wxDirPickerCtrl::wxDirPickerCtrl}\label{wxdirpickerctrlctor}
 
 \func{}{wxDirPickerCtrl}{\param{wxWindow *}{parent},\rtfsp
 \param{wxWindowID}{ id},\rtfsp
@@ -114,19 +121,36 @@ 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}
 
 \constfunc{wxString}{GetPath}{\void}
 
-Returns the currently selected directory.
+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 currently selected directory. his 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.