This interface can be implemented by widgets which allow the user to choose a color.
More...
#include <gtkmm/colorchooser.h>
|
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...
|
|
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:
Gtk::ColorChooser::ColorChooser |
( |
| ) |
|
|
protected |
You should derive from this class to use it.
Gtk::ColorChooser::~ColorChooser |
( |
| ) |
|
|
overridenoexcept |
static void Gtk::ColorChooser::add_interface |
( |
GType |
gtype_implementer | ) |
|
|
static |
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
-
- Since gtkmm 3.4:
Gdk::RGBA Gtk::ColorChooser::get_rgba |
( |
| ) |
const |
Gets the currently selected color.
- Returns
- The currently selected color.
- Since gtkmm 3.4:
static GType Gtk::ColorChooser::get_type |
( |
| ) |
|
|
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.
GtkColorChooser* Gtk::ColorChooser::gobj |
( |
| ) |
|
|
inline |
Provides access to the underlying C GObject.
const GtkColorChooser* Gtk::ColorChooser::gobj |
( |
| ) |
const |
|
inline |
Provides access to the underlying C GObject.
virtual void Gtk::ColorChooser::on_color_activated |
( |
const Gdk::RGBA& |
color | ) |
|
|
protectedvirtual |
Glib::PropertyProxy< Gdk::RGBA > Gtk::ColorChooser::property_rgba |
( |
| ) |
|
The currently selected color, as a GdkRGBA
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 currently selected color, as a GdkRGBA
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 |
( |
| ) |
|
Whether colors may have alpha (translucency).
When signal_use_alpha() is false
, the GdkRGBA
struct obtained via the 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).
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.
Glib::PropertyProxy_ReadOnly< bool > Gtk::ColorChooser::property_use_alpha |
( |
| ) |
const |
Whether colors may have alpha (translucency).
When signal_use_alpha() is false
, the GdkRGBA
struct obtained via the 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).
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.
void Gtk::ColorChooser::set_rgba |
( |
const Gdk::RGBA& |
color | ) |
|
Sets the color.
- Parameters
-
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)
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.
- Parameters
-
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.