Button

The #GtkButton widget is generally used to trigger a callback function that is called when the button is pressed. The various signals and how to use them are outlined below.

The #GtkButton widget can hold any valid child widget. That is, it can hold almost any other standard #GtkWidget. The most commonly used child is the #GtkLabel.

CSS nodes

GtkButton has a single CSS node with name button. The node will get the style classes .image-button or .text-button, if the content is just an image or label, respectively. It may also receive the .flat style class.

Other style classes that are commonly used with GtkButton include .suggested-action and .destructive-action. In special cases, buttons can be made round by adding the .circular style class.

Button-like widgets like #GtkToggleButton, #GtkMenuButton, #GtkVolumeButton, #GtkLockButton, #GtkColorButton, #GtkFontButton or #GtkFileChooserButton use style classes such as .toggle, .popup, .scale, .lock, .color, .font, .file to differentiate themselves from a plain GtkButton.

class Button : Bin , ActionableIF , ActivatableIF {

GtkButton* gtkButton;

GtkButton* getButtonStruct();

void* getStruct();

void setStruct(GObject* obj);

this(GtkButton* gtkButton, bool ownedRef);

mixin ActionableT!(GtkButton) ;

mixin ActivatableT!(GtkButton) ;

static void setIconSize(IconSize iconSize);

static IconSize getIconSize();

this(string label, bool mnemonic);

this(StockID stockID, bool hideLabel);

this(StockID stockID, void delegate(Button) dlg, bool hideLabel);

this(string label, void delegate(Button) dlg, bool mnemonic);

this(string label, void delegate(Button) dlg, string action);

static GType getType();

this(string iconName, GtkIconSize size);

void clicked();

void enter();

void getAlignment(float xalign, float yalign);

bool getAlwaysShowImage();

Window getEventWindow();

bool getFocusOnClick();

Widget getImage();

GtkPositionType getImagePosition();

string getLabel();

GtkReliefStyle getRelief();

bool getUseStock();

bool getUseUnderline();

void leave();

void pressed();

void released();

void setAlignment(float xalign, float yalign);

void setAlwaysShowImage(bool alwaysShow);

void setFocusOnClick(bool focusOnClick);

void setImage(Widget image);

void setImagePosition(GtkPositionType position);

void setLabel(string label);

void setRelief(GtkReliefStyle relief);

void setUseStock(bool useStock);

void setUseUnderline(bool useUnderline);

int[string] connectedSignals;

void delegate(Button)[] onActivateListeners;

void addOnActivate(void delegate(Button) dlg, ConnectFlags connectFlags);

static void callBackActivate(GtkButton* buttonStruct, Button _button);

void delegate(Button)[] onClickedListeners;

void addOnClicked(void delegate(Button) dlg, ConnectFlags connectFlags);

static void callBackClicked(GtkButton* buttonStruct, Button _button);

void delegate(Button)[] onEnterListeners;

void addOnEnter(void delegate(Button) dlg, ConnectFlags connectFlags);

static void callBackEnter(GtkButton* buttonStruct, Button _button);

void delegate(Button)[] onLeaveListeners;

void addOnLeave(void delegate(Button) dlg, ConnectFlags connectFlags);

static void callBackLeave(GtkButton* buttonStruct, Button _button);

void delegate(Button)[] onPressedListeners;

void addOnPressed(void delegate(Button) dlg, ConnectFlags connectFlags);

static void callBackPressed(GtkButton* buttonStruct, Button _button);

void delegate(Button)[] onReleasedListeners;

void addOnReleased(void delegate(Button) dlg, ConnectFlags connectFlags);

static void callBackReleased(GtkButton* buttonStruct, Button _button);

}

Constructors

