adwaita/org.gtkkn.bindings.adw/PreferencesGroup

PreferencesGroup

open class PreferencesGroup(pointer: <Error class: unknown class><<Error class: unknown class>>)

A group of preference rows.

preferences-group

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 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@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

AdwPreferencesGroup has a single CSS node with name preferencesgroup.

Accessibility

AdwPreferencesGroup uses the GTK_ACCESSIBLE_ROLE_GROUP role.

Constructors

PreferencesGroup

constructor()

Creates a new AdwPreferencesGroup.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

object Companion

Properties

adwPreferencesGroupPointer

val adwPreferencesGroupPointer: <Error class: unknown class><<Error class: unknown class>>

open var description: String?

The description for this group of preferences.

gtkAccessiblePointer

open val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>

gtkBuildablePointer

open val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkConstraintTargetPointer

open val gtkConstraintTargetPointer: <Error class: unknown class><<Error class: unknown class>>

open var headerSuffix: <Error class: unknown class>?

The header suffix widget.

open var separateRows: Boolean

Whether to separate rows.

open var title: String

The title for this group of preferences.

Functions

open fun add(child: <Error class: unknown class>)

Adds a child to @self.

open fun getDescription(): String?

Gets the description of @self.

getHeaderSuffix

open fun getHeaderSuffix(): <Error class: unknown class>?

Gets the suffix for @self's header.

getSeparateRows

open fun getSeparateRows(): Boolean

Gets whether @self's rows are separated.

open fun getTitle(): String

Gets the title of @self.

open fun remove(child: <Error class: unknown class>)

Removes a child from @self.

open fun setDescription(description: String? = null)

Sets the description for @self.

setHeaderSuffix

open fun setHeaderSuffix(suffix: <Error class: unknown class>? = null)

Sets the suffix for @self's header.

setSeparateRows

open fun setSeparateRows(separateRows: Boolean)

Sets whether @self's rows are separated.

open fun setTitle(title: String)

Sets the title for @self.