]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/colordlg.tex
wxRichTextAttr does not exist anymore - document instead wxTextAttr
[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{wxTopLevelWindow}{wxtoplevelwindow}\\
9\helpref{wxWindow}{wxwindow}\\
10\helpref{wxEvtHandler}{wxevthandler}\\
11\helpref{wxObject}{wxobject}
12
13\wxheading{Include files}
14
15<wx/colordlg.h>
16
17\wxheading{Library}
18
19\helpref{wxCore}{librarieslist}
20
21\wxheading{See also}
22
23\helpref{wxColourDialog Overview}{wxcolourdialogoverview},\\
24\helpref{wxColour}{wxcolour},\\
25\helpref{wxColourData}{wxcolourdata},\\
26\helpref{wxGetColourFromUser}{wxgetcolourfromuser}
27
28\latexignore{\rtfignore{\wxheading{Members}}}
29
30\membersection{wxColourDialog::wxColourDialog}\label{wxcolourdialogctor}
31
32\func{}{wxColourDialog}{\param{wxWindow* }{parent}, \param{wxColourData* }{data = NULL}}
33
34Constructor. Pass a parent window, and optionally a pointer to a block of colour
35data, which will be copied to the colour dialog's colour data. Custom
36colours from colour data object will be be used in dialog's colour palette.
37Invalid entries in custom colours list will be ignored on some platforms (GTK)
38or replaced with white colour on platforms where custom colours palette has
39fixed size (MSW).
40
41\wxheading{See also}
42
43\helpref{wxColourData}{wxcolourdata}
44
45\membersection{wxColourDialog::\destruct{wxColourDialog}}\label{wxcolourdialogdtor}
46
47\func{}{\destruct{wxColourDialog}}{\void}
48
49Destructor.
50
51\membersection{wxColourDialog::Create}\label{wxcolourdialogcreate}
52
53\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxColourData* }{data = NULL}}
54
55Same as \helpref{constructor}{wxcolourdialogctor}.
56
57\membersection{wxColourDialog::GetColourData}\label{wxcolourdialoggetcolourdata}
58
59\func{wxColourData\&}{GetColourData}{\void}
60
61Returns the \helpref{colour data}{wxcolourdata} associated with the colour dialog.
62
63\membersection{wxColourDialog::ShowModal}\label{wxcolourdialogshowmodal}
64
65\func{int}{ShowModal}{\void}
66
67Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
68otherwise.
69
70