GtkColorSelection

Name

GtkColorSelection -- a widget used to select a color.

Synopsis


#include <gtk/gtk.h>


struct      GtkColorSelection;
GtkWidget*  gtk_color_selection_new         (void);
void        gtk_color_selection_set_update_policy
                                            (GtkColorSelection *colorsel,
                                             GtkUpdateType policy);
void        gtk_color_selection_set_color   (GtkColorSelection *colorsel,
                                             gdouble *color);
void        gtk_color_selection_get_color   (GtkColorSelection *colorsel,
                                             gdouble *color);
gboolean    gtk_color_selection_is_adjusting
                                            (GtkColorSelection *colorsel);

Object Hierarchy


  GObject
   +----GtkObject
         +----GtkWidget
               +----GtkContainer
                     +----GtkBox
                           +----GtkVBox
                                 +----GtkColorSelection

Signal Prototypes


"color-changed"
            void        user_function      (GtkColorSelection *colorselection,
                                            gpointer user_data);

Description

The GtkColorSelection is a widget that is used to select a color. It consists of a color wheel and number of sliders and entry boxes for color parameters such as hue, saturation, value, red, green, blue, and opacity. It is found on the standard color selection dialog box GtkColorSelectionDialog.

Details

struct GtkColorSelection

struct GtkColorSelection;

The GtkColorSelection struct contains private data only, and should be accessed using the functions below.


gtk_color_selection_new ()

GtkWidget*  gtk_color_selection_new         (void);

Creates a new GtkColorSelection.

Create a new GtkColorSelection.

Returns : The new GtkColorSelection.


gtk_color_selection_set_update_policy ()

void        gtk_color_selection_set_update_policy
                                            (GtkColorSelection *colorsel,
                                             GtkUpdateType policy);

Sets the policy controlling when the color_changed signals are emitted. The available policies are:

colorsel :a GtkColorSelection.
policy :a GtkUpdateType value indicating the desired policy.


gtk_color_selection_set_color ()

void        gtk_color_selection_set_color   (GtkColorSelection *colorsel,
                                             gdouble *color);

Warning

gtk_color_selection_set_color is deprecated and should not be used in newly-written code.

Sets the current color to be color. The first time this is called, it will also set the original color to be color too.

This function is deprecated, use gtk_color_selection_set_current_color() instead.

Sets the color in the GtkColorSelection. The widgets are updated to reflect the new color.

colorsel : A GtkColorSelection.
color : A array of doubles that specifies the color to set the current color with.


gtk_color_selection_get_color ()

void        gtk_color_selection_get_color   (GtkColorSelection *colorsel,
                                             gdouble *color);

Warning

gtk_color_selection_get_color is deprecated and should not be used in newly-written code.

Sets color to be the current color in the GtkColorSelection widget.

Retrieve the currently selected color value.

colorsel : A GtkColorSelection.
color : A color to fill in with the current color.


gtk_color_selection_is_adjusting ()

gboolean    gtk_color_selection_is_adjusting
                                            (GtkColorSelection *colorsel);

Gets the current state of the colorsel.

colorsel : A GtkColorSelection.
Returns : TRUE if the user is currently dragging a color around, and FALSE if the selection has stopped.

Signals

The "color-changed" signal

void        user_function                  (GtkColorSelection *colorselection,
                                            gpointer user_data);

This signal is emitted when the color changes in the GtkColorSelection according to its update policy.

colorselection :the object which received the signal.
user_data :user data set when the signal handler was connected.