Adw.PreferencesGroup – libadwaita-1 Reference Manual

PreferencesGroup

Object Hierarchy:

Description:

[ CCode ( type_id = "adw_preferences_group_get_type ()" ) ]
[ Version ( since = "1.0" ) ]
public class PreferencesGroup : Widget, Accessible, Buildable, ConstraintTarget

A group of preference rows.

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

An `AdwPreferencesGroup` represents a group or tightly related preferences, which in turn are represented by [class@PreferencesRow].

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 [ class@PreferencesWindow] to let the user look for a preference.

AdwPreferencesGroup as GtkBuildable

The `AdwPreferencesGroup` implementation of the [[email protected]] interface supports adding [class@PreferencesRow]s to the list by omitting "type". If "type" is omitted and the widget isn't a [class@PreferencesRow] 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`.

Accessibility

`AdwPreferencesGroup` uses the `GTK_ACCESSIBLE_ROLE_GROUP` role.

Namespace: Adw

Package: libadwaita-1

Content:

Properties:

public string description { get; set; }
The description for this group of preferences.
public Widget header_suffix { get; set; }
The header suffix widget.
public string title { get; set; }
The title for this group of preferences.

Creation methods:

public PreferencesGroup ()
Creates a new `AdwPreferencesGroup`.

Methods:

public void add (Widget child)
Adds a child to this.
public unowned string? get_description ()
Gets the description of this.
public unowned Widget? get_header_suffix ()
Gets the suffix for this's header.
public unowned string get_title ()
Gets the title of this.
public void remove (Widget child)
Removes a child from this.
public void set_description (string? description)
Sets the description for this.
public void set_header_suffix (Widget? suffix)
Sets the suffix for this's header.
public void set_title (string title)
Sets the title for this.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref

All known members inherited from interface Gtk.Accessible

accessible_role
get_accessible_role
reset_property
reset_relation

reset_state
update_property
update_property_value
update_relation

update_relation_value
update_state
update_state_value

All known members inherited from interface Gtk.Buildable

add_child
custom_finished
custom_tag_end
custom_tag_start

get_buildable_id
get_id
get_internal_child

parser_finished
set_buildable_property
set_id

2022 vala-language.org