Class

AdwSplitButton

Description [src]

final class Adw.SplitButton : Gtk.Widget {
  /* No available fields */
}

A combined button and dropdown widget.

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 GtkButton and GtkMenuButton, see their documentation for details.

CSS nodes

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

AdwSplitButtons CSS node is called splitbutton. It contains the css nodes: button, separator, menubutton. See GtkMenuButton 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.

Accessibility

AdwSplitButton uses the GTK_ACCESSIBLE_ROLE_BUTTON role.

Available since:1.0

Constructors

adw_split_button_new

Creates a new AdwSplitButton.

Available since: 1.0

Instance methods

adw_split_button_get_child

Gets the child widget.

Available since: 1.0

adw_split_button_get_direction

Gets the direction in which the popup will be popped up.

Available since: 1.0

adw_split_button_get_icon_name

Gets the name of the icon used to automatically populate the button.

Available since: 1.0

adw_split_button_get_label

Gets the label for self.

Available since: 1.0

adw_split_button_get_menu_model

Gets the menu model from which the popup will be created.

Available since: 1.0

adw_split_button_get_popover

Gets the popover that will be popped up when the dropdown is clicked.

Available since: 1.0

adw_split_button_get_use_underline

Gets whether an underline in the text indicates a mnemonic.

Available since: 1.0

adw_split_button_popdown

Dismisses the menu.

Available since: 1.0

adw_split_button_popup

Pops up the menu.

Available since: 1.0

adw_split_button_set_child

Sets the child widget.

Available since: 1.0

adw_split_button_set_direction

Sets the direction in which the popup will be popped up.

Available since: 1.0

adw_split_button_set_icon_name

Sets the name of the icon used to automatically populate the button.

Available since: 1.0

adw_split_button_set_label

Sets the label for self.

Available since: 1.0

adw_split_button_set_menu_model

Sets the menu model from which the popup will be created.

Available since: 1.0

adw_split_button_set_popover

Sets the popover that will be popped up when the dropdown is clicked.

Available since: 1.0

adw_split_button_set_use_underline

Sets whether an underline in the text indicates a mnemonic.

Available since: 1.0

Methods inherited from GtkWidget (159)
Methods inherited from GObject (42)
Methods inherited from GtkAccessible (10)
gtk_accessible_get_accessible_role

Retrieves the GtkAccessibleRole for the given GtkAccessible.

gtk_accessible_reset_property

Resets the accessible property to its default value.

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

gtk_accessible_reset_state

Resets the accessible state to its default value.

gtk_accessible_update_property

Updates a list of accessible properties.

gtk_accessible_update_property_value

Updates an array of accessible properties.

gtk_accessible_update_relation

Updates a list of accessible relations.

gtk_accessible_update_relation_value

Updates an array of accessible relations.

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkActionable (6)
gtk_actionable_get_action_name

Gets the action name for actionable.

gtk_actionable_get_action_target_value

Gets the current target value of actionable.

gtk_actionable_set_action_name

Specifies the name of the action with which this widget should be associated.

gtk_actionable_set_action_target

Sets the target of an actionable widget.

gtk_actionable_set_action_target_value

Sets the target value of an actionable widget.

gtk_actionable_set_detailed_action_name

Sets the action-name and associated string target value of an actionable widget.

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Properties

Adw.SplitButton:child

The child widget.

Available since: 1.0

Adw.SplitButton:direction

The direction in which the popup will be popped up.

Available since: 1.0

Adw.SplitButton:icon-name

The name of the icon used to automatically populate the button.

Available since: 1.0

Adw.SplitButton:label

The label for the button.

Available since: 1.0

Adw.SplitButton:menu-model

The GMenuModel from which the popup will be created.

Available since: 1.0

Adw.SplitButton:popover

The GtkPopover that will be popped up when the dropdown is clicked.

Available since: 1.0

Adw.SplitButton:use-underline

Whether an underline in the text indicates a mnemonic.

Available since: 1.0

Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

Gtk.Widget:can-target

Whether the widget can receive pointer events.

Gtk.Widget:css-classes

A list of css classes applied to this widget.

Gtk.Widget:css-name

The name of this widget in the CSS tree.

Gtk.Widget:cursor

The cursor used by widget.

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

Gtk.Widget:has-default

Whether the widget is the default widget.

Gtk.Widget:has-focus

Whether the widget has the input focus.

Gtk.Widget:has-tooltip

Enables or disables the emission of the ::query-tooltip signal on widget.

Gtk.Widget:height-request

Override for height request of the widget.

Gtk.Widget:hexpand

Whether to expand horizontally.

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

Gtk.Widget:margin-top

Margin on top side of widget.

Gtk.Widget:name

The name of the widget.

Gtk.Widget:opacity

The requested opacity of the widget.

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

Gtk.Widget:parent

The parent widget of this widget.

Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

Gtk.Widget:scale-factor

The scale factor of the widget.

Gtk.Widget:sensitive

Whether the widget responds to input.

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

Gtk.Widget:vexpand

Whether to expand vertically.

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

Gtk.Widget:visible

Whether the widget is visible.

Gtk.Widget:width-request

Override for width request of the widget.

Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Properties inherited from GtkActionable (2)
Gtk.Actionable:action-name
No description available.
Gtk.Actionable:action-target
No description available.

Signals

Adw.SplitButton::activate

Emitted to animate press then release.

Available since: 1.0

Adw.SplitButton::clicked

Emitted when the button has been activated (pressed and released).

Available since: 1.0

Signals inherited from GtkWidget (13)
Gtk.Widget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

Gtk.Widget::direction-changed

Emitted when the text direction of a widget changes.

Gtk.Widget::hide

Emitted when widget is hidden.

Gtk.Widget::keynav-failed

Emitted if keyboard navigation fails.

Gtk.Widget::map

Emitted when widget is going to be mapped.

Gtk.Widget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

Gtk.Widget::move-focus

Emitted when the focus is moved.

Gtk.Widget::query-tooltip

Emitted when the widgets tooltip is about to be shown.

Gtk.Widget::realize

Emitted when widget is associated with a GdkSurface.

Gtk.Widget::show

Emitted when widget is shown.

Gtk.Widget::state-flags-changed

Emitted when the widget state changes.

Gtk.Widget::unmap

Emitted when widget is going to be unmapped.

Gtk.Widget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

Signals inherited from GObject (1)
GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct AdwSplitButtonClass {
  GtkWidgetClass parent_class;
  
}
Class members
parent_class
GtkWidgetClass
  No description available.