docs/latex/wx/colordlg.tex

   1 \section{\class{wxColourDialog}}\label{wxcolourdialog}
   2
   3 This 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}, \helpref{wxColour}{wxcolour}, \helpref{wxColourData}{wxcolourdata}
  19
  20 \latexignore{\rtfignore{\wxheading{Members}}}
  21
  22 \membersection{wxColourDialog::wxColourDialog}\label{wxcolourdialogwxcolourdialog}
  23
  24 \func{}{wxColourDialog}{\param{wxWindow* }{parent}, \param{wxColourData* }{data = NULL}}
  25
  26 Constructor. Pass a parent window, and optionally a pointer to a block of colour
  27 data, which will be copied to the colour dialog's colour data.
  28
  29 \wxheading{See also}
  30
  31 \helpref{wxColourData}{wxcolourdata}
  32
  33 \membersection{wxColourDialog::\destruct{wxColourDialog}}
  34
  35 \func{}{\destruct{wxColourDialog}}{\void}
  36
  37 Destructor.
  38
  39 \membersection{wxColourDialog::Create}
  40
  41 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxColourData* }{data = NULL}}
  42
  43 Same as \helpref{constructor}{wxcolourdialogwxcolourdialog}.
  44
  45 \membersection{wxColourDialog::GetColourData}
  46
  47 \func{wxColourData\&}{GetColourData}{\void}
  48
  49 Returns the \helpref{colour data}{wxcolourdata} associated with the colour dialog.
  50
  51 \membersection{wxColourDialog::ShowModal}
  52
  53 \func{int}{ShowModal}{\void}
  54
  55 Shows the dialog, returning wxID\_OK if the user pressed OK, and wxOK\_CANCEL
  56 otherwise.
  57
  58