Class

AdwSwitchRow

since: 1.4

Description [src] 

final class Adw.SwitchRow : Adw.ActionRow
  implements Gtk.Accessible, Gtk.Actionable, Gtk.Buildable, Gtk.ConstraintTarget {
  /* No available fields */
}

A GtkListBoxRow used to represent two states.

switch-row

The AdwSwitchRow widget contains a GtkSwitch that allows the user to select between two states: “on” or “off”. When activated, the row will invert its active state.

The user can control the switch by activating the row or by dragging on the switch handle.

See GtkSwitch for details.

Example of an AdwSwitchRow UI definition:

<object class="AdwSwitchRow">
  <property name="title" translatable="yes">Switch Row</property>
  <signal name="notify::active" handler="switch_row_notify_active_cb"/>
</object>

The AdwSwitchRow:active property should be connected to in order to monitor changes to the active state.

Available since: 1.4

Hierarchy

hierarchy this AdwSwitchRow implements_0 GtkAccessible this--implements_0 implements_1 GtkActionable this--implements_1 implements_2 GtkBuildable this--implements_2 implements_3 GtkConstraintTarget this--implements_3 ancestor_0 AdwActionRow ancestor_0--this ancestor_1 AdwPreferencesRow ancestor_1--ancestor_0 ancestor_2 GtkListBoxRow ancestor_2--ancestor_1 ancestor_3 GtkWidget ancestor_3--ancestor_2 ancestor_4 GInitiallyUnowned ancestor_4--ancestor_3 ancestor_5 GObject ancestor_5--ancestor_4

Ancestors

Implements

Constructors

adw_switch_row_new

Creates a new AdwSwitchRow.

since: 1.4

Instance methods

adw_switch_row_get_active

Gets whether self is in its “on” or “off” position.

since: 1.4

adw_switch_row_set_active

Sets whether self is in its “on” or “off” position.

since: 1.4

Methods inherited from AdwActionRow (16)
adw_action_row_activate

Activates self.

since: 1

adw_action_row_add_prefix

Adds a prefix widget to self.

since: 1

adw_action_row_add_suffix

Adds a suffix widget to self.

since: 1

adw_action_row_get_activatable_widget

Gets the widget activated when self is activated.

since: 1

adw_action_row_get_icon_name

Gets the icon name for self.

deprecated: 1.3 since: 1

adw_action_row_get_subtitle

Gets the subtitle for self.

since: 1

adw_action_row_get_subtitle_lines

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

since: 1

adw_action_row_get_subtitle_selectable

Gets whether the user can copy the subtitle from the label.

since: 1.3

adw_action_row_get_title_lines

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

since: 1

adw_action_row_remove

Removes a child from self.

since: 1

adw_action_row_set_activatable_widget

Sets the widget to activate when self is activated.

since: 1

adw_action_row_set_icon_name

Sets the icon name for self.

deprecated: 1.3 since: 1

adw_action_row_set_subtitle

Sets the subtitle for self.

since: 1

adw_action_row_set_subtitle_lines

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

since: 1

adw_action_row_set_subtitle_selectable

Sets whether the user can copy the subtitle from the label.

since: 1.3

adw_action_row_set_title_lines

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

since: 1

Methods inherited from AdwPreferencesRow (8)
adw_preferences_row_get_title

Gets the title of the preference represented by self.

since: 1

adw_preferences_row_get_title_selectable

Gets whether the user can copy the title from the label.

since: 1.1

adw_preferences_row_get_use_markup

Gets whether to use Pango markup for the title label.

since: 1.2

adw_preferences_row_get_use_underline

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

since: 1

adw_preferences_row_set_title

Sets the title of the preference represented by self.

since: 1

adw_preferences_row_set_title_selectable

Sets whether the user can copy the title from the label.

since: 1.1

adw_preferences_row_set_use_markup

Sets whether to use Pango markup for the title label.

since: 1.2

adw_preferences_row_set_use_underline

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

since: 1

