Bug 1099143 and more occurences of the same set vs. get mistakes.

[wxWidgets.git] / docs / latex / wx / colordlg.tex

\section{\class{wxColourDialog}}\label{wxcolourdialog}

This class represents the colour chooser dialog.

\wxheading{Derived from}

\helpref{wxDialog}{wxdialog}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/colordlg.h>

\wxheading{See also}

\helpref{wxColourDialog Overview}{wxcolourdialogoverview},\\
\helpref{wxColour}{wxcolour},\\
\helpref{wxColourData}{wxcolourdata},\\
\helpref{wxGetColourFromUser}{wxgetcolourfromuser}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxColourDialog::wxColourDialog}\label{wxcolourdialogctor}

\func{}{wxColourDialog}{\param{wxWindow* }{parent}, \param{wxColourData* }{data = NULL}}

Constructor. Pass a parent window, and optionally a pointer to a block of colour
data, which will be copied to the colour dialog's colour data. Custom
colours from colour data object will be be used in dialog's colour palette.
Invalid entries in custom colours list will be ignored on some platforms (GTK)
or replaced with white colour on platforms where custom colours palette has
fixed size (MSW).

\wxheading{See also}

\helpref{wxColourData}{wxcolourdata}

\membersection{wxColourDialog::\destruct{wxColourDialog}}\label{wxcolourdialogdtor}

\func{}{\destruct{wxColourDialog}}{\void}

Destructor.

\membersection{wxColourDialog::Create}\label{wxcolourdialogcreate}

\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxColourData* }{data = NULL}}

Same as \helpref{constructor}{wxcolourdialogctor}.

\membersection{wxColourDialog::GetColourData}\label{wxcolourdialoggetcolourdata}

\func{wxColourData\&}{GetColourData}{\void}

Returns the \helpref{colour data}{wxcolourdata} associated with the colour dialog.

\membersection{wxColourDialog::ShowModal}\label{wxcolourdialogshowmodal}

\func{int}{ShowModal}{\void}

Shows the dialog, returning wxID\_OK if the user pressed OK, and wxID\_CANCEL
otherwise.