Spacing tweak

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

\section{\class{wxDirDialog}}\label{wxdirdialog}

This class represents the directory chooser dialog.

\wxheading{Derived from}

\helpref{wxDialog}{wxdialog}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/dirdlg.h>
<wx/generic/dirdlgg.h>

\wxheading{Window styles}

\twocolwidtha{5cm}
\begin{twocollist}
\twocolitem{\windowstyle{wxDD\_DEFAULT\_STYLE}}{Equivalent to a combination of wxDEFAULT\_DIALOG\_STYLE, wxDD\_NEW\_DIR\_BUTTON and wxRESIZE\_BORDER (the last one is not used under wxWinCE).}
\twocolitem{\windowstyle{wxDD\_NEW\_DIR\_BUTTON}}{Add "Create new
directory" button and allow directory names to be editable.  On
Windows the new directory button is only available with recent
versions of the common dialogs.}
\end{twocollist}

See also \helpref{Generic window styles}{windowstyles}.

\wxheading{See also}

\helpref{wxDirDialog overview}{wxdirdialogoverview}, \helpref{wxFileDialog}{wxfiledialog}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxDirDialog::wxDirDialog}\label{wxdirdialogctor}

\func{}{wxDirDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message = "Choose a directory"},\rtfsp
\param{const wxString\& }{defaultPath = ""}, \param{long }{style = wxDD\_DEFAULT\_STYLE},\rtfsp
\param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
\param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{const wxString\& }{name = "wxDirCtrl"}}

Constructor. Use \helpref{wxDirDialog::ShowModal}{wxdirdialogshowmodal} to show
the dialog.

\wxheading{Parameters}

\docparam{parent}{Parent window.}

\docparam{message}{Message to show on the dialog.}

\docparam{defaultPath}{The default path, or the empty string.}

\docparam{style}{The dialog style. See \helpref{wxDirDialog}{wxdirdialog}}

\docparam{pos}{Dialog position. Ignored under Windows.}

\docparam{size}{Dialog size. Ignored under Windows.}

\docparam{name}{The dialog name, not used.}

\membersection{wxDirDialog::\destruct{wxDirDialog}}\label{wxdirdialogdtor}

\func{}{\destruct{wxDirDialog}}{\void}

Destructor.

\membersection{wxDirDialog::GetPath}\label{wxdirdialoggetpath}

\constfunc{wxString}{GetPath}{\void}

Returns the default or user-selected path.

\membersection{wxDirDialog::GetMessage}\label{wxdirdialoggetmessage}

\constfunc{wxString}{GetMessage}{\void}

Returns the message that will be displayed on the dialog.

\membersection{wxDirDialog::GetStyle}\label{wxdirdialoggetstyle}

\constfunc{long}{GetStyle}{\void}

Returns the dialog style.

\membersection{wxDirDialog::SetMessage}\label{wxdirdialogsetmessage}

\func{void}{SetMessage}{\param{const wxString\& }{message}}

Sets the message that will be displayed on the dialog.

\membersection{wxDirDialog::SetPath}\label{wxdirdialogsetpath}

\func{void}{SetPath}{\param{const wxString\& }{path}}

Sets the default path.

\membersection{wxDirDialog::SetStyle}\label{wxdirdialogsetstyle}

\func{void}{SetStyle}{\param{long }{style}}

Sets the dialog style. This is currently unused.

\membersection{wxDirDialog::ShowModal}\label{wxdirdialogshowmodal}

\func{int}{ShowModal}{\void}

Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
otherwise.