Methods inherited from GtkListBoxRow (11)
gtk_list_box_row_changed

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

unstable since: 4.0

gtk_list_box_row_get_activatable

Gets whether the row is activatable.

unstable since: 4.0

gtk_list_box_row_get_child

Gets the child widget of row.

unstable since: 4.0

gtk_list_box_row_get_header

Returns the current header of the row.

unstable since: 4.0

gtk_list_box_row_get_index

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

unstable since: 4.0

gtk_list_box_row_get_selectable

Gets whether the row can be selected.

unstable since: 4.0

gtk_list_box_row_is_selected

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

unstable since: 4.0

gtk_list_box_row_set_activatable

Set whether the row is activatable.

unstable since: 4.0

gtk_list_box_row_set_child

Sets the child widget of self.

unstable since: 4.0

gtk_list_box_row_set_header

Sets the current header of the row.

unstable since: 4.0

gtk_list_box_row_set_selectable

Set whether the row can be selected.

unstable since: 4.0

Methods inherited from GtkWidget (162)

Please see GtkWidget for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GtkAccessible (18)
gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

unstable since: 4.10

gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

unstable since: 4.0

gtk_accessible_get_at_context

Retrieves the accessible implementation for the given GtkAccessible.

unstable since: 4.10

gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

unstable since: 4.10

gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

unstable since: 4.10

gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

unstable since: 4.10

gtk_accessible_get_platform_state

Query a platform state, such as focus.

unstable since: 4.10

gtk_accessible_reset_property

Resets the accessible property to its default value.

unstable since: 4.0

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

unstable since: 4.0

gtk_accessible_reset_state

Resets the accessible state to its default value.

unstable since: 4.0

gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

unstable since: 4.10

gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of self.

unstable since: 4.10

gtk_accessible_update_property

Updates a list of accessible properties.

unstable since: 4.0

gtk_accessible_update_property_value

Updates an array of accessible properties.

unstable since: 4.0

gtk_accessible_update_relation

Updates a list of accessible relations.

unstable since: 4.0

gtk_accessible_update_relation_value

Updates an array of accessible relations.

unstable since: 4.0

gtk_accessible_update_state

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

unstable since: 4.0

gtk_accessible_update_state_value

Updates an array of accessible states.

unstable since: 4.0

Methods inherited from GtkActionable (6)
gtk_actionable_get_action_name

Gets the action name for actionable.

unstable since: 4.0

gtk_actionable_get_action_target_value

Gets the current target value of actionable.

unstable since: 4.0

gtk_actionable_set_action_name

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

unstable since: 4.0

gtk_actionable_set_action_target

Sets the target of an actionable widget.

unstable since: 4.0

gtk_actionable_set_action_target_value

Sets the target value of an actionable widget.

unstable since: 4.0

gtk_actionable_set_detailed_action_name

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

unstable since: 4.0

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

unstable since: 4.0

Properties

Adw.SwitchRow:active

Whether the switch row is in the “on” or “off” position.

since: 1.4

Properties inherited from AdwActionRow (6)
Adw.ActionRow:activatable-widget

The widget to activate when the row is activated.

since: 1

Adw.ActionRow:icon-name

The icon name for this row.

deprecated: 1.3 since: 1

Adw.ActionRow:subtitle

The subtitle for this row.

since: 1

Adw.ActionRow:subtitle-lines

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

since: 1

Adw.ActionRow:subtitle-selectable

Whether the user can copy the subtitle from the label.

since: 1.3

Adw.ActionRow:title-lines

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

since: 1

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

The title of the preference represented by this row.

since: 1

Adw.PreferencesRow:title-selectable

Whether the user can copy the title from the label.

since: 1.1

Adw.PreferencesRow:use-markup

Whether to use Pango markup for the title label.

since: 1.2

Adw.PreferencesRow:use-underline

Whether an embedded underline in the title indicates a mnemonic.

since: 1

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

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

unstable since: 4.0

Gtk.ListBoxRow:child

The child widget.

