ColorButton

The #GtkColorButton is a button which displays the currently selected color and allows to open a color selection dialog to change the color. It is suitable widget for selecting a color in a preference dialog.

CSS nodes

GtkColorButton has a single CSS node with name button. To differentiate it from a plain #GtkButton, it gets the .color style class.

Constructors

this
this(GtkColorButton* gtkColorButton, bool ownedRef)

Sets our main struct and passes it to the parent class.

this
this()

Creates a new color button.

this
this(Color color)

Creates a new color button.

this
this(RGBA rgba)

Creates a new color button.

Members

Functions

addOnColorSet
void addOnColorSet(void delegate(ColorButton) dlg, ConnectFlags connectFlags)

The ::color-set signal is emitted when the user selects a color. When handling this signal, use gtk_color_button_get_rgba() to find out which color was just selected.

getAlpha
ushort getAlpha()

Returns the current alpha value.

getColor
void getColor(Color color)

Sets @color to be the current color in the #GtkColorButton widget.

getColorButtonStruct
GtkColorButton* getColorButtonStruct()

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getTitle
string getTitle()

Gets the title of the color selection dialog.

setAlpha
void setAlpha(ushort alpha)

Sets the current opacity to be @alpha.

setColor
void setColor(Color color)

Sets the current color to be @color.

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setTitle
void setTitle(string title)

Sets the title for the color selection dialog.

Mixins

__anonymous
mixin ColorChooserT!(GtkColorButton)
Undocumented in source.

Static functions

callBackColorSet
void callBackColorSet(GtkColorButton* colorbuttonStruct, ColorButton _colorbutton)
Undocumented in source. Be warned that the author may not have intended to support it.
getType
GType getType()

Variables

connectedSignals
int[string] connectedSignals;
Undocumented in source.
gtkColorButton
GtkColorButton* gtkColorButton;

the main Gtk struct

onColorSetListeners
void delegate(ColorButton)[] onColorSetListeners;
Undocumented in source.

Inherited Members

From Button

gtkButton
GtkButton* gtkButton;

the main Gtk struct

getButtonStruct
GtkButton* getButtonStruct()

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
__anonymous
mixin ActionableT!(GtkButton)
Undocumented in source.
__anonymous
mixin ActivatableT!(GtkButton)
Undocumented in source.
setIconSize
void setIconSize(IconSize iconSize)
getIconSize
IconSize getIconSize()
getType
GType getType()
clicked
void clicked()

Emits a #GtkButton::clicked signal to the given #GtkButton.

enter
void enter()

Emits a #GtkButton::enter signal to the given #GtkButton.

getAlignment
void getAlignment(float xalign, float yalign)

Gets the alignment of the child in the button.

getAlwaysShowImage
bool getAlwaysShowImage()

Returns whether the button will ignore the #GtkSettings:gtk-button-images setting and always show the image, if available.

getEventWindow
Window getEventWindow()

Returns the button’s event window if it is realized, %NULL otherwise. This function should be rarely needed.

getFocusOnClick
bool getFocusOnClick()

Returns whether the button grabs focus when it is clicked with the mouse. See gtk_button_set_focus_on_click().

getImage
Widget getImage()

Gets the widget that is currenty set as the image of @button. This may have been explicitly set by gtk_button_set_image() or constructed by gtk_button_new_from_stock().

getImagePosition
GtkPositionType getImagePosition()

Gets the position of the image relative to the text inside the button.

getLabel
string getLabel()

Fetches the text from the label of the button, as set by gtk_button_set_label(). If the label text has not been set the return value will be %NULL. This will be the case if you create an empty button with gtk_button_new() to use as a container.

getRelief
GtkReliefStyle getRelief()

Returns the current relief style of the given #GtkButton.

getUseStock
bool getUseStock()

Returns whether the button label is a stock item.

getUseUnderline
bool getUseUnderline()

Returns whether an embedded underline in the button label indicates a mnemonic. See gtk_button_set_use_underline ().

leave
void leave()

Emits a #GtkButton::leave signal to the given #GtkButton.

pressed
void pressed()

Emits a #GtkButton::pressed signal to the given #GtkButton.

released
void released()

Emits a #GtkButton::released signal to the given #GtkButton.

setAlignment
void setAlignment(float xalign, float yalign)

Sets the alignment of the child. This property has no effect unless the child is a #GtkMisc or a #GtkAlignment.

setAlwaysShowImage
void setAlwaysShowImage(bool alwaysShow)

If %TRUE, the button will ignore the #GtkSettings:gtk-button-images setting and always show the image, if available.

setFocusOnClick
void setFocusOnClick(bool focusOnClick)

