]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/colordlg.tex
added and documented wxDEFINE_SCOPED_PTR_TYPE; improved docs a bit
[wxWidgets.git] / docs / latex / wx / colordlg.tex
... / ...
CommitLineData
1\section{\class{wxColourDialog}}\label{wxcolourdialog}
2
3This class represents the colour 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/colordlg.h>
15
16\wxheading{See also}
17
18\helpref{wxColourDialog Overview}{wxcolourdialogoverview},\\
19\helpref{wxColour}{wxcolour},\\
20\helpref{wxColourData}{wxcolourdata},\\
21\helpref{wxGetColourFromUser}{wxgetcolourfromuser}
22
23\latexignore{\rtfignore{\wxheading{Members}}}
24
25\membersection{wxColourDialog::wxColourDialog}\label{wxcolourdialogwxcolourdialog}
26
27\func{}{wxColourDialog}{\param{wxWindow* }{parent}, \param{wxColourData* }{data = NULL}}
28
29Constructor. Pass a parent window, and optionally a pointer to a block of colour
30data, which will be copied to the colour dialog's colour data.
31
32\wxheading{See also}
33
34\helpref{wxColourData}{wxcolourdata}
35
36\membersection{wxColourDialog::\destruct{wxColourDialog}}
37
38\func{}{\destruct{wxColourDialog}}{\void}
39
40Destructor.
41
42\membersection{wxColourDialog::Create}
43
44\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxColourData* }{data = NULL}}
45
46Same as \helpref{constructor}{wxcolourdialogwxcolourdialog}.
47
48\membersection{wxColourDialog::GetColourData}
49
50\func{wxColourData\&}{GetColourData}{\void}
51
52Returns the \helpref{colour data}{wxcolourdata} associated with the colour dialog.
53
54\membersection{wxColourDialog::ShowModal}
55
56\func{int}{ShowModal}{\void}
57
58Shows the dialog, returning wxID\_OK if the user pressed OK, and wxOK\_CANCEL
59otherwise.
60
61