ColorButton

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

Constructors

this this(GtkColorButton* gtkColorButton): Sets our main struct and passes it to the parent class
this this(): Creates a new color button. 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. Since 2.4
this this(Color color): Warning gtk_color_button_new_with_color has been deprecated since version 3.4 and should not be used in newly-written code. Use gtk_color_button_new_with_rgba() instead. Creates a new color button. Since 2.4
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. Note that this signal is only emitted when the user changes the color. If you need to react to programmatic color changes as well, use the notify::color signal. Since 2.4 See Also GtkColorSelectionDialog, GtkFontButton
getAlpha ushort getAlpha(): Warning gtk_color_button_get_alpha has been deprecated since version 3.4 and should not be used in newly-written code. Use gtk_color_chooser_get_rgba() instead. Returns the current alpha value. Since 2.4
getColor void getColor(Color color): Warning gtk_color_button_get_color has been deprecated since version 3.4 and should not be used in newly-written code. Use gtk_color_chooser_get_rgba() instead. Sets color to be the current color in the GtkColorButton widget. Since 2.4
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. Since 2.4
setAlpha void setAlpha(ushort alpha): Warning gtk_color_button_set_alpha has been deprecated since version 3.4 and should not be used in newly-written code. Use gtk_color_chooser_set_rgba() instead. Sets the current opacity to be alpha. Since 2.4
setColor void setColor(Color color): Warning gtk_color_button_set_color is deprecated and should not be used in newly-written code. Use gtk_color_chooser_set_rgba() instead. Sets the current color to be color. Since 2.4
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. Since 2.4

Mixins

__anonymous mixin ColorChooserT!(GtkColorButton): Undocumented in source.

Static functions

callBackColorSet void callBackColorSet(GtkColorButton* widgetStruct, ColorButton _colorButton): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

connectedSignals int[string] connectedSignals;
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()
connectedSignals int[string] connectedSignals;
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 "clicked" signal.
callBackActivate void callBackActivate(GtkButton* widgetStruct, 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): Warning GtkButton::enter has been deprecated since version 2.8 and should not be used in newly-written code. Use the "enter-notify-event" signal. 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): Warning GtkButton::leave has been deprecated since version 2.8 and should not be used in newly-written code. Use the "leave-notify-event" signal. 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): Warning GtkButton::pressed has been deprecated since version 2.8 and should not be used in newly-written code. Use the "button-press-event" signal. 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): Warning GtkButton::released has been deprecated since version 2.8 and should not be used in newly-written code. Use the "button-release-event" signal. 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.
pressed void pressed(): Warning gtk_button_pressed has been deprecated since version 2.20 and should not be used in newly-written code. Use the "button-press-event" signal. Emits a "pressed" signal to the given GtkButton.
released void released(): Warning gtk_button_released has been deprecated since version 2.20 and should not be used in newly-written code. Use the "button-release-event" signal. Emits a "released" signal to the given GtkButton.
clicked void clicked(): Emits a "clicked" signal to the given GtkButton.
enter void enter(): Warning gtk_button_enter has been deprecated since version 2.20 and should not be used in newly-written code. Use the "enter-notify-event" signal. Emits a "enter" signal to the given GtkButton.
leave void leave(): Warning gtk_button_leave has been deprecated since version 2.20 and should not be used in newly-written code. Use the "leave-notify-event" signal. Emits a "leave" signal to the given GtkButton.
setRelief void setRelief(GtkReliefStyle newstyle): Sets the relief style of the edges of the given GtkButton widget. Three styles exist, GTK_RELIEF_NORMAL, GTK_RELIEF_HALF, GTK_RELIEF_NONE. The default style is, as one can guess, GTK_RELIEF_NORMAL.
getRelief GtkReliefStyle getRelief(): Returns the current relief style of the given GtkButton.
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.
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. This will also clear any previously set labels.
getUseStock int getUseStock(): Warning gtk_button_get_use_stock is deprecated and should not be used in newly-written code. 3.10 Returns whether the button label is a stock item.
setUseStock void setUseStock(int useStock): Warning gtk_button_set_use_stock is deprecated and should not be used in newly-written code. 3.10 If TRUE, the label set on the button is used as a stock id to select the stock item for the button.
getUseUnderline int getUseUnderline(): Returns whether an embedded underline in the button label indicates a mnemonic. See gtk_button_set_use_underline().
setUseUnderline void setUseUnderline(int useUnderline): If true, an underline in the text of the button label indicates the next character should be used for the mnemonic accelerator key.
setFocusOnClick void setFocusOnClick(int 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. Since 2.4
getFocusOnClick int getFocusOnClick(): Returns whether the button grabs focus when it is clicked with the mouse. See gtk_button_set_focus_on_click(). Since 2.4
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. Since 2.4
getAlignment void getAlignment(float xalign, float yalign): Gets the alignment of the child in the button. Since 2.4
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 "always-show-image" is TRUE. You don't have to call gtk_widget_show() on image yourself. Since 2.6
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(). Since 2.6
setImagePosition void setImagePosition(GtkPositionType position): Sets the position of the image relative to the text inside the button. Since 2.10
getImagePosition GtkPositionType getImagePosition(): Gets the position of the image relative to the text inside the button. Since 2.10
setAlwaysShowImage void setAlwaysShowImage(int alwaysShow): If TRUE, the button will always show the image in addition to the label, if available. Use this property if the button would be useless or hard to use without the image.
getAlwaysShowImage int getAlwaysShowImage(): Returns whether the button will always show the image in addition to the label, if available.
getEventWindow Window getEventWindow(): Returns the button's event window if it is realized, NULL otherwise. This function should be rarely needed. Since 2.22

From ColorChooserIF

getColorChooserTStruct GtkColorChooser* getColorChooserTStruct(): 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 colorsPerPine colors in each row. If horizontal is false, the colors are grouped in columns instead.
onColorActivatedListeners void delegate(RGBA, ColorChooserIF)[] onColorActivatedListeners [@property getter]
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. Since 3.4 See Also GtkColorChooserDialog, GtkColorChooserWidget, GtkColorButton
getRgba void getRgba(RGBA color): Gets the currently-selected color.
setRgba void setRgba(RGBA color): Sets the color.
getUseAlpha int getUseAlpha(): Returns whether the color chooser shows the alpha channel.
setUseAlpha void setUseAlpha(int useAlpha): Sets whether or not the color chooser should use the alpha channel.