git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	\section{\class{wxDirDialog}}\label{wxdirdialog}
	2
	3	This class represents the directory chooser dialog.
	4
	5	\wxheading{Derived from}
	6
	7	\helpref{wxDialog}{wxdialog}\\
	8	\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
	9	\helpref{wxWindow}{wxwindow}\\
	10	\helpref{wxEvtHandler}{wxevthandler}\\
	11	\helpref{wxObject}{wxobject}
	12
	13	\wxheading{Include files}
	14
	15	<wx/dirdlg.h>
	16
	17	\wxheading{Library}
	18
	19	\helpref{wxCore}{librarieslist}
	20
	21	\wxheading{Window styles}
	22
	23	\begin{twocollist}\itemsep=0pt
	24	\twocolitem{\windowstyle{wxDD\_DEFAULT\_STYLE}}{Equivalent to a combination of wxDEFAULT\_DIALOG\_STYLE and wxRESIZE\_BORDER (the last one is not used under wxWinCE).}
	25	\twocolitem{\windowstyle{wxDD\_DIR\_MUST\_EXIST}}{The dialog will allow the user to choose only an existing folder. When this style is not given, a "Create new directory" button is added to the dialog (on Windows) or some other way is provided to the user to type the name of a new folder.}
	26	\twocolitem{\windowstyle{wxDD\_CHANGE\_DIR}}{Change the current working directory to the directory chosen by the user.}
	27	\end{twocollist}
	28
	29	{\bf NB:} on Windows the new directory button is only available with recent versions of the common dialogs.
	30
	31	See also \helpref{Generic window styles}{windowstyles}.
	32
	33	\wxheading{See also}
	34
	35	\helpref{wxDirDialog overview}{wxdirdialogoverview}, \helpref{wxFileDialog}{wxfiledialog}
	36
	37	\latexignore{\rtfignore{\wxheading{Members}}}
	38
	39	\membersection{wxDirDialog::wxDirDialog}\label{wxdirdialogctor}
	40
	41	\func{}{wxDirDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message = "Choose a directory"},\rtfsp
	42	\param{const wxString\& }{defaultPath = ""}, \param{long }{style = wxDD\_DEFAULT\_STYLE},\rtfsp
	43	\param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
	44	\param{const wxSize\& }{size = wxDefaultSize},\rtfsp
	45	\param{const wxString\& }{name = "wxDirCtrl"}}
	46
	47	Constructor. Use \helpref{wxDirDialog::ShowModal}{wxdirdialogshowmodal} to show
	48	the dialog.
	49
	50	\wxheading{Parameters}
	51
	52	\docparam{parent}{Parent window.}
	53
	54	\docparam{message}{Message to show on the dialog.}
	55
	56	\docparam{defaultPath}{The default path, or the empty string.}
	57
	58	\docparam{style}{The dialog style. See \helpref{wxDirDialog}{wxdirdialog}}
	59
	60	\docparam{pos}{Dialog position. Ignored under Windows.}
	61
	62	\docparam{size}{Dialog size. Ignored under Windows.}
	63
	64	\docparam{name}{The dialog name, not used.}
	65
	66	\membersection{wxDirDialog::\destruct{wxDirDialog}}\label{wxdirdialogdtor}
	67
	68	\func{}{\destruct{wxDirDialog}}{\void}
	69
	70	Destructor.
	71
	72	\membersection{wxDirDialog::GetPath}\label{wxdirdialoggetpath}
	73
	74	\constfunc{wxString}{GetPath}{\void}
	75
	76	Returns the default or user-selected path.
	77
	78	\membersection{wxDirDialog::GetMessage}\label{wxdirdialoggetmessage}
	79
	80	\constfunc{wxString}{GetMessage}{\void}
	81
	82	Returns the message that will be displayed on the dialog.
	83
	84	\membersection{wxDirDialog::SetMessage}\label{wxdirdialogsetmessage}
	85
	86	\func{void}{SetMessage}{\param{const wxString\& }{message}}
	87
	88	Sets the message that will be displayed on the dialog.
	89
	90	\membersection{wxDirDialog::SetPath}\label{wxdirdialogsetpath}
	91
	92	\func{void}{SetPath}{\param{const wxString\& }{path}}
	93
	94	Sets the default path.
	95
	96	\membersection{wxDirDialog::ShowModal}\label{wxdirdialogshowmodal}
	97
	98	\func{int}{ShowModal}{\void}
	99
	100	Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
	101	otherwise.
	102
	103