Class

AdwActionRow

Description [src]

class Adw.ActionRow : Adw.PreferencesRow {
  parent_instance: AdwPreferencesRow
}

A GtkListBoxRow used to present actions.

The AdwActionRow widget can have a title, a subtitle and an icon. The row can receive additional widgets at its end, or prefix widgets at its start.

It is convenient to present a preference and its related actions.

AdwActionRow is unactivatable by default, giving it an activatable widget will automatically make it activatable, but unsetting it won’t change the row’s activatability.

AdwActionRow as GtkBuildable

The AdwActionRow implementation of the GtkBuildable interface supports adding a child at its end by specifying “suffix” or omitting the “type” attribute of a element.

It also supports adding a child as a prefix widget by specifying “prefix” as the “type” attribute of a element.

CSS nodes

AdwActionRow has a main CSS node with name row.

It contains the subnode box.header for its main horizontal box, and box.title for the vertical box containing the title and subtitle labels.

It contains subnodes label.title and label.subtitle representing respectively the title label and subtitle label.

Available since:1.0

Constructors

adw_action_row_new

Creates a new AdwActionRow.

Available since: 1.0

Instance methods

adw_action_row_activate

Activates self.

Available since: 1.0

adw_action_row_add_prefix

Adds a prefix widget to self.

Available since: 1.0

adw_action_row_add_suffix

Adds a suffix widget to self.

Available since: 1.0

adw_action_row_get_activatable_widget

Gets the widget activated when self is activated.

Available since: 1.0

adw_action_row_get_icon_name

Gets the icon name for self.

Available since: 1.0

adw_action_row_get_subtitle

Gets the subtitle for self.

Available since: 1.0

adw_action_row_get_subtitle_lines

Gets the number of lines at the end of which the subtitle label will be ellipsized.

Available since: 1.0

adw_action_row_get_title_lines

Gets the number of lines at the end of which the title label will be ellipsized.

Available since: 1.0

adw_action_row_get_use_underline

Gets whether underlines in title or subtitle are interpreted as mnemonics.

Available since: 1.0

adw_action_row_remove

Removes a child from self.

Available since: 1.0

adw_action_row_set_activatable_widget

Sets the widget to activate when self is activated.

Available since: 1.0

adw_action_row_set_icon_name

Sets the icon name for self.

Available since: 1.0

adw_action_row_set_subtitle

Sets the subtitle for self.

Available since: 1.0

adw_action_row_set_subtitle_lines

Sets the number of lines at the end of which the subtitle label will be ellipsized.

Available since: 1.0

adw_action_row_set_title_lines

Sets the number of lines at the end of which the title label will be ellipsized.

Available since: 1.0

adw_action_row_set_use_underline

Sets whether underlines in title or subtitle are interpreted as mnemonics.

Available since: 1.0

Methods inherited from AdwPreferencesRow (4)
adw_preferences_row_get_title

Gets the title of the preference represented by self.

Available since: 1.0

adw_preferences_row_get_use_underline

Gets whether an embedded underline in the title indicates a mnemonic.

Available since: 1.0

adw_preferences_row_set_title

Sets the title of the preference represented by self.

Available since: 1.0

adw_preferences_row_set_use_underline

Sets whether an embedded underline in the title indicates a mnemonic.

Available since: 1.0

Methods inherited from GtkListBoxRow (11)
gtk_list_box_row_changed

Marks row as changed, causing any state that depends on this to be updated.

gtk_list_box_row_get_activatable

Gets whether the row is activatable.

gtk_list_box_row_get_child

Gets the child widget of row.

gtk_list_box_row_get_header

Returns the current header of the row.

gtk_list_box_row_get_index

Gets the current index of the row in its GtkListBox container.

gtk_list_box_row_get_selectable

Gets whether the row can be selected.

gtk_list_box_row_is_selected

Returns whether the child is currently selected in its GtkListBox container.

gtk_list_box_row_set_activatable

Set whether the row is activatable.

gtk_list_box_row_set_child

Sets the child widget of self.

gtk_list_box_row_set_header

Sets the current header of the row.

gtk_list_box_row_set_selectable

Set whether the row can be selected.

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.ActionRow:activatable-widget

The widget to activate when the row is activated.

Available since: 1.0

Adw.ActionRow:icon-name

The icon name for this row.

Available since: 1.0

Adw.ActionRow:subtitle

The subtitle for this row.

Available since: 1.0

Adw.ActionRow:subtitle-lines

The number of lines at the end of which the subtitle label will be ellipsized.

Available since: 1.0

Adw.ActionRow:title-lines

The number of lines at the end of which the title label will be ellipsized.

Available since: 1.0

Adw.ActionRow:use-underline

Whether underlines in title or subtitle are interpreted as mnemonics.

Available since: 1.0

Properties inherited from AdwPreferencesRow (2)
Adw.PreferencesRow:title

The title of the preference represented by this row.

Available since: 1.0

Adw.PreferencesRow:use-underline

Whether an embedded underline in the title indicates a mnemonic.

Available since: 1.0

Properties inherited from GtkListBoxRow (3)
Gtk.ListBoxRow:activatable

Determines whether the ::row-activated signal will be emitted for this row.

Gtk.ListBoxRow:child

The child widget.

Gtk.ListBoxRow:selectable

Determines whether this row can be selected.

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.ActionRow::activated

This signal is emitted after the row has been activated.

Available since: 1.0

Signals inherited from GtkListBoxRow (1)
Gtk.ListBoxRow::activate

This is a keybinding signal, which will cause this row to be activated.

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 AdwActionRowClass {
  AdwPreferencesRowClass parent_class;
  void (* activate) (
    AdwActionRow* self
  );
  
}
Class members
parent_class
AdwPreferencesRowClass
 

The parent class.

activate
void (* activate) (
    AdwActionRow* self
  )
  No description available.

Virtual methods

Adw.ActionRowClass.activate

Activates self.

Available since: 1.0