]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/colordlg.tex
Line-up interfaces to use size_t for GetCount()s (and count related api).
[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{wxcolourdialogctor}
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. Custom
31colours from colour data object will be be used in dialog's colour palette.
32Invalid entries in custom colours list will be ignored on some platforms (GTK)
33or replaced with white colour on platforms where custom colours palette has
34fixed size (MSW).
35
36\wxheading{See also}
37
38\helpref{wxColourData}{wxcolourdata}
39
40\membersection{wxColourDialog::\destruct{wxColourDialog}}\label{wxcolourdialogdtor}
41
42\func{}{\destruct{wxColourDialog}}{\void}
43
44Destructor.
45
46\membersection{wxColourDialog::Create}\label{wxcolourdialogcreate}
47
48\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxColourData* }{data = NULL}}
49
50Same as \helpref{constructor}{wxcolourdialogctor}.
51
52\membersection{wxColourDialog::GetColourData}\label{wxcolourdialoggetcolourdata}
53
54\func{wxColourData\&}{GetColourData}{\void}
55
56Returns the \helpref{colour data}{wxcolourdata} associated with the colour dialog.
57
58\membersection{wxColourDialog::ShowModal}\label{wxcolourdialogshowmodal}
59
60\func{int}{ShowModal}{\void}
61
62Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
63otherwise.
64
65