unstable since: 4.0

Gtk.ListBoxRow:selectable

Determines whether this row can be selected.

unstable since: 4.0

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

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

unstable since: 4.0

Gtk.Widget:can-target

Whether the widget can receive pointer events.

unstable since: 4.0

Gtk.Widget:css-classes

A list of css classes applied to this widget.

unstable since: 4.0

Gtk.Widget:css-name

The name of this widget in the CSS tree.

unstable since: 4.0

Gtk.Widget:cursor

The cursor used by widget.

unstable since: 4.0

Gtk.Widget:focus-on-click

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

unstable since: 4.0

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

unstable since: 4.0

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

unstable since: 4.0

Gtk.Widget:has-default

Whether the widget is the default widget.

unstable since: 4.0

Gtk.Widget:has-focus

Whether the widget has the input focus.

unstable since: 4.0

Gtk.Widget:has-tooltip

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

unstable since: 4.0

Gtk.Widget:height-request

Override for height request of the widget.

unstable since: 4.0

Gtk.Widget:hexpand

Whether to expand horizontally.

unstable since: 4.0

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

unstable since: 4.0

Gtk.Widget:layout-manager

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

unstable since: 4.0

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

unstable since: 4.0

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

unstable since: 4.0

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

unstable since: 4.0

Gtk.Widget:margin-top

Margin on top side of widget.

unstable since: 4.0

Gtk.Widget:name

The name of the widget.

unstable since: 4.0

Gtk.Widget:opacity

The requested opacity of the widget.

unstable since: 4.0

Gtk.Widget:overflow

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

unstable since: 4.0

Gtk.Widget:parent

The parent widget of this widget.

unstable since: 4.0

Gtk.Widget:receives-default

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

unstable since: 4.0

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

unstable since: 4.0

Gtk.Widget:scale-factor

The scale factor of the widget.

unstable since: 4.0

Gtk.Widget:sensitive

Whether the widget responds to input.

unstable since: 4.0

Gtk.Widget:tooltip-markup

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

unstable since: 4.0

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

unstable since: 4.0

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

unstable since: 4.0

Gtk.Widget:vexpand

Whether to expand vertically.

unstable since: 4.0

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

unstable since: 4.0

Gtk.Widget:visible

Whether the widget is visible.

unstable since: 4.0

Gtk.Widget:width-request

Override for width request of the widget.

unstable since: 4.0

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

The accessible role of the given GtkAccessible implementation.

unstable since: 4.0

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

unstable since: 4.0

Gtk.Actionable:action-target
No description available.

unstable since: 4.0

Signals

Signals inherited from AdwActionRow (1)
AdwActionRow::activated

This signal is emitted after the row has been activated.

since: 1

Signals inherited from GtkListBoxRow (1)
GtkListBoxRow::activate

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

unstable since: 4.0

Signals inherited from GtkWidget (13)
GtkWidget::destroy

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

unstable since: 4.0

GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

unstable since: 4.0

GtkWidget::hide

Emitted when widget is hidden.

unstable since: 4.0

GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

unstable since: 4.0

GtkWidget::map

Emitted when widget is going to be mapped.

unstable since: 4.0

GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

unstable since: 4.0

GtkWidget::move-focus

Emitted when the focus is moved.

unstable since: 4.0

GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

unstable since: 4.0

GtkWidget::realize

Emitted when widget is associated with a GdkSurface.

unstable since: 4.0

GtkWidget::show

Emitted when widget is shown.

unstable since: 4.0

GtkWidget::state-flags-changed

Emitted when the widget state changes.

unstable since: 4.0

GtkWidget::unmap

Emitted when widget is going to be unmapped.

unstable since: 4.0

GtkWidget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

unstable since: 4.0

Signals inherited from GObject (1)
GObject::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.

unstable since: 2.0

Class structure 

struct AdwSwitchRowClass {
  AdwActionRowClass parent_class;
  
}
No description available.
Class members
parent_class: AdwActionRowClass
No description available.