this this(GtkButton* gtkButton, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(string label, bool mnemonic): Creates a new GtkButton containing a label. If characters in label are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, use '__' (two underscores). The first underlined character represents a keyboard accelerator called a mnemonic. Pressing Alt and that key activates the button.
this this(StockID stockID, bool hideLabel): Creates a new GtkButton containing the image and text from a stock item. Some stock ids have preprocessor macros like GTK_STOCK_OK and GTK_STOCK_APPLY. If stock_id is unknown, then it will be treated as a mnemonic label (as for gtk_button_new_with_mnemonic()).
this this(StockID stockID, void delegate(Button) dlg, bool hideLabel)
this this(string label, void delegate(Button) dlg, bool mnemonic)
this this(string label, void delegate(Button) dlg, string action)
this this(): Creates a new #GtkButton widget. To add a child widget to the button, use gtk_container_add().
this this(string iconName, GtkIconSize size): Creates a new button containing an icon from the current icon theme.

Members

Functions

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.
addOnClicked void addOnClicked(void delegate(Button) dlg, ConnectFlags connectFlags): Emitted when the button has been activated (pressed and released).
addOnEnter void addOnEnter(void delegate(Button) dlg, ConnectFlags connectFlags): Emitted when the pointer enters the button.
addOnLeave void addOnLeave(void delegate(Button) dlg, ConnectFlags connectFlags): Emitted when the pointer leaves the button.
addOnPressed void addOnPressed(void delegate(Button) dlg, ConnectFlags connectFlags): Emitted when the button is pressed.
addOnReleased void addOnReleased(void delegate(Button) dlg, ConnectFlags connectFlags): Emitted when the button is released.
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.
getButtonStruct GtkButton* getButtonStruct(): Get the main Gtk struct
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.
getStruct void* getStruct(): the main Gtk struct as a void*
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.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
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.

Mixins

__anonymous mixin ActionableT!(GtkButton): Undocumented in source.
__anonymous mixin ActivatableT!(GtkButton): Undocumented in source.

Static functions

callBackActivate void callBackActivate(GtkButton* buttonStruct, Button _button): Undocumented in source. Be warned that the author may not have intended to support it.
callBackClicked void callBackClicked(GtkButton* buttonStruct, Button _button): Undocumented in source. Be warned that the author may not have intended to support it.
callBackEnter void callBackEnter(GtkButton* buttonStruct, Button _button): Undocumented in source. Be warned that the author may not have intended to support it.
callBackLeave void callBackLeave(GtkButton* buttonStruct, Button _button): Undocumented in source. Be warned that the author may not have intended to support it.
callBackPressed void callBackPressed(GtkButton* buttonStruct, Button _button): Undocumented in source. Be warned that the author may not have intended to support it.
callBackReleased void callBackReleased(GtkButton* buttonStruct, Button _button): Undocumented in source. Be warned that the author may not have intended to support it.
getIconSize IconSize getIconSize()
getType GType getType()
setIconSize void setIconSize(IconSize iconSize)

Variables

connectedSignals int[string] connectedSignals;: Undocumented in source.
gtkButton GtkButton* gtkButton;: the main Gtk struct
onActivateListeners void delegate(Button)[] onActivateListeners;: Undocumented in source.
onClickedListeners void delegate(Button)[] onClickedListeners;: Undocumented in source.
onEnterListeners void delegate(Button)[] onEnterListeners;: Undocumented in source.
onLeaveListeners void delegate(Button)[] onLeaveListeners;: Undocumented in source.
onPressedListeners void delegate(Button)[] onPressedListeners;: Undocumented in source.
onReleasedListeners void delegate(Button)[] onReleasedListeners;: Undocumented in source.

Inherited Members

From Bin

gtkBin GtkBin* gtkBin;: the main Gtk struct
getBinStruct GtkBin* getBinStruct(): 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.
getType GType getType()
getChild Widget getChild(): Gets the child of the #GtkBin, or %NULL if the bin contains no child widget. The returned widget does not have a reference added, so you do not need to unref it.

From ActionableIF

getActionableStruct GtkActionable* getActionableStruct(): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getActionName string getActionName(): Gets the action name for @actionable.
getActionTargetValue Variant getActionTargetValue(): Gets the current target value of @actionable.
setActionName void setActionName(string actionName): Specifies the name of the action with which this widget should be associated. If @action_name is %NULL then the widget will be unassociated from any previous action.
setActionTargetValue void setActionTargetValue(Variant targetValue): Sets the target value of an actionable widget.
setDetailedActionName void setDetailedActionName(string detailedActionName): Sets the action-name and associated string target value of an actionable widget.

From ActivatableIF

getActivatableStruct GtkActivatable* getActivatableStruct(): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
doSetRelatedAction void doSetRelatedAction(Action action): This is a utility function for #GtkActivatable implementors.
getRelatedAction Action getRelatedAction(): Gets the related #GtkAction for @activatable.
getUseActionAppearance bool getUseActionAppearance(): Gets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance.
setRelatedAction void setRelatedAction(Action action): Sets the related action on the @activatable object.
setUseActionAppearance void setUseActionAppearance(bool useAppearance): Sets whether this activatable should reset its layout and appearance when setting the related action or when the action changes appearance
syncActionProperties void syncActionProperties(Action action): This is called to update the activatable completely, this is called internally when the #GtkActivatable:related-action property is set or unset and by the implementing class when #GtkActivatable:use-action-appearance changes.

Meta

Source

See Implementation

gtk Button classes

Button