gtkmm: Gtk::ColorChooser Class Reference
This interface can be implemented by widgets which allow the user to choose a color. More...
#include <gtkmm/colorchooser.h>

Public Member Functions |
|
ColorChooser ( ColorChooser && src) noexcept | |
ColorChooser & | operator= ( ColorChooser && src) noexcept |
~ColorChooser () noexceptoverride | |
GtkColorChooser* | gobj () |
Provides access to the underlying C GObject.
More...
|
|
const GtkColorChooser* | gobj () const |
Provides access to the underlying C GObject.
More...
|
|
Gdk::RGBA | get_rgba () const |
Gets the currently selected color.
More...
|
|
void | set_rgba (const Gdk::RGBA & color) |
Sets the color.
More...
|
|
bool | get_use_alpha () const |
Returns whether the color chooser shows the alpha channel.
More...
|
|
void | set_use_alpha (bool use_alpha=true) |
Sets whether or not the color chooser should use the alpha channel.
More...
|
|
void | add_palette ( Orientation orientation, int colors_per_line, const std::vector < Gdk::RGBA >& colors) |
Adds a palette to the color chooser.
More...
|
|
Glib::SignalProxy < void, const Gdk::RGBA & > | signal_color_activated () |
Glib::PropertyProxy < Gdk::RGBA > | property_rgba () |
The
property_rgba()
property contains the currently selected color, as a
Gdk::RGBA
struct.
More...
|
|
Glib::PropertyProxy_ReadOnly < Gdk::RGBA > | property_rgba () const |
The
property_rgba()
property contains the currently selected color, as a
Gdk::RGBA
struct.
More...
|
|
Glib::PropertyProxy < bool > | property_use_alpha () |
When signal_use_alpha() is
true
, colors may have alpha (translucency) information.
More...
|
|
Glib::PropertyProxy_ReadOnly < bool > | property_use_alpha () const |
When signal_use_alpha() is
true
, colors may have alpha (translucency) information.
More...
|
|
![]() |
|
Interface () | |
Interface ( Interface &&src) noexcept | |
Interface & | operator= ( Interface &&src) noexcept |
Interface (const Glib::Interface_Class &interface_class) | |
Interface (GObject *castitem) | |
~Interface () noexceptoverride | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject * | gobj () |
const GObject * | gobj () const |
![]() |
|
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 |
void | connect_property_changed (const Glib::ustring &property_name, const sigc::slot < void > &slot) |
void | connect_property_changed (const Glib::ustring &property_name, sigc::slot < void > &&slot) |
sigc::connection | connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot < void > &slot) |
sigc::connection | connect_property_changed_with_return (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 |
![]() |
|
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable ( trackable &&src) | |
~trackable () | |
void | add_destroy_notify_callback (void *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= ( trackable &&src) |
void | remove_destroy_notify_callback (void *data) const |
Static Public Member Functions |
|
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system.
More...
|
|
Protected Member Functions |
|
ColorChooser () | |
You should derive from this class to use it.
More...
|
|
virtual void | on_color_activated (const Gdk::RGBA & color) |
This is a default handler for the signal
signal_color_activated()
.
More...
|
|
![]() |
|
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 Functions |
|
(Note that these are not member functions.) |
|
Glib::RefPtr < Gtk::ColorChooser > | wrap (GtkColorChooser* object, bool take_copy=false) |
A
Glib::wrap()
method for this object.
More...
|
|
Additional Inherited Members |
|
![]() |
|
typedef internal::func_destroy_notify | func_destroy_notify |
Detailed Description
This interface can be implemented by widgets which allow the user to choose a color.
Depending on the situation, colors may be allowed to have alpha (translucency). The main widgets that implement this interface are ColorChooserWidget, ColorChooserDialog and ColorChooserButton.
Constructor & Destructor Documentation
|
protected |
You should derive from this class to use it.
|
noexcept |
|
override noexcept |
Member Function Documentation
|
static |
void Gtk::ColorChooser::add_palette | ( | Orientation | orientation , |
int | colors_per_line , | ||
const std::vector < Gdk::RGBA >& | colors | ||
) |
Adds a palette to the color chooser.
If orientation is horizontal, the colors are grouped in rows, with colors_per_line colors in each row. If orientation is vertical, the colors are grouped in columns instead.
The default color palette of ColorChooserWidget has 27 colors, organized in columns of 3 colors. The default gray palette has 9 grays in a single row.
The layout of the color chooser widget works best when the palettes have 9-10 columns.
Calling this function for the first time has the side effect of removing the default color and gray palettes from the color chooser.
- Parameters
-
orientation ORIENTATION_HORIZONTAL if the palette should be displayed in rows, or ORIENTATION_VERTICAL for columns colors_per_line The number of colors to show in each row/column. colors The colors of the palette.
Gdk::RGBA Gtk::ColorChooser::get_rgba | ( | ) | const |
|
static |
Get the GType for this class, for use with the underlying GObject type system.
bool Gtk::ColorChooser::get_use_alpha | ( | ) | const |
Returns whether the color chooser shows the alpha channel.
- Returns
-
true
if the color chooser uses the alpha channel,false
if not.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
|
protected virtual |
This is a default handler for the signal signal_color_activated() .
|
noexcept |
Glib::PropertyProxy < Gdk::RGBA > Gtk::ColorChooser::property_rgba | ( | ) |
The property_rgba() property contains the currently selected color, as a Gdk::RGBA struct.
The property can be set to change the current selection programmatically.
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly < Gdk::RGBA > Gtk::ColorChooser::property_rgba | ( | ) | const |
The property_rgba() property contains the currently selected color, as a Gdk::RGBA struct.
The property can be set to change the current selection programmatically.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy < bool > Gtk::ColorChooser::property_use_alpha | ( | ) |
When signal_use_alpha() is
true
, colors may have alpha (translucency) information.
When it is
false
, the
Gdk::RGBA
struct obtained via the
Gtk::ColorChooser::property_rgba()
property will be forced to have alpha == 1.
Implementations are expected to show alpha by rendering the color over a non-uniform background (like a checkerboard pattern).
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly < bool > Gtk::ColorChooser::property_use_alpha | ( | ) | const |
When signal_use_alpha() is
true
, colors may have alpha (translucency) information.
When it is
false
, the
Gdk::RGBA
struct obtained via the
Gtk::ColorChooser::property_rgba()
property will be forced to have alpha == 1.
Implementations are expected to show alpha by rendering the color over a non-uniform background (like a checkerboard pattern).
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gtk::ColorChooser::set_rgba | ( | const Gdk::RGBA & | color | ) |
void Gtk::ColorChooser::set_use_alpha | ( | bool |
use_alpha
=
true
|
) |
Sets whether or not the color chooser should use the alpha channel.
- Parameters
-
use_alpha true
if color chooser should use alpha channel,false
if not.
Glib::SignalProxy < void,const Gdk::RGBA & > Gtk::ColorChooser::signal_color_activated | ( | ) |
- Slot Prototype:
-
void on_my_color_activated(const Gdk::RGBA & color)
Emitted when a color is activated from the color chooser. This usually happens when the user clicks a color swatch, or a color is selected and the user presses one of the keys Space, Shift+Space, Return or Enter.
- Parameters
-
color The color.
Friends And Related Function Documentation
|
related |
A Glib::wrap() method for this object.
- Parameters
-
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.
- Returns
- A C++ instance that wraps this C instance.