Adw.PreferencesGroup
Description
[src]
class Adw.PreferencesGroup : Gtk.Widget
implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
/* No available fields */
A group of preference rows.
An
AdwPreferencesGroup
represents a group or tightly related preferences,
which in turn are represented by
AdwPreferencesRow
To summarize the role of the preferences it gathers, a group can have both a
title and a description. The title will be used by
AdwPreferencesDialog
to let the user look for a preference.
The
AdwPreferencesGroup:separate-rows
property can be used to
separate the rows within the group, same as when using the
.boxed-list-separate
style class
instead of
.boxed-list
AdwPreferencesGroup as GtkBuildable
The
AdwPreferencesGroup
implementation of the
GtkBuildable
interface
supports adding
AdwPreferencesRow
s to the list by omitting “type”. If “type”
is omitted and the widget isn’t a
AdwPreferencesRow
the child is added to
a box below the list.
When the “type” attribute of a child is
header-suffix
, the child
is set as the suffix on the end of the title and description.
CSS nodes
AdwPreferencesGroup
has a single
CSS
node with name
preferencesgroup
AdwPreferencesGroup
uses the
GTK_ACCESSIBLE_ROLE_GROUP
role.
Hierarchy
Ancestors
GtkWidget
GInitiallyUnowned
GObject
Implements
GtkAccessible
GtkBuildable
GtkConstraintTarget
Constructors
adw_preferences_group_new
Creates a new
AdwPreferencesGroup
Instance methods
adw_preferences_group_add
Adds a child to
self
adw_preferences_group_bind_model
Binds
model
to
self
since: 1.8
adw_preferences_group_get_description
Gets the description of
self
adw_preferences_group_get_header_suffix
Gets the suffix for
self
s header.
since: 1.1
adw_preferences_group_get_row
Gets the row at
index
since: 1.8
adw_preferences_group_get_separate_rows
Gets whether
self
s rows are separated.
since: 1.6
adw_preferences_group_get_title
Gets the title of
self
adw_preferences_group_remove
Removes a child from
self
adw_preferences_group_set_description
Sets the description for
self
adw_preferences_group_set_header_suffix
Sets the suffix for
self
s header.
since: 1.1
adw_preferences_group_set_separate_rows
Sets whether
self
s rows are separated.
since: 1.6
adw_preferences_group_set_title
Sets the title for
self
Methods inherited from
GtkWidget
(164)
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
(21)
gtk_accessible_announce
Requests the user’s screen reader to announce the given message.
gtk_accessible_get_accessible_id
Retrieves the accessible identifier for the accessible object.
gtk_accessible_get_accessible_parent
Retrieves the accessible parent for an accessible object.
gtk_accessible_get_accessible_role
Retrieves the accessible role of an accessible object.
gtk_accessible_get_at_context
Retrieves the implementation for the given accessible object.
gtk_accessible_get_bounds
Queries the coordinates and dimensions of this accessible.
gtk_accessible_get_first_accessible_child
Retrieves the first accessible child of an accessible object.
gtk_accessible_get_next_accessible_sibling
Retrieves the next accessible sibling of an accessible object.
gtk_accessible_get_platform_state
Queries a platform state, such as focus.
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_set_accessible_parent
Sets the parent and sibling of an accessible object.
gtk_accessible_update_next_accessible_sibling
Updates the next accessible sibling.
gtk_accessible_update_platform_state
Informs ATs that the platform state has changed.
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.
gtk_accessible_update_state_value
Updates an array of accessible states.
Methods inherited from
GtkBuildable
(1)
gtk_buildable_get_buildable_id
Gets the
ID
of the
buildable
object.
Properties
Adw.PreferencesGroup:description
The description for this group of preferences.
Adw.PreferencesGroup:header-suffix
The header suffix widget.
since: 1.1
Adw.PreferencesGroup:separate-rows
Whether to separate rows.
since: 1.6
Adw.PreferencesGroup:title
The title for this group of preferences.
Properties inherited from
GtkWidget
(35)
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
GtkWidget::query-tooltip
signal on
widget
Gtk.Widget:height-request
Overrides 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:limit-events
Makes this widget act like a modal dialog, with respect to
event delivery.
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
Overrides for width request of the widget.
Properties inherited from
GtkAccessible
(1)
Gtk.Accessible:accessible-role
The accessible role of the given
GtkAccessible
implementation.
Signals
Signals inherited from
GtkWidget
(13)
GtkWidget::destroy
Signals that all holders of a reference to the widget should release
the reference that they hold.
GtkWidget::direction-changed
Emitted when the text direction of a widget changes.
GtkWidget::hide
Emitted when
widget
is hidden.
GtkWidget::keynav-failed
Emitted if keyboard navigation fails.
GtkWidget::map
Emitted when
widget
is going to be mapped.
GtkWidget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
GtkWidget::move-focus
Emitted when the focus is moved.
GtkWidget::query-tooltip
Emitted when the widget’s tooltip is about to be shown.
GtkWidget::realize
Emitted when
widget
is associated with a
GdkSurface
GtkWidget::show
Emitted when
widget
is shown.
GtkWidget::state-flags-changed
Emitted when the widget state changes.
GtkWidget::unmap
Emitted when
widget
is going to be unmapped.
GtkWidget::unrealize
Emitted when the
GdkSurface
associated with
widget
is destroyed.
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.
Class structure
struct AdwPreferencesGroupClass {
GtkWidgetClass parent_class;

No description available.
Class members
parent_class: GtkWidgetClass
The parent class.