ModelButton

GtkModelButton is a button class that can use a gtk.Action as its model. In contrast to gtk.ToggleButton or gtk.RadioButton, which can also be backed by a gtk.Action via the action-name property, GtkModelButton will adapt its appearance according to the kind of action it is backed by, and appear either as a plain, check or radio button.

Model buttons are used when popovers from a menu model with Popover.newFromModel; they can also be used manually in a gtk.PopoverMenu

When the action is specified via the action-name and action-target properties, the role of the button (i.e. whether it is a plain, check or radio button) is determined by the type of the action and doesn't have to be explicitly specified with the role property.

The content of the button is specified by the text and icon properties.

The appearance of model buttons can be influenced with the centered and iconic properties.

Model buttons have built-in support for submenus in gtk.PopoverMenu To make a GtkModelButton that opens a submenu when activated, set the menu-name property. To make a button that goes back to the parent menu, you should set the inverted property to place the submenu indicator at the opposite side.

Example

|[ <object class="GtkPopoverMenu"> <child> <object class="GtkBox"> <property name="visible">True</property> <property name="margin">10</property> <child> <object class="GtkModelButton"> <property name="visible">True</property> <property name="action-name">view.cut</property> <property name="text" translatable="yes">Cut</property> </object> </child> <child> <object class="GtkModelButton"> <property name="visible">True</property> <property name="action-name">view.copy</property> <property name="text" translatable="yes">Copy</property> </object> </child> <child> <object class="GtkModelButton"> <property name="visible">True</property> <property name="action-name">view.paste</property> <property name="text" translatable="yes">Paste</property> </object> </child> </object> </child> </object>

# CSS nodes

|[<!-- language="plain" -->
modelbutton
├── <child>
╰── check

|[ modelbutton ├── <child> ╰── radio

|[<!-- language="plain" -->
modelbutton
├── <child>
╰── arrow

GtkModelButton has a main CSS node with name modelbutton, and a subnode, which will have the name check, radio or arrow, depending on the role of the button and whether it has a menu name set.

The subnode is positioned before or after the content nodes and gets the .left or .right style class, depending on where it is located.

|[ button.model ├── <child> ╰── check

Iconic model buttons (see [gtk.ModelButton.ModelButton.getIconic|iconic]) change the name of
their main node to button and add a .model style class to it. The indicator
subnode is invisible in this case.

class ModelButton : Button {

protected

GtkModelButton* gtkModelButton;

GtkModelButton* getModelButtonStruct(bool transferOwnership);

void* getStruct();

this(GtkModelButton* gtkModelButton, bool ownedRef);

static GType getType();

this();

}

Constructors

this this(GtkModelButton* gtkModelButton, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new GtkModelButton.

Members

Functions

getModelButtonStruct GtkModelButton* getModelButtonStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*

Static functions

getType GType getType()

Variables

gtkModelButton GtkModelButton* gtkModelButton;: the main Gtk struct

Inherited Members

From Button

gtkButton GtkButton* gtkButton;: the main Gtk struct
getButtonStruct GtkButton* getButtonStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
setIconSize void setIconSize(IconSize iconSize)
getIconSize IconSize getIconSize()
getType GType getType()
clicked void clicked(): Emits a clicked signal to the given gtk.Button
enter void enter(): Emits a enter signal to the given gtk.Button
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 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 Button.setFocusOnClick.
getImage Widget getImage(): Gets the widget that is currenty set as the image of button. This may have been explicitly set by Button.setImage or constructed by Button.newFromStock.
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 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 Button.new to use as a container.
getRelief GtkReliefStyle getRelief(): Returns the current relief style of the given gtk.Button
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 leave signal to the given gtk.Button
pressed void pressed(): Emits a pressed signal to the given gtk.Button
released void released(): Emits a released signal to the given gtk.Button
setAlignment void setAlignment(float xalign, float yalign): Sets the alignment of the child. This property has no effect unless the child is a gtk.Misc or a gtk.Alignment
setAlwaysShowImage void setAlwaysShowImage(bool alwaysShow): If TRUE, the button will ignore the 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 always-show-image is TRUE. You don’t have to call 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 Button.setUseStock is used.
setRelief void setRelief(GtkReliefStyle relief): Sets the relief style of the edges of the given gtk.Button 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.
addOnActivate gulong 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.
addOnClicked gulong addOnClicked(void delegate(Button) dlg, ConnectFlags connectFlags): Emitted when the button has been activated (pressed and released).
addOnEnter gulong addOnEnter(void delegate(Button) dlg, ConnectFlags connectFlags): Emitted when the pointer enters the button.
addOnLeave gulong addOnLeave(void delegate(Button) dlg, ConnectFlags connectFlags): Emitted when the pointer leaves the button.
addOnPressed gulong addOnPressed(void delegate(Button) dlg, ConnectFlags connectFlags): Emitted when the button is pressed.
addOnReleased gulong addOnReleased(void delegate(Button) dlg, ConnectFlags connectFlags): Emitted when the button is released.

gtk ModelButton classes

ModelButton