GtkModelButton: GTK+ 4 Reference Manual

## GtkModelButton GtkModelButton — A button that uses a GAction as model |

## Functions

GtkWidget * | gtk_model_button_new ()

## Types and Values

| GtkModelButton
enum | GtkButtonRole

## Includes

    #include <gtk/gtk.h>

## Description

GtkModelButton is a button class that can use a GAction as its model. In contrast to GtkToggleButton or GtkRadioButton, which can also be backed by a GAction 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 `gtk_popover_new_from_model()`; they can also be used manually in a GtkPopoverMenu.

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 GtkPopoverMenu. 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

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    <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

    1
    2
    3
    modelbutton
    ├── <child>
    ╰── check

    1
    2
    3
    modelbutton
    ├── <child>
    ╰── radio

    1
    2
    3
    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.

    1
    2
    3
    button.model
    ├── <child>
    ╰── check

Iconic model buttons (see “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.

## Functions

### gtk_model_button_new ()

    GtkWidget *
    gtk_model_button_new (void);

Creates a new GtkModelButton.

#### Returns

the newly created GtkModelButton widget

Since: 3.16

## Types and Values

### GtkModelButton

    typedef struct _GtkModelButton GtkModelButton;

### enum GtkButtonRole

The role specifies the desired appearance of a GtkModelButton.

#### Members

GTK_BUTTON_ROLE_NORMAL | A plain button |
GTK_BUTTON_ROLE_CHECK | A check button |
GTK_BUTTON_ROLE_RADIO | A radio button |