GI.Adw.Objects.PreferencesPage

A page from [classpreferencesWindow].

<picture> <source srcset="preferences-page-dark.png" media="(prefers-color-scheme: dark)"> <img src="preferences-page.png" alt="preferences-page"> </picture>

The AdwPreferencesPage widget gathers preferences groups into a single page of a preferences window.

CSS nodes

AdwPreferencesPage has a single CSS node with name preferencespage.

Accessibility

AdwPreferencesPage uses the GTK_ACCESSIBLE_ROLE_GROUP role.

Exported types

newtype PreferencesPage

Memory-managed wrapper type.

Constructors

PreferencesPage (ManagedPtr PreferencesPage)

Instances

Eq PreferencesPage

Defined in GI.Adw.Objects.PreferencesPage

Methods

(==) :: PreferencesPage -> PreferencesPage -> Bool

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

GObject PreferencesPage

Defined in GI.Adw.Objects.PreferencesPage

ManagedPtrNewtype PreferencesPage

Defined in GI.Adw.Objects.PreferencesPage

Methods

toManagedPtr :: PreferencesPage -> ManagedPtr PreferencesPage

TypedObject PreferencesPage

Defined in GI.Adw.Objects.PreferencesPage

Methods

glibType :: IO GType

HasParentTypes PreferencesPage

Defined in GI.Adw.Objects.PreferencesPage

IsGValue (Maybe PreferencesPage)

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

Defined in GI.Adw.Objects.PreferencesPage

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes PreferencesPage

Defined in GI.Adw.Objects.PreferencesPage

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

class (GObject o, IsDescendantOf PreferencesPage o) => IsPreferencesPage o

Type class for types which can be safely cast to PreferencesPage, for instance with toPreferencesPage.

Instances

(GObject o, IsDescendantOf PreferencesPage o) => IsPreferencesPage o

Defined in GI.Adw.Objects.PreferencesPage

toPreferencesPage :: (MonadIO m, IsPreferencesPage o) => o -> m PreferencesPage

Cast to PreferencesPage, 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, scrollToTop, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.

Getters

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

Setters

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

add

preferencesPageAdd

Arguments

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

=> a

self: a preferences page

-> b

group: the group to add

-> m ()

Adds a preferences group to self.

getIconName

preferencesPageGetIconName

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a)

=> a

self: a preferences page

-> m (Maybe Text)

Returns: the icon name for self

Gets the icon name for self.

getName

preferencesPageGetName

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a)

=> a

self: a preferences page

-> m (Maybe Text)

Returns: the name of self

Gets the name of self.

getTitle

preferencesPageGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a)

=> a

self: a preferences page

-> m Text

Returns: the title of self.

Gets the title of self.

getUseUnderline

preferencesPageGetUseUnderline

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a)

=> a

self: a preferences page

-> m Bool

Returns: whether an embedded underline in the title indicates a mnemonic

Gets whether an embedded underline in the title indicates a mnemonic.

new

preferencesPageNew

Arguments

:: (HasCallStack, MonadIO m)

=> m PreferencesPage

Returns: the newly created AdwPreferencesPage

Creates a new AdwPreferencesPage.

remove

preferencesPageRemove

Arguments

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

=> a

self: a preferences page

-> b

group: the group to remove

-> m ()

Removes a group from self.

scrollToTop

preferencesPageScrollToTop

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a)

=> a

self: a preferences page

-> m ()

Scrolls the scrolled window of self to the top.

Since: 1.3

setIconName

preferencesPageSetIconName

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a)

=> a

self: a preferences page

-> Maybe Text

iconName: the icon name

-> m ()

Sets the icon name for self.

setName

preferencesPageSetName

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a)

=> a

self: a preferences page

-> Maybe Text

name: the name

-> m ()

Sets the name of self.

setTitle

preferencesPageSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a)

=> a

self: a preferences page

-> Text

title: the title

-> m ()

Sets the title of self.

setUseUnderline

preferencesPageSetUseUnderline

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a)

=> a

self: a preferences page

-> Bool

useUnderline: TRUE if underlines in the text indicate mnemonics

-> m ()

Sets whether an embedded underline in the title indicates a mnemonic.

Properties

iconName

The icon name for this page.

clearPreferencesPageIconName :: (MonadIO m, IsPreferencesPage o) => o -> m ()

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

clear #iconName

constructPreferencesPageIconName :: (IsPreferencesPage o, MonadIO m) => Text -> m (GValueConstruct o)

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

getPreferencesPageIconName :: (MonadIO m, IsPreferencesPage o) => o -> m (Maybe Text)

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

get preferencesPage #iconName

setPreferencesPageIconName :: (MonadIO m, IsPreferencesPage o) => o -> Text -> m ()

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

set preferencesPage [ #iconName := value ]

name

The name of this page.

clearPreferencesPageName :: (MonadIO m, IsPreferencesPage o) => o -> m ()

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

clear #name

constructPreferencesPageName :: (IsPreferencesPage o, MonadIO m) => Text -> m (GValueConstruct o)

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

getPreferencesPageName :: (MonadIO m, IsPreferencesPage o) => o -> m (Maybe Text)

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

get preferencesPage #name

setPreferencesPageName :: (MonadIO m, IsPreferencesPage o) => o -> Text -> m ()

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

set preferencesPage [ #name := value ]

title

The title for this page.

constructPreferencesPageTitle :: (IsPreferencesPage 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.

getPreferencesPageTitle :: (MonadIO m, IsPreferencesPage o) => o -> m Text

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

get preferencesPage #title

setPreferencesPageTitle :: (MonadIO m, IsPreferencesPage o) => o -> Text -> m ()

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

set preferencesPage [ #title := value ]

useUnderline

Whether an embedded underline in the title indicates a mnemonic.

constructPreferencesPageUseUnderline :: (IsPreferencesPage o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getPreferencesPageUseUnderline :: (MonadIO m, IsPreferencesPage o) => o -> m Bool

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

get preferencesPage #useUnderline

setPreferencesPageUseUnderline :: (MonadIO m, IsPreferencesPage o) => o -> Bool -> m ()

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

set preferencesPage [ #useUnderline := value ]