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{wxWindow}{wxwindow}\\
	9	\helpref{wxEvtHandler}{wxevthandler}\\
	10	\helpref{wxObject}{wxobject}
	11
	12	\wxheading{Include files}
	13
	14	<wx/dirdlg.h>
	15	<wx/generic/dirdlgg.h>
	16
	17	\wxheading{Window styles}
	18
	19	\twocolwidtha{5cm}
	20	\begin{twocollist}
	21	\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).}
	22	\twocolitem{\windowstyle{wxDD\_NEW\_DIR\_BUTTON}}{Add "Create new
	23	directory" button and allow directory names to be editable. On
	24	Windows the new directory button is only available with recent
	25	versions of the common dialogs.}
	26	\end{twocollist}
	27
	28	See also \helpref{Generic window styles}{windowstyles}.
	29
	30	\wxheading{See also}
	31
	32	\helpref{wxDirDialog overview}{wxdirdialogoverview}, \helpref{wxFileDialog}{wxfiledialog}
	33
	34	\latexignore{\rtfignore{\wxheading{Members}}}
	35
	36	\membersection{wxDirDialog::wxDirDialog}\label{wxdirdialogctor}
	37
	38	\func{}{wxDirDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message = "Choose a directory"},\rtfsp
	39	\param{const wxString\& }{defaultPath = ""}, \param{long }{style = wxDD\_DEFAULT\_STYLE},\rtfsp
	40	\param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
	41	\param{const wxSize\& }{size = wxDefaultSize},\rtfsp
	42	\param{const wxString\& }{name = "wxDirCtrl"}}
	43
	44	Constructor. Use \helpref{wxDirDialog::ShowModal}{wxdirdialogshowmodal} to show
	45	the dialog.
	46
	47	\wxheading{Parameters}
	48
	49	\docparam{parent}{Parent window.}
	50
	51	\docparam{message}{Message to show on the dialog.}
	52
	53	\docparam{defaultPath}{The default path, or the empty string.}
	54
	55	\docparam{style}{The dialog style. See \helpref{wxDirDialog}{wxdirdialog}}
	56
	57	\docparam{pos}{Dialog position. Ignored under Windows.}
	58
	59	\docparam{size}{Dialog size. Ignored under Windows.}
	60
	61	\docparam{name}{The dialog name, not used.}
	62
	63	\membersection{wxDirDialog::\destruct{wxDirDialog}}\label{wxdirdialogdtor}
	64
	65	\func{}{\destruct{wxDirDialog}}{\void}
	66
	67	Destructor.
	68
	69	\membersection{wxDirDialog::GetPath}\label{wxdirdialoggetpath}
	70
	71	\constfunc{wxString}{GetPath}{\void}
	72
	73	Returns the default or user-selected path.
	74
	75	\membersection{wxDirDialog::GetMessage}\label{wxdirdialoggetmessage}
	76
	77	\constfunc{wxString}{GetMessage}{\void}
	78
	79	Returns the message that will be displayed on the dialog.
	80
	81	\membersection{wxDirDialog::GetStyle}\label{wxdirdialoggetstyle}
	82
	83	\constfunc{long}{GetStyle}{\void}
	84
	85	Returns the dialog style.
	86
	87	\membersection{wxDirDialog::SetMessage}\label{wxdirdialogsetmessage}
	88
	89	\func{void}{SetMessage}{\param{const wxString\& }{message}}
	90
	91	Sets the message that will be displayed on the dialog.
	92
	93	\membersection{wxDirDialog::SetPath}\label{wxdirdialogsetpath}
	94
	95	\func{void}{SetPath}{\param{const wxString\& }{path}}
	96
	97	Sets the default path.
	98
	99	\membersection{wxDirDialog::SetStyle}\label{wxdirdialogsetstyle}
	100
	101	\func{void}{SetStyle}{\param{long }{style}}
	102
	103	Sets the dialog style. This is currently unused.
	104
	105	\membersection{wxDirDialog::ShowModal}\label{wxdirdialogshowmodal}
	106
	107	\func{int}{ShowModal}{\void}
	108
	109	Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
	110	otherwise.
	111
	112