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 , Actionable , Activatable {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

Button self();

static ButtonGidBuilder builder();

bool alwaysShowImage [@property getter];

bool alwaysShowImage [@property setter];

gtk.widget.Widget image [@property getter];

gtk.widget.Widget image [@property setter];

gtk.types.PositionType imagePosition [@property getter];

gtk.types.PositionType imagePosition [@property setter];

string label [@property getter];

string label [@property setter];

gtk.types.ReliefStyle relief [@property getter];

gtk.types.ReliefStyle relief [@property setter];

bool useStock [@property getter];

bool useStock [@property setter];

bool useUnderline [@property getter];

bool useUnderline [@property setter];

float xalign [@property getter];

float xalign [@property setter];

float yalign [@property getter];

float yalign [@property setter];

static gtk.button.Button newFromIconName(string iconName, gtk.types.IconSize size);

static gtk.button.Button newFromStock(string stockId);

static gtk.button.Button newWithLabel(string label);

static gtk.button.Button newWithMnemonic(string label);

void clicked();

void enter();

void getAlignment(float xalign, float yalign);

bool getAlwaysShowImage();

gdk.window.Window getEventWindow();

bool getFocusOnClick();

gtk.widget.Widget getImage();

gtk.types.PositionType getImagePosition();

string getLabel();

gtk.types.ReliefStyle 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(gtk.widget.Widget image);

void setImagePosition(gtk.types.PositionType position);

void setLabel(string label);

void setRelief(gtk.types.ReliefStyle relief);

void setUseStock(bool useStock);

void setUseUnderline(bool useUnderline);

gulong connectActivate(T callback, Flag!"After" after);

gulong connectClicked(T callback, Flag!"After" after);

gulong connectEnter(T callback, Flag!"After" after);

gulong connectLeave(T callback, Flag!"After" after);

gulong connectPressed(T callback, Flag!"After" after);

gulong connectReleased(T callback, Flag!"After" after);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a new #GtkButton widget. To add a child widget to the button, use gtk.container.Container.add.

Members

Functions

clicked void clicked(): Emits a #GtkButton::clicked signal to the given #GtkButton.
connectActivate gulong connectActivate(T callback, Flag!"After" after): Connect to Activate signal.
connectClicked gulong connectClicked(T callback, Flag!"After" after): Connect to Clicked signal.
connectEnter gulong connectEnter(T callback, Flag!"After" after): Connect to Enter signal.
connectLeave gulong connectLeave(T callback, Flag!"After" after): Connect to Leave signal.
connectPressed gulong connectPressed(T callback, Flag!"After" after): Connect to Pressed signal.
connectReleased gulong connectReleased(T callback, Flag!"After" after): Connect to Released signal.
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 gdk.window.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.Button.setFocusOnClick.
getImage gtk.widget.Widget getImage(): Gets the widget that is currenty set as the image of button. This may have been explicitly set by gtk.button.Button.setImage or constructed by gtk.button.Button.newFromStock.
getImagePosition gtk.types.PositionType 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.Button.setLabel. 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.Button.new_ to use as a container.
getRelief gtk.types.ReliefStyle 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.
self Button self(): Returns this, for use in with statements.
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(gtk.widget.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.Widget.show on image yourself.
setImagePosition void setImagePosition(gtk.types.PositionType 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.Button.setUseStock is used.
setRelief void setRelief(gtk.types.ReliefStyle relief): Sets the relief style of the edges of the given #GtkButton widget. Two styles exist, gtk.types.ReliefStyle.Normal and gtk.types.ReliefStyle.None. The default style is, as one can guess, gtk.types.ReliefStyle.Normal. The deprecated value gtk.types.ReliefStyle.Half behaves the same as gtk.types.ReliefStyle.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.

Properties

_gType GType _gType [@property getter]
alwaysShowImage bool alwaysShowImage [@property getter]: Get alwaysShowImage property.
alwaysShowImage bool alwaysShowImage [@property setter]: Set alwaysShowImage property.
image gtk.widget.Widget image [@property getter]: Get image property.
image gtk.widget.Widget image [@property setter]: Set image property.
imagePosition gtk.types.PositionType imagePosition [@property getter]: Get imagePosition property.
imagePosition gtk.types.PositionType imagePosition [@property setter]: Set imagePosition property.
label string label [@property getter]
label string label [@property setter]
relief gtk.types.ReliefStyle relief [@property getter]
relief gtk.types.ReliefStyle relief [@property setter]
useStock bool useStock [@property getter]
useStock bool useStock [@property setter]
useUnderline bool useUnderline [@property getter]
useUnderline bool useUnderline [@property setter]
xalign float xalign [@property getter]: Get xalign property.
xalign float xalign [@property setter]: Set xalign property.
yalign float yalign [@property getter]: Get yalign property.
yalign float yalign [@property setter]: Set yalign property.

Static functions

_getGType GType _getGType()
builder ButtonGidBuilder builder(): Get builder for gtk.button.Button
newFromIconName gtk.button.Button newFromIconName(string iconName, gtk.types.IconSize size): Creates a new button containing an icon from the current icon theme.
newFromStock gtk.button.Button newFromStock(string stockId): Creates a new #GtkButton containing the image and text from a [stock item]gtkstock. Some stock ids have preprocessor macros like #GTK_STOCK_OK and #GTK_STOCK_APPLY.
newWithLabel gtk.button.Button newWithLabel(string label): Creates a #GtkButton widget with a #GtkLabel child containing the given text.
newWithMnemonic gtk.button.Button newWithMnemonic(string label): 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.

Mixed In Members

From `mixin ActionableT!()`

actionName string actionName [@property getter]
actionName string actionName [@property setter]
actionTarget glib.variant.Variant actionTarget [@property getter]
actionTarget glib.variant.Variant actionTarget [@property setter]
getActionName string getActionName(): Gets the action name for actionable.
getActionTargetValue glib.variant.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(glib.variant.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 `mixin ActivatableT!()`

relatedAction gtk.action.Action relatedAction [@property getter]: Get relatedAction property.
relatedAction gtk.action.Action relatedAction [@property setter]: Set relatedAction property.
useActionAppearance bool useActionAppearance [@property getter]: Get useActionAppearance property.
useActionAppearance bool useActionAppearance [@property setter]: Set useActionAppearance property.
doSetRelatedAction void doSetRelatedAction(gtk.action.Action action): This is a utility function for #GtkActivatable implementors.
getRelatedAction gtk.action.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(gtk.action.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(gtk.action.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.

Inherited Members

From Bin

_getGType GType _getGType()
_gType GType _gType [@property getter]
self Bin self(): Returns this, for use in with statements.
builder BinGidBuilder builder(): Get builder for gtk.bin.Bin
getChild gtk.widget.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 Actionable

_getGType GType _getGType()
actionName string actionName [@property getter]
actionName string actionName [@property setter]
actionTarget glib.variant.Variant actionTarget [@property getter]
actionTarget glib.variant.Variant actionTarget [@property setter]
getActionName string getActionName(): Gets the action name for actionable.
getActionTargetValue glib.variant.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(glib.variant.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 Activatable

_getGType GType _getGType()
relatedAction gtk.action.Action relatedAction [@property getter]: Get relatedAction property.
relatedAction gtk.action.Action relatedAction [@property setter]: Set relatedAction property.
useActionAppearance bool useActionAppearance [@property getter]: Get useActionAppearance property.
useActionAppearance bool useActionAppearance [@property setter]: Set useActionAppearance property.
doSetRelatedAction void doSetRelatedAction(gtk.action.Action action): This is a utility function for #GtkActivatable implementors.
getRelatedAction gtk.action.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(gtk.action.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(gtk.action.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.

gtk button classes