Gtk::ColorChooser Class Reference

This interface can be implemented by widgets which allow the user to choose a color. More...

`#include <gtkmm/colorchooser.h>`

Inheritance diagram for Gtk::ColorChooser:
[legend]

## Public Member Functions

| ColorChooser (ColorChooser &&src) noexcept
ColorChooser & | operator= (ColorChooser &&src) noexcept
| ~ColorChooser () noexcept override
GtkColorChooser * | gobj ()
| Provides access to the underlying C GObject.
const GtkColorChooser * | gobj () const
| Provides access to the underlying C GObject.
Gdk::RGBA | get_rgba () const
| Gets the currently selected color.
void | set_rgba (const Gdk::RGBA &color)
| Sets the color.
bool | get_use_alpha () const
| Returns whether the color chooser shows the alpha channel.
void | set_use_alpha (bool use_alpha=true)
| Sets whether or not the color chooser should use the alpha channel.
void | add_palette (Orientation orientation, int colors_per_line, const std::vector< Gdk::RGBA > &colors)
| Adds a palette to the color chooser.
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.
Glib::PropertyProxy_ReadOnly< Gdk::RGBA > | property_rgba () const
| The property_rgba() property contains the currently selected color, as a Gdk::RGBA struct.
Glib::PropertyProxy< bool > | property_use_alpha ()
| When signal_use_alpha() is `true`, colors may have alpha (translucency) information.
Glib::PropertyProxy_ReadOnly< bool > | property_use_alpha () const
| When signal_use_alpha() is `true`, colors may have alpha (translucency) information.

## 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.

## Protected Member Functions

| ColorChooser ()
| You should derive from this class to use it.
virtual void | on_color_activated (const Gdk::RGBA &color)
| This is a default handler for the signal signal_color_activated().

## Related Symbols

(Note that these are not member symbols.)
Glib::RefPtr< Gtk::ColorChooser > | wrap (GtkColorChooser *object, bool take_copy=false)
| A Glib::wrap() method for this object.

## 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.

Since gtkmm 3.4:

## Constructor & Destructor Documentation

## ColorChooser() [1/2]

Gtk::ColorChooser::ColorChooser | ( |  | ) |

protected

You should derive from this class to use it.

## ColorChooser() [2/2]

Gtk::ColorChooser::ColorChooser | ( | ColorChooser && | src | ) |

noexcept

## ~ColorChooser()

Gtk::ColorChooser::~ColorChooser | ( |  | ) |

override noexcept

## Member Function Documentation

## add_interface()

static void Gtk::ColorChooser::add_interface | ( | GType | gtype_implementer | ) |

static

## add_palette()

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.

Since gtkmm 3.4:

## get_rgba()

Gdk::RGBA Gtk::ColorChooser::get_rgba | ( |  | ) | const

Gets the currently selected color.

Returns
  The currently selected color.

Since gtkmm 3.4:

## get_type()

static GType Gtk::ColorChooser::get_type | ( |  | ) |

static

Get the GType for this class, for use with the underlying GObject type system.

## get_use_alpha()

bool Gtk::ColorChooser::get_use_alpha | ( |  | ) | const

Returns whether the color chooser shows the alpha channel.

Since gtkmm 3.4:

Returns
  `true` if the color chooser uses the alpha channel, `false` if not.

## gobj() [1/2]

GtkColorChooser * Gtk::ColorChooser::gobj | ( |  | ) |

inline

Provides access to the underlying C GObject.

## gobj() [2/2]

const GtkColorChooser * Gtk::ColorChooser::gobj | ( |  | ) | const

inline

Provides access to the underlying C GObject.

## on_color_activated()

virtual void Gtk::ColorChooser::on_color_activated | ( | const Gdk::RGBA & | color | ) |

protected virtual

This is a default handler for the signal signal_color_activated().

## operator=()

ColorChooser & Gtk::ColorChooser::operator= | ( | ColorChooser && | src | ) |

noexcept

## property_rgba() [1/2]

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.

Since gtkmm 3.4:

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.

## property_rgba() [2/2]

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.

Since gtkmm 3.4:

Returns
  A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

## property_use_alpha() [1/2]

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).

Since gtkmm 3.4:

Default value: `true`

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.

## property_use_alpha() [2/2]

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).

Since gtkmm 3.4:

Default value: `true`

Returns
  A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

## set_rgba()

void Gtk::ColorChooser::set_rgba | ( | const Gdk::RGBA & | color | ) |

Sets the color.

Since gtkmm 3.4:

Parameters

  color | The new color.

## set_use_alpha()

void Gtk::ColorChooser::set_use_alpha | ( | bool | use_alpha = `true` | ) |

Sets whether or not the color chooser should use the alpha channel.

Since gtkmm 3.4:

Parameters

  use_alpha | `true` if color chooser should use alpha channel, `false` if not.

## signal_color_activated()

Glib::SignalProxy< void, const Gdk::RGBA & > Gtk::ColorChooser::signal_color_activated | ( |  | ) |

Slot Prototype:
  `void on_my_color_activated(const Gdk::RGBA& color)`

Flags: Run First

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.

Since gtkmm 3.4:

Parameters

  color | The color.

## Friends And Related Symbol Documentation

## wrap()

Glib::RefPtr< Gtk::ColorChooser > wrap | ( | GtkColorChooser * | object,
|  | bool | take_copy = `false`
| ) |  |

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.