Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Since: 1.0
Synopsis
- newtype PreferencesPage = PreferencesPage (ManagedPtr PreferencesPage)
- class (GObject o, IsDescendantOf PreferencesPage o) => IsPreferencesPage o
- toPreferencesPage :: (MonadIO m, IsPreferencesPage o) => o -> m PreferencesPage
- preferencesPageAdd :: (HasCallStack, MonadIO m, IsPreferencesPage a, IsPreferencesGroup b) => a -> b -> m ()
- preferencesPageGetIconName :: (HasCallStack, MonadIO m, IsPreferencesPage a) => a -> m (Maybe Text)
- preferencesPageGetName :: (HasCallStack, MonadIO m, IsPreferencesPage a) => a -> m (Maybe Text)
- preferencesPageGetTitle :: (HasCallStack, MonadIO m, IsPreferencesPage a) => a -> m Text
- preferencesPageGetUseUnderline :: (HasCallStack, MonadIO m, IsPreferencesPage a) => a -> m Bool
- preferencesPageNew :: (HasCallStack, MonadIO m) => m PreferencesPage
- preferencesPageRemove :: (HasCallStack, MonadIO m, IsPreferencesPage a, IsPreferencesGroup b) => a -> b -> m ()
- preferencesPageSetIconName :: (HasCallStack, MonadIO m, IsPreferencesPage a) => a -> Maybe Text -> m ()
- preferencesPageSetName :: (HasCallStack, MonadIO m, IsPreferencesPage a) => a -> Maybe Text -> m ()
- preferencesPageSetTitle :: (HasCallStack, MonadIO m, IsPreferencesPage a) => a -> Text -> m ()
- preferencesPageSetUseUnderline :: (HasCallStack, MonadIO m, IsPreferencesPage a) => a -> Bool -> m ()
- clearPreferencesPageIconName :: (MonadIO m, IsPreferencesPage o) => o -> m ()
- constructPreferencesPageIconName :: (IsPreferencesPage o, MonadIO m) => Text -> m (GValueConstruct o)
- getPreferencesPageIconName :: (MonadIO m, IsPreferencesPage o) => o -> m (Maybe Text)
- setPreferencesPageIconName :: (MonadIO m, IsPreferencesPage o) => o -> Text -> m ()
- clearPreferencesPageName :: (MonadIO m, IsPreferencesPage o) => o -> m ()
- constructPreferencesPageName :: (IsPreferencesPage o, MonadIO m) => Text -> m (GValueConstruct o)
- getPreferencesPageName :: (MonadIO m, IsPreferencesPage o) => o -> m (Maybe Text)
- setPreferencesPageName :: (MonadIO m, IsPreferencesPage o) => o -> Text -> m ()
- constructPreferencesPageTitle :: (IsPreferencesPage o, MonadIO m) => Text -> m (GValueConstruct o)
- getPreferencesPageTitle :: (MonadIO m, IsPreferencesPage o) => o -> m Text
- setPreferencesPageTitle :: (MonadIO m, IsPreferencesPage o) => o -> Text -> m ()
- constructPreferencesPageUseUnderline :: (IsPreferencesPage o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPreferencesPageUseUnderline :: (MonadIO m, IsPreferencesPage o) => o -> m Bool
- setPreferencesPageUseUnderline :: (MonadIO m, IsPreferencesPage o) => o -> Bool -> m ()
Exported types
newtype PreferencesPage Source #
Memory-managed wrapper type.
PreferencesPage (ManagedPtr PreferencesPage) |
Instances
class (GObject o, IsDescendantOf PreferencesPage o) => IsPreferencesPage o Source #
Type class for types which can be safely cast to PreferencesPage
, for instance with toPreferencesPage
.
Instances
(GObject o, IsDescendantOf PreferencesPage o) => IsPreferencesPage o Source # | |
Defined in GI.Adw.Objects.PreferencesPage |
toPreferencesPage :: (MonadIO m, IsPreferencesPage o) => o -> m PreferencesPage Source #
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, 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, getDirection, getDisplay, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getIconName, 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, getUseUnderline, getValign, getVexpand, getVexpandSet, getVisible, getWidth.
Setters
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
:: (HasCallStack, MonadIO m, IsPreferencesPage a, IsPreferencesGroup b) | |
=> a |
|
-> b |
|
-> m () |
Adds a preferences group to self
.
Since: 1.0
getIconName
preferencesPageGetIconName Source #
:: (HasCallStack, MonadIO m, IsPreferencesPage a) | |
=> a |
|
-> m (Maybe Text) | Returns: the icon name for |
Gets the icon name for self
.
Since: 1.0
getName
preferencesPageGetName Source #
:: (HasCallStack, MonadIO m, IsPreferencesPage a) | |
=> a |
|
-> m (Maybe Text) | Returns: the name of |
Gets the name of self
.
Since: 1.0
getTitle
preferencesPageGetTitle Source #
:: (HasCallStack, MonadIO m, IsPreferencesPage a) | |
=> a |
|
-> m Text | Returns: the title of |
Gets the title of self
.
Since: 1.0
getUseUnderline
preferencesPageGetUseUnderline Source #
:: (HasCallStack, MonadIO m, IsPreferencesPage a) | |
=> a |
|
-> m Bool | Returns: whether an embedded underline in the title indicates a mnemonic |
Gets whether an embedded underline in the title indicates a mnemonic.
Since: 1.0
new
:: (HasCallStack, MonadIO m) | |
=> m PreferencesPage | Returns: the newly created |
Creates a new AdwPreferencesPage
.
Since: 1.0
remove
preferencesPageRemove Source #
:: (HasCallStack, MonadIO m, IsPreferencesPage a, IsPreferencesGroup b) | |
=> a |
|
-> b |
|
-> m () |
Removes a group from self
.
Since: 1.0
setIconName
preferencesPageSetIconName Source #
:: (HasCallStack, MonadIO m, IsPreferencesPage a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Sets the icon name for self
.
Since: 1.0
setName
preferencesPageSetName Source #
:: (HasCallStack, MonadIO m, IsPreferencesPage a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Sets the name of self
.
Since: 1.0
setTitle
preferencesPageSetTitle Source #
:: (HasCallStack, MonadIO m, IsPreferencesPage a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the title of self
.
Since: 1.0
setUseUnderline
preferencesPageSetUseUnderline Source #
:: (HasCallStack, MonadIO m, IsPreferencesPage a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether an embedded underline in the title indicates a mnemonic.
Since: 1.0
Properties
iconName
The icon name for this page.
Since: 1.0
clearPreferencesPageIconName :: (MonadIO m, IsPreferencesPage o) => o -> m () Source #
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) Source #
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) Source #
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 () Source #
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.
Since: 1.0
clearPreferencesPageName :: (MonadIO m, IsPreferencesPage o) => o -> m () Source #
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) Source #
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) Source #
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 () Source #
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.
Since: 1.0
constructPreferencesPageTitle :: (IsPreferencesPage o, MonadIO m) => Text -> m (GValueConstruct o) Source #
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 Source #
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 () Source #
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.
Since: 1.0
constructPreferencesPageUseUnderline :: (IsPreferencesPage o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
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 Source #
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 () Source #
Set the value of the “use-underline
” property.
When overloading is enabled, this is equivalent to
set
preferencesPage [ #useUnderline:=
value ]