GnomeColorPicker

Name

GnomeColorPicker -- 

Synopsis



struct      GnomeColorPickerPrivate;
GtkWidget*  gnome_color_picker_new          (void);
void        gnome_color_picker_set_d        (GnomeColorPicker *cp,
                                             gdouble r,
                                             gdouble g,
                                             gdouble b,
                                             gdouble a);
void        gnome_color_picker_get_d        (GnomeColorPicker *cp,
                                             gdouble *r,
                                             gdouble *g,
                                             gdouble *b,
                                             gdouble *a);
void        gnome_color_picker_set_i8       (GnomeColorPicker *cp,
                                             guint8 r,
                                             guint8 g,
                                             guint8 b,
                                             guint8 a);
void        gnome_color_picker_get_i8       (GnomeColorPicker *cp,
                                             guint8 *r,
                                             guint8 *g,
                                             guint8 *b,
                                             guint8 *a);
void        gnome_color_picker_set_i16      (GnomeColorPicker *cp,
                                             gushort r,
                                             gushort g,
                                             gushort b,
                                             gushort a);
void        gnome_color_picker_get_i16      (GnomeColorPicker *cp,
                                             gushort *r,
                                             gushort *g,
                                             gushort *b,
                                             gushort *a);
void        gnome_color_picker_set_dither   (GnomeColorPicker *cp,
                                             gboolean dither);
gboolean    gnome_color_picker_get_dither   (GnomeColorPicker *cp);
void        gnome_color_picker_set_use_alpha
                                            (GnomeColorPicker *cp,
                                             gboolean use_alpha);
gboolean    gnome_color_picker_get_use_alpha
                                            (GnomeColorPicker *cp);
void        gnome_color_picker_set_title    (GnomeColorPicker *cp,
                                             const gchar *title);
const char* gnome_color_picker_get_title    (GnomeColorPicker *cp);

Description

Details

struct GnomeColorPickerPrivate

struct GnomeColorPickerPrivate;


gnome_color_picker_new ()

GtkWidget*  gnome_color_picker_new          (void);

Creates a new GNOME color picker widget. This returns a widget in the form of a small button containing a swatch representing the current selected color. When the button is clicked, a color-selection dialog will open, allowing the user to select a color. The swatch will be updated to reflect the new color when the user finishes.

Returns :Pointer to new GNOME color picker widget.


gnome_color_picker_set_d ()

void        gnome_color_picker_set_d        (GnomeColorPicker *cp,
                                             gdouble r,
                                             gdouble g,
                                             gdouble b,
                                             gdouble a);

Set color shown in the color picker widget using floating point values.

cp : Pointer to GNOME color picker widget.
r : Red color component, values are in [0.0, 1.0]
g : Green color component, values are in [0.0, 1.0]
b : Blue color component, values are in [0.0, 1.0]
a : Alpha component, values are in [0.0, 1.0]


gnome_color_picker_get_d ()

void        gnome_color_picker_get_d        (GnomeColorPicker *cp,
                                             gdouble *r,
                                             gdouble *g,
                                             gdouble *b,
                                             gdouble *a);

Retrieve color currently selected in the color picker widget in the form of floating point values.

cp : Pointer to GNOME color picker widget.
r : Output location of red color component, values are in [0.0, 1.0]
g : Output location of green color component, values are in [0.0, 1.0]
b : Output location of blue color component, values are in [0.0, 1.0]
a : Output location of alpha color component, values are in [0.0, 1.0]


gnome_color_picker_set_i8 ()

void        gnome_color_picker_set_i8       (GnomeColorPicker *cp,
                                             guint8 r,
                                             guint8 g,
                                             guint8 b,
                                             guint8 a);

Set color shown in the color picker widget using 8-bit integer values.

cp : Pointer to GNOME color picker widget.
r : Red color component, values are in [0, 255]
g : Green color component, values are in [0, 255]
b : Blue color component, values are in [0, 255]
a : Alpha component, values are in [0, 255]


gnome_color_picker_get_i8 ()

void        gnome_color_picker_get_i8       (GnomeColorPicker *cp,
                                             guint8 *r,
                                             guint8 *g,
                                             guint8 *b,
                                             guint8 *a);

Retrieve color currently selected in the color picker widget in the form of 8-bit integer values.

cp : Pointer to GNOME color picker widget.
r : Output location of red color component, values are in [0, 255]
g : Output location of green color component, values are in [0, 255]
b : Output location of blue color component, values are in [0, 255]
a : Output location of alpha color component, values are in [0, 255]


gnome_color_picker_set_i16 ()

void        gnome_color_picker_set_i16      (GnomeColorPicker *cp,
                                             gushort r,
                                             gushort g,
                                             gushort b,
                                             gushort a);

Set color shown in the color picker widget using 16-bit integer values.

cp : Pointer to GNOME color picker widget.
r : Red color component, values are in [0, 65535]
g : Green color component, values are in [0, 65535]
b : Blue color component, values are in [0, 65535]
a : Alpha component, values are in [0, 65535]


gnome_color_picker_get_i16 ()

void        gnome_color_picker_get_i16      (GnomeColorPicker *cp,
                                             gushort *r,
                                             gushort *g,
                                             gushort *b,
                                             gushort *a);

Retrieve color currently selected in the color picker widget in the form of 16-bit integer values.

cp : Pointer to GNOME color picker widget.
r : Output location of red color component, values are in [0, 65535]
g : Output location of green color component, values are in [0, 65535]
b : Output location of blue color component, values are in [0, 65535]
a : Output location of alpha color component, values are in [0, 65535]


gnome_color_picker_set_dither ()

void        gnome_color_picker_set_dither   (GnomeColorPicker *cp,
                                             gboolean dither);

Sets whether the picker should dither the color sample or just paint a solid rectangle.

cp : Pointer to GNOME color picker widget.
dither : TRUE if color sample should be dithered, FALSE if not.


gnome_color_picker_get_dither ()

gboolean    gnome_color_picker_get_dither   (GnomeColorPicker *cp);

Does the picker dither the color sample or just paint a solid rectangle.

cp : Pointer to GNOME color picker widget.
Returns : TRUE if color sample is dithered, FALSE if not.


gnome_color_picker_set_use_alpha ()

void        gnome_color_picker_set_use_alpha
                                            (GnomeColorPicker *cp,
                                             gboolean use_alpha);

Sets whether or not the picker should use the alpha channel.

cp : Pointer to GNOME color picker widget.
use_alpha : TRUE if color sample should use alpha channel, FALSE if not.


gnome_color_picker_get_use_alpha ()

gboolean    gnome_color_picker_get_use_alpha
                                            (GnomeColorPicker *cp);

Does the picker use the alpha channel?

cp : Pointer to GNOME color picker widget.
Returns : TRUE if color sample uses alpha channel, FALSE if not.


gnome_color_picker_set_title ()

void        gnome_color_picker_set_title    (GnomeColorPicker *cp,
                                             const gchar *title);

Sets the title for the color selection dialog.

cp : Pointer to GNOME color picker widget.
title : String containing new window title.


gnome_color_picker_get_title ()

const char* gnome_color_picker_get_title    (GnomeColorPicker *cp);

Gets the title of the color selection dialog.

cp : Pointer to GNOME color picker widget.
Returns : An internal string, do not free the return value