adw.preferences_group

Module for [PreferencesGroup] class

class PreferencesGroup PreferencesGroupGidBuilder PreferencesGroupGidBuilderImpl

Types 3

classPreferencesGroup : gtk.widget.Widget

A group of preference rows.

preferences-group

An adw.preferences_group.PreferencesGroup represents a group or tightly related preferences, which in turn are represented by adw.preferences_row.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 adw.preferences_dialog.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 adw.preferences_row.PreferencesRows to the list by omitting "type". If "type" is omitted and the widget isn't a adw.preferences_row.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() static nothrow
GType _gType() @property nothrow
PreferencesGroup self() nothrowReturns `this`, for use in `with` statements.
PreferencesGroupGidBuilder builder() static nothrowGet builder for [adw.preferences_group.PreferencesGroup] Returns: New builder object
string description() @property nothrowGet `description` property. Returns: The description for this group of preferences.
void description(string propval) @property nothrowSet `description` property. Params: propval = The description for this group of preferences.
gtk.widget.Widget headerSuffix() @property nothrowGet `headerSuffix` property. Returns: The header suffix widget.
void headerSuffix(gtk.widget.Widget propval) @property nothrowSet `headerSuffix` property. Params: propval = The header suffix widget.
string title() @property nothrowGet `title` property. Returns: The title for this group of preferences.
void title(string propval) @property nothrowSet `title` property. Params: propval = The title for this group of preferences.
void add(gtk.widget.Widget child) nothrowAdds a child to self.
string getDescription() nothrowGets the description of self. Returns: the description of self
gtk.widget.Widget getHeaderSuffix() nothrowGets the suffix for self's header. Returns: the suffix for self's header.
string getTitle() nothrowGets the title of self. Returns: the title of self
void remove(gtk.widget.Widget child) nothrowRemoves a child from self.
void setDescription(string description = null) nothrowSets the description for self.
void setHeaderSuffix(gtk.widget.Widget suffix = null) nothrowSets the suffix for self's header.
void setTitle(string title) nothrowSets the title for self.
Constructors
this(void * ptr, Flag!"Take" take)
this()Creates a new [adw.preferences_group.PreferencesGroup]. Returns: the newly created [adw.preferences_group.PreferencesGroup]
classPreferencesGroupGidBuilderImpl(T) : gtk.widget.WidgetGidBuilderImpl!T

Fluent builder implementation template for adw.preferences_group.PreferencesGroup

Methods
T description(string propval) nothrowSet `description` property. Params: propval = The description for this group of preferences. Returns: Builder instance for fluent chaining
T headerSuffix(gtk.widget.Widget propval) nothrowSet `headerSuffix` property. Params: propval = The header suffix widget.
T title(string propval) nothrowSet `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() nothrowCreate object from builder. Returns: New object