interface/colordlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        colordlg.h
   3 // Purpose:     interface of wxColourDialog
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxColourDialog
  11     @wxheader{colordlg.h}
  12
  13     This class represents the colour chooser dialog.
  14
  15     @library{wxcore}
  16     @category{cmndlg}
  17
  18     @see @ref overview_wxcolourdialogoverview "wxColourDialog Overview", wxColour,
  19     wxColourData, wxGetColourFromUser()
  20 */
  21 class wxColourDialog : public wxDialog
  22 {
  23 public:
  24     /**
  25         Constructor. Pass a parent window, and optionally a pointer to a block of colour
  26         data, which will be copied to the colour dialog's colour data. Custom
  27         colours from colour data object will be be used in dialog's colour palette.
  28         Invalid entries in custom colours list will be ignored on some platforms (GTK)
  29         or replaced with white colour on platforms where custom colours palette has
  30         fixed size (MSW).
  31
  32         @see wxColourData
  33     */
  34     wxColourDialog(wxWindow* parent, wxColourData* data = NULL);
  35
  36     /**
  37         Destructor.
  38     */
  39     ~wxColourDialog();
  40
  41     /**
  42         Same as @ref ctor() constructor.
  43     */
  44     bool Create(wxWindow* parent, wxColourData* data = NULL);
  45
  46     /**
  47         Returns the @ref overview_wxcolourdata "colour data" associated with the colour
  48         dialog.
  49     */
  50     wxColourData GetColourData();
  51
  52     /**
  53         Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL
  54         otherwise.
  55     */
  56     int ShowModal();
  57 };
  58
  59
  60
  61 // ============================================================================
  62 // Global functions/macros
  63 // ============================================================================
  64
  65 /** @ingroup group_funcmacro_dialog */
  66 //@{
  67
  68 /**
  69     Shows the colour selection dialog and returns the colour selected by user
  70     or invalid colour (use wxColour::IsOk() to test whether a colour is valid)
  71     if the dialog was cancelled.
  72
  73     @param parent
  74         The parent window for the colour selection dialog.
  75     @param colInit
  76         If given, this will be the colour initially selected in the dialog.
  77     @param caption
  78         If given, this will be used for the dialog caption.
  79     @param data
  80         Optional object storing additional colour dialog settings, such as
  81         custom colours. If none is provided the same settings as the last time
  82         are used.
  83
  84     @header{wx/colordlg.h}
  85 */
  86 wxColour wxGetColourFromUser(wxWindow* parent,
  87                              const wxColour& colInit,
  88                              const wxString& caption = wxEmptyString,
  89                              wxColourData* data = NULL);
  90
  91 //@}
  92