gi-adwaita-1.0.1: Adwaita bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Adw.Objects.PreferencesPage

Description

A page from PreferencesWindow.

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.

Since: 1.0

Synopsis

Exported types

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

Instances details
(GObject o, IsDescendantOf PreferencesPage o) => IsPreferencesPage o Source # 
Instance details

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

Expand

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

preferencesPageAdd Source #

Arguments

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

self: a AdwPreferencesPage

-> b

group: the group to add

-> m () 

Adds a preferences group to self.

Since: 1.0

getIconName

preferencesPageGetIconName Source #

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a) 
=> a

self: a AdwPreferencesPage

-> m (Maybe Text)

Returns: the icon name for self

Gets the icon name for self.

Since: 1.0

getName

preferencesPageGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a) 
=> a

self: a AdwPreferencesPage

-> m (Maybe Text)

Returns: the name of self

Gets the name of self.

Since: 1.0

getTitle

preferencesPageGetTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a) 
=> a

self: a AdwPreferencesPage

-> m Text

Returns: the title of self.

Gets the title of self.

Since: 1.0

getUseUnderline

preferencesPageGetUseUnderline Source #

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a) 
=> a

self: a AdwPreferencesPage

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

preferencesPageNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m PreferencesPage

Returns: the newly created AdwPreferencesPage

Creates a new AdwPreferencesPage.

Since: 1.0

remove

preferencesPageRemove Source #

Arguments

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

self: a AdwPreferencesPage

-> b

group: the group to remove

-> m () 

Removes a group from self.

Since: 1.0

setIconName

preferencesPageSetIconName Source #

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a) 
=> a

self: a AdwPreferencesPage

-> Maybe Text

iconName: the icon name

-> m () 

Sets the icon name for self.

Since: 1.0

setName

preferencesPageSetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a) 
=> a

self: a AdwPreferencesPage

-> Maybe Text

name: the name

-> m () 

Sets the name of self.

Since: 1.0

setTitle

preferencesPageSetTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a) 
=> a

self: a AdwPreferencesPage

-> Text

title: the title

-> m () 

Sets the title of self.

Since: 1.0

setUseUnderline

preferencesPageSetUseUnderline Source #

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesPage a) 
=> a

self: a AdwPreferencesPage

-> Bool

useUnderline: TRUE if underlines in the text indicate mnemonics

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