tried to make wxCloseEvent docs more clear too

[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{wxcolourdialogwxcolourdialog}

\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.

\wxheading{See also}

\helpref{wxColourData}{wxcolourdata}

\membersection{wxColourDialog::\destruct{wxColourDialog}}

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

Destructor.

\membersection{wxColourDialog::Create}

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

Same as \helpref{constructor}{wxcolourdialogwxcolourdialog}.

\membersection{wxColourDialog::GetColourData}

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

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

\membersection{wxColourDialog::ShowModal}

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

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