GI.Adw.Objects.PreferencesGroup

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 [classpreferencesRow].

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

AdwPreferencesGroup as GtkBuildable

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

Since: 1.0

Exported types

newtype PreferencesGroup

Memory-managed wrapper type.

Constructors

PreferencesGroup (ManagedPtr PreferencesGroup)

Instances

Eq PreferencesGroup

Defined in GI.Adw.Objects.PreferencesGroup

Methods

(==) :: PreferencesGroup -> PreferencesGroup -> Bool

(/=) :: PreferencesGroup -> PreferencesGroup -> Bool

GObject PreferencesGroup

Defined in GI.Adw.Objects.PreferencesGroup

ManagedPtrNewtype PreferencesGroup

Defined in GI.Adw.Objects.PreferencesGroup

Methods

toManagedPtr :: PreferencesGroup -> ManagedPtr PreferencesGroup

TypedObject PreferencesGroup

Defined in GI.Adw.Objects.PreferencesGroup

Methods

glibType :: IO GType

HasParentTypes PreferencesGroup

Defined in GI.Adw.Objects.PreferencesGroup

IsGValue (Maybe PreferencesGroup)

Convert PreferencesGroup to and from GValue. See toGValue and fromGValue.

Defined in GI.Adw.Objects.PreferencesGroup

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe PreferencesGroup -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe PreferencesGroup)

type ParentTypes PreferencesGroup

Defined in GI.Adw.Objects.PreferencesGroup

type ParentTypes PreferencesGroup = '[Widget, Object, Accessible, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf PreferencesGroup o) => IsPreferencesGroup o

Type class for types which can be safely cast to PreferencesGroup, for instance with toPreferencesGroup.

Instances

(GObject o, IsDescendantOf PreferencesGroup o) => IsPreferencesGroup o

Defined in GI.Adw.Objects.PreferencesGroup

toPreferencesGroup :: (MonadIO m, IsPreferencesGroup o) => o -> m PreferencesGroup

Cast to PreferencesGroup, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

actionSetEnabled, activate, activateAction, activateDefault, add, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, remove, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDescription, getDirection, getDisplay, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeaderSuffix, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTitle, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDescription, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHeaderSuffix, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTitle, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.

add

preferencesGroupAdd

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesGroup a, IsWidget b)

=> a

self: a preferences group

-> b

child: the widget to add

-> m ()

Adds a child to self.

Since: 1.0

getDescription

preferencesGroupGetDescription

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesGroup a)

=> a

self: a preferences group

-> m (Maybe Text)

Returns: the description of self

Gets the description of self.

Since: 1.0

getHeaderSuffix

preferencesGroupGetHeaderSuffix

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesGroup a)

=> a

self: a AdwPreferencesGroup

-> m (Maybe Widget)

Returns: the suffix for self's header.

Gets the suffix for self's header.

Since: 1.1

getTitle

preferencesGroupGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesGroup a)

=> a

self: a preferences group

-> m Text

Returns: the title of self

Gets the title of self.

Since: 1.0

new

preferencesGroupNew

Arguments

:: (HasCallStack, MonadIO m)

=> m PreferencesGroup

Returns: the newly created AdwPreferencesGroup

Creates a new AdwPreferencesGroup.

Since: 1.0

remove

preferencesGroupRemove

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesGroup a, IsWidget b)

=> a

self: a preferences group

-> b

child: the child to remove

-> m ()

Removes a child from self.

Since: 1.0

setDescription

preferencesGroupSetDescription

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesGroup a)

=> a

self: a preferences group

-> Maybe Text

description: the description

-> m ()

Sets the description for self.

Since: 1.0

setHeaderSuffix

preferencesGroupSetHeaderSuffix

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesGroup a, IsWidget b)

=> a

self: a AdwPreferencesGroup

-> Maybe b

suffix: the suffix to set

-> m ()

Sets the suffix for self's header.

Displayed above the list, next to the title and description.

Suffixes are commonly used to show a button or a spinner for the whole group.

Since: 1.1

setTitle

preferencesGroupSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesGroup a)

=> a

self: a preferences group

-> Text

title: the title

-> m ()

Sets the title for self.

Since: 1.0

Properties

description

The description for this group of preferences.

Since: 1.0

clearPreferencesGroupDescription :: (MonadIO m, IsPreferencesGroup o) => o -> m ()

Set the value of the “description” property to Nothing. When overloading is enabled, this is equivalent to

clear #description

constructPreferencesGroupDescription :: (IsPreferencesGroup o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “description” property. This is rarely needed directly, but it is used by new.

getPreferencesGroupDescription :: (MonadIO m, IsPreferencesGroup o) => o -> m (Maybe Text)

Get the value of the “description” property. When overloading is enabled, this is equivalent to

get preferencesGroup #description

setPreferencesGroupDescription :: (MonadIO m, IsPreferencesGroup o) => o -> Text -> m ()

Set the value of the “description” property. When overloading is enabled, this is equivalent to

set preferencesGroup [ #description := value ]

headerSuffix

The header suffix widget.

Displayed above the list, next to the title and description.

Suffixes are commonly used to show a button or a spinner for the whole group.

Since: 1.1

clearPreferencesGroupHeaderSuffix :: (MonadIO m, IsPreferencesGroup o) => o -> m ()

Set the value of the “header-suffix” property to Nothing. When overloading is enabled, this is equivalent to

clear #headerSuffix

constructPreferencesGroupHeaderSuffix :: (IsPreferencesGroup o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “header-suffix” property. This is rarely needed directly, but it is used by new.

getPreferencesGroupHeaderSuffix :: (MonadIO m, IsPreferencesGroup o) => o -> m (Maybe Widget)

Get the value of the “header-suffix” property. When overloading is enabled, this is equivalent to

get preferencesGroup #headerSuffix

setPreferencesGroupHeaderSuffix :: (MonadIO m, IsPreferencesGroup o, IsWidget a) => o -> a -> m ()

Set the value of the “header-suffix” property. When overloading is enabled, this is equivalent to

set preferencesGroup [ #headerSuffix := value ]

title

The title for this group of preferences.

Since: 1.0

constructPreferencesGroupTitle :: (IsPreferencesGroup o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “title” property. This is rarely needed directly, but it is used by new.

getPreferencesGroupTitle :: (MonadIO m, IsPreferencesGroup o) => o -> m Text

Get the value of the “title” property. When overloading is enabled, this is equivalent to

get preferencesGroup #title

setPreferencesGroupTitle :: (MonadIO m, IsPreferencesGroup o) => o -> Text -> m ()

Set the value of the “title” property. When overloading is enabled, this is equivalent to

set preferencesGroup [ #title := value ]