|
gtkmm 4.12.0
|
A Gtk::ColorDialog object collects the arguments that are needed to present a color chooser dialog to the user, such as a title for the dialog and whether it should be modal. More...
#include <gtkmm/colordialog.h>

Public Member Functions | |
| ColorDialog (ColorDialog && src) noexcept | |
| ColorDialog & | operator= (ColorDialog && src) noexcept |
| ~ColorDialog () noexcept override | |
| GtkColorDialog * | gobj () |
| Provides access to the underlying C GObject. | |
| const GtkColorDialog * | gobj () const |
| Provides access to the underlying C GObject. | |
| GtkColorDialog * | gobj_copy () |
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
| Glib::ustring | get_title () const |
| Returns the title that will be shown on the color chooser dialog. | |
| void | set_title (const Glib::ustring & title) |
| Sets the title that will be shown on the color chooser dialog. | |
| bool | get_modal () const |
| Returns whether the color chooser dialog blocks interaction with the parent window while it is presented. | |
| void | set_modal (bool modal=true) |
| Sets whether the color chooser dialog blocks interaction with the parent window while it is presented. | |
| bool | get_with_alpha () const |
| Returns whether colors may have alpha. | |
| void | set_with_alpha (bool with_alpha=true) |
| Sets whether colors may have alpha. | |
| void | choose_rgba (Window & parent, const Gdk::RGBA & initial_color, const Gio::SlotAsyncReady & slot, const Glib::RefPtr< Gio::Cancellable > & cancellable={}) const |
| This function initiates a color choice operation by presenting a color chooser dialog to the user. | |
| void | choose_rgba (Window & parent, const Gio::SlotAsyncReady & slot, const Glib::RefPtr< Gio::Cancellable > & cancellable={}) const |
| A choose_rgba() convenience overload. | |
| void | choose_rgba (const Gdk::RGBA & initial_color, const Gio::SlotAsyncReady & slot, const Glib::RefPtr< Gio::Cancellable > & cancellable={}) const |
| A choose_rgba() convenience overload. | |
| void | choose_rgba (const Gio::SlotAsyncReady & slot, const Glib::RefPtr< Gio::Cancellable > & cancellable={}) const |
| A choose_rgba() convenience overload. | |
| Gdk::RGBA | choose_rgba_finish (const Glib::RefPtr< Gio::AsyncResult > & result) const |
| Finishes the choose_rgba() call and returns the resulting color. | |
| Glib::PropertyProxy< Glib::ustring > | property_title () |
| A title that may be shown on the color chooser dialog that is presented by Gtk::ColorDialog::choose_rgba(). | |
| Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_title () const |
| A title that may be shown on the color chooser dialog that is presented by Gtk::ColorDialog::choose_rgba(). | |
| Glib::PropertyProxy< bool > | property_modal () |
| Whether the color chooser dialog is modal. | |
| Glib::PropertyProxy_ReadOnly< bool > | property_modal () const |
| Whether the color chooser dialog is modal. | |
| Glib::PropertyProxy< bool > | property_with_alpha () |
| Whether colors may have alpha (translucency). | |
| Glib::PropertyProxy_ReadOnly< bool > | property_with_alpha () const |
| Whether colors may have alpha (translucency). | |
Public Member Functions inherited from Glib::Object | |
| Object (const Object &)=delete | |
| Object & | operator= (const Object &)=delete |
| Object (Object &&src) noexcept | |
| Object & | operator= (Object &&src) noexcept |
| void * | get_data (const QueryQuark &key) |
| void | set_data (const Quark &key, void *data) |
| void | set_data (const Quark &key, void *data, DestroyNotify notify) |
| void | remove_data (const QueryQuark &quark) |
| void * | steal_data (const QueryQuark &quark) |
| Glib::RefPtr< Glib::Object > | wrap (GObject *object, bool take_copy=false) |
Public Member Functions inherited from Glib::ObjectBase | |
| ObjectBase (const ObjectBase &)=delete | |
| ObjectBase & | operator= (const ObjectBase &)=delete |
| void | set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value) |
| void | get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const |
| void | set_property (const Glib::ustring &property_name, const PropertyType &value) |
| void | get_property (const Glib::ustring &property_name, PropertyType &value) const |
| PropertyType | get_property (const Glib::ustring &property_name) const |
| sigc::connection | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot) |
| sigc::connection | connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot) |
| void | freeze_notify () |
| void | thaw_notify () |
| virtual void | reference () const |
| virtual void | unreference () const |
| GObject * | gobj () |
| const GObject * | gobj () const |
| GObject * | gobj_copy () const |
Static Public Member Functions | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. | |
| static Glib::RefPtr< ColorDialog > | create () |
Protected Member Functions | |
| ColorDialog () | |
Protected Member Functions inherited from Glib::Object | |
| Object () | |
| Object (const Glib::ConstructParams &construct_params) | |
| Object (GObject *castitem) | |
| ~Object () noexcept override | |
Protected Member Functions inherited from Glib::ObjectBase | |
| ObjectBase () | |
| ObjectBase (const char *custom_type_name) | |
| ObjectBase (const std::type_info &custom_type_info) | |
| ObjectBase (ObjectBase &&src) noexcept | |
| ObjectBase & | operator= (ObjectBase &&src) noexcept |
| virtual | ~ObjectBase () noexcept=0 |
| void | initialize (GObject *castitem) |
| void | initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper) |
Related Symbols | |
(Note that these are not member symbols.) | |
| Glib::RefPtr< Gtk::ColorDialog > | wrap (GtkColorDialog * object, bool take_copy=false) |
| A Glib::wrap() method for this object. | |
Additional Inherited Members | |
Public Types inherited from Glib::Object | |
| typedef void(*)(gpointer data | DestroyNotify) |
A Gtk::ColorDialog object collects the arguments that are needed to present a color chooser dialog to the user, such as a title for the dialog and whether it should be modal.
The dialog is shown with the choose_rgba() method. This API follows the GIO async pattern, and the result can be obtained by calling choose_rgba_finish().
See Gtk::ColorDialogButton for a convenient control that uses Gtk::ColorDialog and presents the results.
|
noexcept |
|
overridenoexcept |
|
protected |
| void Gtk::ColorDialog::choose_rgba | ( | const Gdk::RGBA & | initial_color, |
| const Gio::SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Gio::Cancellable > & | cancellable = {} |
||
| ) | const |
A choose_rgba() convenience overload.
| void Gtk::ColorDialog::choose_rgba | ( | const Gio::SlotAsyncReady & | slot, |
| const Glib::RefPtr< Gio::Cancellable > & | cancellable = {} |
||
| ) | const |
A choose_rgba() convenience overload.
| void Gtk::ColorDialog::choose_rgba | ( | Window & | parent, |
| const Gdk::RGBA & | initial_color, | ||
| const Gio::SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Gio::Cancellable > & | cancellable = {} |
||
| ) | const |
This function initiates a color choice operation by presenting a color chooser dialog to the user.
The slot will be called when the dialog is dismissed. It should call choose_rgba_finish() to obtain the result.
| parent | The parent Gtk::Window. |
| initial_color | The color to select initially. |
| cancellable | A Cancellable to cancel the operation. |
| slot | A callback to call when the operation is complete. |
| void Gtk::ColorDialog::choose_rgba | ( | Window & | parent, |
| const Gio::SlotAsyncReady & | slot, | ||
| const Glib::RefPtr< Gio::Cancellable > & | cancellable = {} |
||
| ) | const |
A choose_rgba() convenience overload.
| Gdk::RGBA Gtk::ColorDialog::choose_rgba_finish | ( | const Glib::RefPtr< Gio::AsyncResult > & | result | ) | const |
Finishes the choose_rgba() call and returns the resulting color.
| result | A Gio::AsyncResult. |
nullptr and error is set.| Gtk::DialogError |
|
static |
| bool Gtk::ColorDialog::get_modal | ( | ) | const |
Returns whether the color chooser dialog blocks interaction with the parent window while it is presented.
true if the color chooser dialog is modal. | Glib::ustring Gtk::ColorDialog::get_title | ( | ) | const |
Returns the title that will be shown on the color chooser dialog.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
| bool Gtk::ColorDialog::get_with_alpha | ( | ) | const |
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
| GtkColorDialog * Gtk::ColorDialog::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
|
noexcept |
| Glib::PropertyProxy< bool > Gtk::ColorDialog::property_modal | ( | ) |
Whether the color chooser dialog is modal.
Default value: true
| Glib::PropertyProxy_ReadOnly< bool > Gtk::ColorDialog::property_modal | ( | ) | const |
Whether the color chooser dialog is modal.
Default value: true
| Glib::PropertyProxy< Glib::ustring > Gtk::ColorDialog::property_title | ( | ) |
A title that may be shown on the color chooser dialog that is presented by Gtk::ColorDialog::choose_rgba().
Default value: ""
| Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::ColorDialog::property_title | ( | ) | const |
A title that may be shown on the color chooser dialog that is presented by Gtk::ColorDialog::choose_rgba().
Default value: ""
| Glib::PropertyProxy< bool > Gtk::ColorDialog::property_with_alpha | ( | ) |
Whether colors may have alpha (translucency).
When with-alpha is false, the color that is selected will be forced to have alpha == 1.
Default value: true
| Glib::PropertyProxy_ReadOnly< bool > Gtk::ColorDialog::property_with_alpha | ( | ) | const |
Whether colors may have alpha (translucency).
When with-alpha is false, the color that is selected will be forced to have alpha == 1.
Default value: true
| void Gtk::ColorDialog::set_modal | ( | bool | modal = true | ) |
Sets whether the color chooser dialog blocks interaction with the parent window while it is presented.
| modal | The new value. |
| void Gtk::ColorDialog::set_title | ( | const Glib::ustring & | title | ) |
Sets the title that will be shown on the color chooser dialog.
| title | The new title. |
| void Gtk::ColorDialog::set_with_alpha | ( | bool | with_alpha = true | ) |
|
related |
A Glib::wrap() method for this object.
| object | The C instance. |
| take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |