## go-combo-color

go-combo-color

## Synopsis

    #define             GO_COMBO_COLOR_TYPE
    #define             GO_COMBO_COLOR                      (o)
    #define             IS_GO_COMBO_COLOR                   (o)
    #define             GO_COMBO_COLOR_CLASS                (k)
                        GOComboColor;
    GType               go_combo_color_get_type             (void);
    GtkWidget*          go_combo_color_new                  (GdkPixbuf *icon,
                                                             char const *no_color_label,
                                                             GOColor default_color,
                                                             GOColorGroup *color_group);
    GOColor             go_combo_color_get_color            (GOComboColor *cc,
                                                             gboolean *is_default);
    void                go_combo_color_set_color            (GOComboColor *cc,
                                                             GOColor color);
    void                go_combo_color_set_color_to_default (GOComboColor *cc);
    void                go_combo_color_set_color_gdk        (GOComboColor *cc,
                                                             GdkColor *color);
    void                go_combo_color_set_allow_alpha      (GOComboColor *cc,
                                                             gboolean allow_alpha);
    void                go_combo_color_set_instant_apply    (GOComboColor *cc,
                                                             gboolean active);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GtkObject
                   +----GtkWidget
                         +----GtkContainer
                               +----GtkBox
                                     +----GtkHBox
                                           +----GOComboBox
                                                 +----GOComboColor

## Implemented Interfaces

GOComboColor implements AtkImplementorIface, GtkBuildable and GtkOrientable.

## Signals

      "color-changed"                                  : Run Last
      "display-custom-dialog"                          : Run Last

## Description

## Details

### GO_COMBO_COLOR_TYPE

    #define GO_COMBO_COLOR_TYPE	(go_combo_color_get_type ())

### GO_COMBO_COLOR()

    #define GO_COMBO_COLOR(o)	(G_TYPE_CHECK_INSTANCE_CAST((o), GO_COMBO_COLOR_TYPE, GOComboColor))

`o` : |

### IS_GO_COMBO_COLOR()

    #define IS_GO_COMBO_COLOR(o)	(G_TYPE_CHECK_INSTANCE_TYPE((o), GO_COMBO_COLOR_TYPE))

`o` : |

### GO_COMBO_COLOR_CLASS()

    #define GO_COMBO_COLOR_CLASS(k)	(G_TYPE_CHECK_CLASS_CAST(k), GO_COMBO_COLOR_TYPE)

`k` : |

### GOComboColor

    typedef struct _GOComboColor GOComboColor;

### go_combo_color_get_type ()

    GType               go_combo_color_get_type             (void);

Returns : |

### go_combo_color_new ()

    GtkWidget*          go_combo_color_new                  (GdkPixbuf *icon,
                                                             char const *no_color_label,
                                                             GOColor default_color,
                                                             GOColorGroup *color_group);

Default constructor. Pass an optional icon and an optional label for the no/auto color button.

`icon` : | optionally NULL.
`no_color_label` : | FIXME
`default_color` : |
`color_group` : |
Returns : |

### go_combo_color_get_color ()

    GOColor             go_combo_color_get_color            (GOComboColor *cc,
                                                             gboolean *is_default);

`cc` : |
`is_default` : |
Returns : |

### go_combo_color_set_color ()

    void                go_combo_color_set_color            (GOComboColor *cc,
                                                             GOColor color);

`cc` : | a GOComboColor
`color` : | a GOColor

### go_combo_color_set_color_to_default ()

    void                go_combo_color_set_color_to_default (GOComboColor *cc);

Set the color of the combo to the default color. Causes the color_changed signal to be emitted.

`cc` : | The combo

### go_combo_color_set_color_gdk ()

    void                go_combo_color_set_color_gdk        (GOComboColor *cc,
                                                             GdkColor *color);

Set the color of the combo to the given color. Causes the color_changed signal to be emitted.

`cc` : | The combo
`color` : | The color

### go_combo_color_set_allow_alpha ()

    void                go_combo_color_set_allow_alpha      (GOComboColor *cc,
                                                             gboolean allow_alpha);

Should the custom colour selector allow the use of opacity.

`cc` : | GOComboColor
`allow_alpha` : |

### go_combo_color_set_instant_apply ()

    void                go_combo_color_set_instant_apply    (GOComboColor *cc,
                                                             gboolean active);

Turn instant apply behaviour on or off. Instant apply means that pressing the button applies the current color. When off, pressing the button opens the combo.

`cc` : | The combo
`active` : | Whether instant apply should be active or not

## Signal Details

### The `"color-changed"` signal

    void                user_function                      (GOComboColor *gocombocolor,
                                                            gpointer      arg1,
                                                            gboolean      arg2,
                                                            gboolean      arg3,
                                                            gboolean      arg4,
                                                            gpointer      user_data)         : Run Last

`gocombocolor` : | the object which received the signal.
`arg1` : |
`arg2` : |
`arg3` : |
`arg4` : |
`user_data` : | user data set when the signal handler was connected.

### The `"display-custom-dialog"` signal

    void                user_function                      (GOComboColor *gocombocolor,
                                                            GObject      *arg1,
                                                            gpointer      user_data)         : Run Last

`gocombocolor` : | the object which received the signal.
`arg1` : |
`user_data` : | user data set when the signal handler was connected.