Adw.SplitButton – libadwaita-1 Reference Manual

Packages

libadwaita-1

Adw

SplitButton

SplitButton

Object Hierarchy:

Object hierarchy for SplitButton

Description:

[ CCode ( type_id = "adw_split_button_get_type ()" ) ]
public sealed class SplitButton : Widget, Accessible, Actionable, Buildable, ConstraintTarget

A combined button and dropdown widget.

<picture> <source srcset="split-button-dark.png" media="(prefers-color-scheme: dark)"> <img src="split-button.png" alt="split-button"> </picture>

`AdwSplitButton` is typically used to present a set of actions in a menu, but allow access to one of them with a single click.

The API is very similar to [class@Gtk.Button] and [class@Gtk.MenuButton], see their documentation for details.

CSS nodes

``` splitbutton.image-button ├── button │ ╰── <content> ├── separator ╰── menubutton ╰── button.toggle ╰── arrow ```

`AdwSplitButton`'s CSS node is called `splitbutton`. It contains the css nodes: `button`, `separator`, `menubutton`. See [ class@Gtk.MenuButton] documentation for the `menubutton` contents.

The main CSS node will contain the `.image-button` or `.text-button` style classes matching the button contents. The nested button nodes will never contain them.

Style classes

`AdwSplitButton` can use some of the same style classes as [class@Gtk.Button]:

[`.suggested-action`](style-classes.html#suggested-action)
[`.destructive-action`](style-classes.html#destructive-action)
[`.flat`](style-classes.html#flat)
[`.raised`](style-classes.html#raised)

Other style classes, like `.pill`, cannot be used.

Accessibility

`AdwSplitButton` uses the [enum@Gtk.AccessibleRole.group] role.

Namespace: Adw

Package: libadwaita-1

Content:

Properties:

public bool can_shrink { get; set; }
Whether the button can be smaller than the natural size of its contents.
public Widget child { get; set; }
The child widget.
public ArrowType direction { get; set; }
The direction in which the popup will be popped up.
public string dropdown_tooltip { get; set; }
The tooltip of the dropdown button.
public string icon_name { get; set; }
The name of the icon used to automatically populate the button.
public string label { get; set; }
The label for the button.
public MenuModel menu_model { get; set; }
The `GMenuModel` from which the popup will be created.
public Popover popover { get; set; }
The `GtkPopover` that will be popped up when the dropdown is clicked.
public bool use_underline { get; set; }
Whether an underline in the text indicates a mnemonic.

Creation methods:

public SplitButton ()
Creates a new `AdwSplitButton`.

Methods:

public bool get_can_shrink ()
gets whether the button can be smaller than the natural size of its contents.
public unowned Widget? get_child ()
Gets the child widget.
public ArrowType get_direction ()
Gets the direction in which the popup will be popped up.
public unowned string get_dropdown_tooltip ()
Gets the tooltip of the dropdown button of this.
public unowned string? get_icon_name ()
Gets the name of the icon used to automatically populate the button.
public unowned string? get_label ()
Gets the label for this.
public unowned MenuModel? get_menu_model ()
Gets the menu model from which the popup will be created.
public unowned Popover? get_popover ()
Gets the popover that will be popped up when the dropdown is clicked.
public bool get_use_underline ()
Gets whether an underline in the text indicates a mnemonic.
public void popdown ()
Dismisses the menu.
public void popup ()
Pops up the menu.
public void set_can_shrink (bool can_shrink)
Sets whether the button can be smaller than the natural size of its contents.
public void set_child (Widget? child)
Sets the child widget.
public void set_direction (ArrowType direction)
Sets the direction in which the popup will be popped up.
public void set_dropdown_tooltip (string tooltip)
Sets the tooltip of the dropdown button of this.
public void set_icon_name (string icon_name)
Sets the name of the icon used to automatically populate the button.
public void set_label (string label)
Sets the label for this.
public void set_menu_model (MenuModel? menu_model)
Sets the menu model from which the popup will be created.
public void set_popover (Popover? popover)
Sets the popover that will be popped up when the dropdown is clicked.
public void set_use_underline (bool use_underline)
Sets whether an underline in the text indicates a mnemonic.

Signals:

public signal void activate ()
Emitted to animate press then release.
public signal void clicked ()
Emitted when the button has been activated (pressed and released).

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Actionable

All known members inherited from interface Gtk.Buildable

Generated by valadoc