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
	16	\wxheading{See also}
	17
	18	\helpref{wxDirDialog overview}{wxdirdialogoverview}, \helpref{wxFileDialog}{wxfiledialog}
	19
	20	\latexignore{\rtfignore{\wxheading{Members}}}
	21
	22	\membersection{wxDirDialog::wxDirDialog}\label{wxdirdialogconstr}
	23
	24	\func{}{wxDirDialog}{\param{wxWindow* }{parent}, \param{const wxString\& }{message = "Choose a directory"},\rtfsp
	25	\param{const wxString\& }{defaultPath = ""}, \param{long }{style = 0}, \param{const wxPoint\& }{pos = wxDefaultPosition}}
	26
	27	Constructor. Use \helpref{wxDirDialog::ShowModal}{wxdirdialogshowmodal} to show the dialog.
	28
	29	\wxheading{Parameters}
	30
	31	\docparam{parent}{Parent window.}
	32
	33	\docparam{message}{Message to show on the dialog.}
	34
	35	\docparam{defaultPath}{The default path, or the empty string.}
	36
	37	\docparam{style}{A dialog style, currently unused.}
	38
	39	\docparam{pos}{Dialog position. Not implemented.}
	40
	41	\membersection{wxDirDialog::\destruct{wxDirDialog}}
	42
	43	\func{}{\destruct{wxDirDialog}}{\void}
	44
	45	Destructor.
	46
	47	\membersection{wxDirDialog::GetPath}\label{wxdirdialoggetpath}
	48
	49	\constfunc{wxString}{GetPath}{\void}
	50
	51	Returns the default or user-selected path.
	52
	53	\membersection{wxDirDialog::GetMessage}\label{wxdirdialoggetmessage}
	54
	55	\constfunc{wxString}{GetMessage}{\void}
	56
	57	Returns the message that will be displayed on the dialog.
	58
	59	\membersection{wxDirDialog::GetStyle}\label{wxdirdialoggetstyle}
	60
	61	\constfunc{long}{GetStyle}{\void}
	62
	63	Returns the dialog style.
	64
	65	\membersection{wxDirDialog::SetMessage}\label{wxdirdialogsetmessage}
	66
	67	\func{void}{SetMessage}{\param{const wxString\& }{message}}
	68
	69	Sets the message that will be displayed on the dialog.
	70
	71	\membersection{wxDirDialog::SetPath}\label{wxdirdialogsetpath}
	72
	73	\func{void}{SetPath}{\param{const wxString\& }{path}}
	74
	75	Sets the default path.
	76
	77	\membersection{wxDirDialog::SetStyle}\label{wxdirdialogsetstyle}
	78
	79	\func{void}{SetStyle}{\param{long }{style}}
	80
	81	Sets the dialog style. This is currently unused.
	82
	83	\membersection{wxDirDialog::ShowModal}\label{wxdirdialogshowmodal}
	84
	85	\func{int}{ShowModal}{\void}
	86
	87	Shows the dialog, returning wxID\_OK if the user pressed OK, and wxOK\_CANCEL
	88	otherwise.
	89
	90