GI.Gtk.Objects.ModelButton

GtkModelButton is a button class that can use a Action as its model. In contrast to ToggleButton or RadioButton, which can also be backed by a Action via the Actionable: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 popoverNewFromModel; they can also be used manually in a PopoverMenu.

When the action is specified via the Actionable:action-name and Actionable: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 ModelButton:role property.

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

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

Model buttons have built-in support for submenus in PopoverMenu. To make a GtkModelButton that opens a submenu when activated, set the ModelButton:menu-name property. To make a button that goes back to the parent menu, you should set the ModelButton: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

plain code

modelbutton
├── <child>
╰── check

plain code

modelbutton
├── <child>
╰── radio

plain code

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.

plain code

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

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

Exported types

newtype ModelButton

Constructors

ModelButton (ManagedPtr ModelButton)

Instances

GObject ModelButton

Methods

gobjectType :: ModelButton -> IO GType

IsImplementorIface ModelButton

IsObject ModelButton

IsWidget ModelButton

IsContainer ModelButton

IsButton ModelButton

IsBin ModelButton

IsBuildable ModelButton

IsActivatable ModelButton

IsActionable ModelButton

IsModelButton ModelButton

class GObject o => IsModelButton o

Instances

(GObject a, UnknownAncestorError Constraint ModelButton a) => IsModelButton a

IsModelButton ModelButton

toModelButton :: (MonadIO m, IsModelButton o) => o -> m ModelButton

noModelButton :: Maybe ModelButton

Methods

new

modelButtonNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ModelButton

Returns: the newly created ModelButton widget

Creates a new GtkModelButton.

Since: 3.16

Properties

active

constructModelButtonActive :: IsModelButton o => Bool -> IO (GValueConstruct o)

getModelButtonActive :: (MonadIO m, IsModelButton o) => o -> m Bool

setModelButtonActive :: (MonadIO m, IsModelButton o) => o -> Bool -> m ()

centered

constructModelButtonCentered :: IsModelButton o => Bool -> IO (GValueConstruct o)

getModelButtonCentered :: (MonadIO m, IsModelButton o) => o -> m Bool

setModelButtonCentered :: (MonadIO m, IsModelButton o) => o -> Bool -> m ()

icon

clearModelButtonIcon :: (MonadIO m, IsModelButton o) => o -> m ()

constructModelButtonIcon :: (IsModelButton o, IsIcon a) => a -> IO (GValueConstruct o)

getModelButtonIcon :: (MonadIO m, IsModelButton o) => o -> m (Maybe Icon)

setModelButtonIcon :: (MonadIO m, IsModelButton o, IsIcon a) => o -> a -> m ()

iconic

constructModelButtonIconic :: IsModelButton o => Bool -> IO (GValueConstruct o)

getModelButtonIconic :: (MonadIO m, IsModelButton o) => o -> m Bool

setModelButtonIconic :: (MonadIO m, IsModelButton o) => o -> Bool -> m ()

inverted

constructModelButtonInverted :: IsModelButton o => Bool -> IO (GValueConstruct o)

getModelButtonInverted :: (MonadIO m, IsModelButton o) => o -> m Bool

setModelButtonInverted :: (MonadIO m, IsModelButton o) => o -> Bool -> m ()

menuName

clearModelButtonMenuName :: (MonadIO m, IsModelButton o) => o -> m ()

constructModelButtonMenuName :: IsModelButton o => Text -> IO (GValueConstruct o)

getModelButtonMenuName :: (MonadIO m, IsModelButton o) => o -> m (Maybe Text)

setModelButtonMenuName :: (MonadIO m, IsModelButton o) => o -> Text -> m ()

role

constructModelButtonRole :: IsModelButton o => ButtonRole -> IO (GValueConstruct o)

getModelButtonRole :: (MonadIO m, IsModelButton o) => o -> m ButtonRole

setModelButtonRole :: (MonadIO m, IsModelButton o) => o -> ButtonRole -> m ()

text

clearModelButtonText :: (MonadIO m, IsModelButton o) => o -> m ()

constructModelButtonText :: IsModelButton o => Text -> IO (GValueConstruct o)

getModelButtonText :: (MonadIO m, IsModelButton o) => o -> m (Maybe Text)

setModelButtonText :: (MonadIO m, IsModelButton o) => o -> Text -> m ()