]>
git.saurik.com Git - wxWidgets.git/blob - interface/colordlg.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: documentation for wxColourDialog class
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
13 This class represents the colour chooser dialog.
19 @ref overview_wxcolourdialogoverview "wxColourDialog Overview", wxColour,
20 wxColourData, wxGetColourFromUser
22 class wxColourDialog
: public wxDialog
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. Custom
28 colours from colour data object will be be used in dialog's colour palette.
29 Invalid entries in custom colours list will be ignored on some platforms (GTK)
30 or replaced with white colour on platforms where custom colours palette has
35 wxColourDialog(wxWindow
* parent
, wxColourData
* data
= NULL
);
43 Same as @ref ctor() constructor.
45 bool Create(wxWindow
* parent
, wxColourData
* data
= NULL
);
48 Returns the @ref overview_wxcolourdata "colour data" associated with the colour
51 wxColourData
GetColourData();
54 Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL
61 // ============================================================================
62 // Global functions/macros
63 // ============================================================================
66 Shows the colour selection dialog and returns the colour selected by user or
67 invalid colour (use @ref wxColour::isok wxColour:IsOk to test whether a colour
68 is valid) if the dialog was cancelled.
71 The parent window for the colour selection dialog
73 If given, this will be the colour initially selected in the dialog.
75 If given, this will be used for the dialog caption.
77 Optional object storing additional colour dialog settings, such
78 as custom colours. If none is provided the same settings as the last time
82 wxColour
wxGetColourFromUser(wxWindow
* parent
,
83 const wxColour
& colInit
,
84 const wxString
& caption
= wxEmptyString
,
85 wxColourData
* data
= NULL
);