]>
git.saurik.com Git - wxWidgets.git/blob - interface/colordlg.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxColourDialog
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
13 This class represents the colour chooser dialog.
18 @see @ref overview_wxcolourdialogoverview "wxColourDialog Overview", wxColour,
19 wxColourData, wxGetColourFromUser()
21 class wxColourDialog
: public wxDialog
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
34 wxColourDialog(wxWindow
* parent
, wxColourData
* data
= NULL
);
42 Same as @ref ctor() constructor.
44 bool Create(wxWindow
* parent
, wxColourData
* data
= NULL
);
47 Returns the @ref overview_wxcolourdata "colour data" associated with the colour
50 wxColourData
GetColourData();
53 Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL
61 // ============================================================================
62 // Global functions/macros
63 // ============================================================================
65 /** @ingroup group_funcmacro_dialog */
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.
74 The parent window for the colour selection dialog.
76 If given, this will be the colour initially selected in the dialog.
78 If given, this will be used for the dialog caption.
80 Optional object storing additional colour dialog settings, such as
81 custom colours. If none is provided the same settings as the last time
84 @header{wx/colordlg.h}
86 wxColour
wxGetColourFromUser(wxWindow
* parent
,
87 const wxColour
& colInit
,
88 const wxString
& caption
= wxEmptyString
,
89 wxColourData
* data
= NULL
);