Sets whether the button will grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don’t want the keyboard focus removed from the main area of the application.

setImage
void setImage(Widget image)

Set the image of @button to the given widget. The image will be displayed if the label text is %NULL or if #GtkButton:always-show-image is %TRUE. You don’t have to call gtk_widget_show() on @image yourself.

setImagePosition
void setImagePosition(GtkPositionType position)

Sets the position of the image relative to the text inside the button.

setLabel
void setLabel(string label)

Sets the text of the label of the button to @str. This text is also used to select the stock item if gtk_button_set_use_stock() is used.

setRelief
void setRelief(GtkReliefStyle relief)

Sets the relief style of the edges of the given #GtkButton widget. Two styles exist, %GTK_RELIEF_NORMAL and %GTK_RELIEF_NONE. The default style is, as one can guess, %GTK_RELIEF_NORMAL. The deprecated value %GTK_RELIEF_HALF behaves the same as %GTK_RELIEF_NORMAL.

setUseStock
void setUseStock(bool useStock)

If %TRUE, the label set on the button is used as a stock id to select the stock item for the button.

setUseUnderline
void setUseUnderline(bool useUnderline)

If true, an underline in the text of the button label indicates the next character should be used for the mnemonic accelerator key.

connectedSignals
int[string] connectedSignals;
Undocumented in source.
onActivateListeners
void delegate(Button)[] onActivateListeners;
Undocumented in source.
addOnActivate
void addOnActivate(void delegate(Button) dlg, ConnectFlags connectFlags)

The ::activate signal on GtkButton is an action signal and emitting it causes the button to animate press then release. Applications should never connect to this signal, but use the #GtkButton::clicked signal.

callBackActivate
void callBackActivate(GtkButton* buttonStruct, Button _button)
Undocumented in source. Be warned that the author may not have intended to support it.
onClickedListeners
void delegate(Button)[] onClickedListeners;
Undocumented in source.
addOnClicked
void addOnClicked(void delegate(Button) dlg, ConnectFlags connectFlags)

Emitted when the button has been activated (pressed and released).

callBackClicked
void callBackClicked(GtkButton* buttonStruct, Button _button)
Undocumented in source. Be warned that the author may not have intended to support it.
onEnterListeners
void delegate(Button)[] onEnterListeners;
Undocumented in source.
addOnEnter
void addOnEnter(void delegate(Button) dlg, ConnectFlags connectFlags)

Emitted when the pointer enters the button.

callBackEnter
void callBackEnter(GtkButton* buttonStruct, Button _button)
Undocumented in source. Be warned that the author may not have intended to support it.
onLeaveListeners
void delegate(Button)[] onLeaveListeners;
Undocumented in source.
addOnLeave
void addOnLeave(void delegate(Button) dlg, ConnectFlags connectFlags)

Emitted when the pointer leaves the button.

callBackLeave
void callBackLeave(GtkButton* buttonStruct, Button _button)
Undocumented in source. Be warned that the author may not have intended to support it.
onPressedListeners
void delegate(Button)[] onPressedListeners;
Undocumented in source.
addOnPressed
void addOnPressed(void delegate(Button) dlg, ConnectFlags connectFlags)

Emitted when the button is pressed.

callBackPressed
void callBackPressed(GtkButton* buttonStruct, Button _button)
Undocumented in source. Be warned that the author may not have intended to support it.
onReleasedListeners
void delegate(Button)[] onReleasedListeners;
Undocumented in source.
addOnReleased
void addOnReleased(void delegate(Button) dlg, ConnectFlags connectFlags)

Emitted when the button is released.

callBackReleased
void callBackReleased(GtkButton* buttonStruct, Button _button)
Undocumented in source. Be warned that the author may not have intended to support it.

From ColorChooserIF

getColorChooserStruct
GtkColorChooser* getColorChooserStruct()

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

addPalette
void addPalette(GtkOrientation orientation, int colorsPerLine, 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 @horizontal is %FALSE, the colors are grouped in columns instead.

getRgba
void getRgba(RGBA color)

Gets the currently-selected color.

getUseAlpha
bool getUseAlpha()

Returns whether the color chooser shows the alpha channel.

setRgba
void setRgba(RGBA color)

Sets the color.

setUseAlpha
void setUseAlpha(bool useAlpha)

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

onColorActivatedListeners
void delegate(RGBA, ColorChooserIF)[] onColorActivatedListeners [@property getter]
Undocumented in source.
addOnColorActivated
void addOnColorActivated(void delegate(RGBA, ColorChooserIF) dlg, ConnectFlags connectFlags)

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.

Meta