adw.preferences_group

Module for [PreferencesGroup] class

class PreferencesGroup PreferencesGroupGidBuilder PreferencesGroupGidBuilderImpl

Types 3

classPreferencesGroup : gtk.widget.Widget

A group of preference rows.

An [adw.preferences_group.PreferencesGroup] 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.

AdwPreferencesGroup as GtkBuildable

The [adw.preferences_group.PreferencesGroup] implementation of the [gtk.buildable.Buildable] interface supports adding class@PreferencesRows 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

[adw.preferences_group.PreferencesGroup] has a single CSS node with name preferencesgroup.

Accessibility

[adw.preferences_group.PreferencesGroup] uses the [gtk.types.AccessibleRole.Group] role.

Methods

GType _getGType()

GType _gType() @property

PreferencesGroup self()Returns `this`, for use in `with` statements.

PreferencesGroupGidBuilder builder()Get builder for [adw.preferences_group.PreferencesGroup] Returns: New builder object

string description() @propertyGet `description` property. Returns: The description for this group of preferences.

void description(string propval) @propertySet `description` property. Params: propval = The description for this group of preferences.

gtk.widget.Widget headerSuffix() @propertyGet `headerSuffix` property. Returns: The header suffix widget.

void headerSuffix(gtk.widget.Widget propval) @propertySet `headerSuffix` property. Params: propval = The header suffix widget.

string title() @propertyGet `title` property. Returns: The title for this group of preferences.

void title(string propval) @propertySet `title` property. Params: propval = The title for this group of preferences.

void add(gtk.widget.Widget child)Adds a child to self.

string getDescription()Gets the description of self. Returns: the description of self

gtk.widget.Widget getHeaderSuffix()Gets the suffix for self's header. Returns: the suffix for self's header.

string getTitle()Gets the title of self. Returns: the title of self

void remove(gtk.widget.Widget child)Removes a child from self.

void setDescription(string description = null)Sets the description for self.

void setHeaderSuffix(gtk.widget.Widget suffix = null)Sets the suffix for self's header.

void setTitle(string title)Sets the title for self.

Constructors

this(void * ptr, Flag!"Take" take)

this()Creates a new [adw.preferencesgroup.PreferencesGroup]. Returns: the newly created [adw.preferencesgroup.PreferencesGroup]

classPreferencesGroupGidBuilderImpl(T) : gtk.widget.WidgetGidBuilderImpl!T

Methods

T description(string propval)Set `description` property. Params: propval = The description for this group of preferences. Returns: Builder instance for fluent chaining

T headerSuffix(gtk.widget.Widget propval)Set `headerSuffix` property. Params: propval = The header suffix widget.

T title(string propval)Set `title` property. Params: propval = The title for this group of preferences. Returns: Builder instance for fluent chaining

classPreferencesGroupGidBuilder : PreferencesGroupGidBuilderImpl!PreferencesGroupGidBuilder

Fluent builder for [adw.preferences_group.PreferencesGroup]

Methods

PreferencesGroup build()