Adw.PreferencesGroup – libadwaita-1 – Vala Binding Reference

Description:

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

A group of preference rows.

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

The [property@PreferencesGroup:separate-rows] property can be used to separate the rows within the group, same as when using the [ `.boxed-list-separate`](style-classes.html#boxed-lists-cards) style class instead of `.boxed-list`.

AdwPreferencesGroup as GtkBuildable

The `AdwPreferencesGroup` implementation of the [iface@Gtk.Buildable] 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 [enum@Gtk.AccessibleRole.group] role.

Namespace: Adw

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 bool separate_rows { get; set; }

Whether to separate rows.

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 void bind_model (ListModel? model, owned ListBoxCreateWidgetFunc? create_row_func)

Binds model 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 Widget? get_row (uint index)

Gets the row at index.

public bool get_separate_rows ()

Gets whether this's rows are separated.

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_separate_rows (bool separate_rows)

Sets whether this's rows are separated.

public void set_title (string title)

Sets the title for this.

Inherited Members:

PreferencesGroup

Object Hierarchy: