gi-adwaita-1.0.7: 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.PreferencesDialog

Description

A dialog showing application's preferences.

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

The AdwPreferencesDialog widget presents an application's preferences gathered into pages and groups. The preferences are searchable by the user.

CSS nodes

AdwPreferencesDialog has a main CSS node with the name dialog and the style class .preferences.

Since: 1.5

Synopsis

Exported types

newtype PreferencesDialog Source #

Memory-managed wrapper type.

Constructors

PreferencesDialog (ManagedPtr PreferencesDialog) 

Instances

Instances details
Eq PreferencesDialog Source # 
Instance details

Defined in GI.Adw.Objects.PreferencesDialog

GObject PreferencesDialog Source # 
Instance details

Defined in GI.Adw.Objects.PreferencesDialog

ManagedPtrNewtype PreferencesDialog Source # 
Instance details

Defined in GI.Adw.Objects.PreferencesDialog

TypedObject PreferencesDialog Source # 
Instance details

Defined in GI.Adw.Objects.PreferencesDialog

Methods

glibType :: IO GType

HasParentTypes PreferencesDialog Source # 
Instance details

Defined in GI.Adw.Objects.PreferencesDialog

IsGValue (Maybe PreferencesDialog) Source #

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

Instance details

Defined in GI.Adw.Objects.PreferencesDialog

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes PreferencesDialog Source # 
Instance details

Defined in GI.Adw.Objects.PreferencesDialog

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

class (GObject o, IsDescendantOf PreferencesDialog o) => IsPreferencesDialog o Source #

Type class for types which can be safely cast to PreferencesDialog, for instance with toPreferencesDialog.

Instances

Instances details
(GObject o, IsDescendantOf PreferencesDialog o) => IsPreferencesDialog o Source # 
Instance details

Defined in GI.Adw.Objects.PreferencesDialog

toPreferencesDialog :: (MonadIO m, IsPreferencesDialog o) => o -> m PreferencesDialog Source #

Cast to PreferencesDialog, 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, addBreakpoint, addController, addCssClass, addMnemonicLabel, addTickCallback, addToast, allocate, announce, bindProperty, bindPropertyFull, childFocus, close, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceClose, 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, popSubpage, present, pushSubpage, 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, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.

Getters

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

Setters

setAccessibleParent, setCanClose, setCanFocus, setCanTarget, setChild, setChildVisible, setContentHeight, setContentWidth, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDefaultWidget, setDirection, setFocus, setFocusChild, setFocusOnClick, setFocusable, setFollowsContentSize, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setPresentationMode, setProperty, setReceivesDefault, setSearchEnabled, setSensitive, setSizeRequest, setStateFlags, setTitle, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, setVisiblePage, setVisiblePageName.

add

preferencesDialogAdd Source #

Arguments

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

self: a preferences dialog

-> b

page: the page to add

-> m () 

Adds a preferences page to self.

Since: 1.5

addToast

preferencesDialogAddToast Source #

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesDialog a, IsToast b) 
=> a

self: a preferences dialog

-> b

toast: a toast

-> m () 

Displays toast.

See [methodtoastOverlay.add_toast].

Since: 1.5

getSearchEnabled

preferencesDialogGetSearchEnabled Source #

Arguments

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

self: a preferences dialog

-> m Bool

Returns: whether search is enabled for self.

Gets whether search is enabled for self.

Since: 1.5

getVisiblePage

preferencesDialogGetVisiblePage Source #

Arguments

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

self: a preferences dialog

-> m (Maybe PreferencesPage)

Returns: the visible page

Gets the currently visible page of self.

Since: 1.5

getVisiblePageName

preferencesDialogGetVisiblePageName Source #

Arguments

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

self: a preferences dialog

-> m (Maybe Text)

Returns: the name of the visible page

Gets the name of currently visible page of self.

Since: 1.5

new

preferencesDialogNew Source #

Arguments

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

Returns: the newly created AdwPreferencesDialog

Creates a new AdwPreferencesDialog.

Since: 1.5

popSubpage

preferencesDialogPopSubpage Source #

Arguments

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

self: a preferences dialog

-> m Bool

Returns: TRUE if a page has been popped

Pop the visible page from the subpage stack of self.

Since: 1.5

pushSubpage

preferencesDialogPushSubpage Source #

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesDialog a, IsNavigationPage b) 
=> a

self: a preferences dialog

-> b

page: the subpage

-> m () 

Pushes page onto the subpage stack of self.

The page will be automatically removed when popped.

Since: 1.5

remove

preferencesDialogRemove Source #

Arguments

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

self: a preferences dialog

-> b

page: the page to remove

-> m () 

Removes a page from self.

Since: 1.5

setSearchEnabled

preferencesDialogSetSearchEnabled Source #

Arguments

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

self: a preferences dialog

-> Bool

searchEnabled: whether search is enabled

-> m () 

Sets whether search is enabled for self.

Since: 1.5

setVisiblePage

preferencesDialogSetVisiblePage Source #

Arguments

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

self: a preferences dialog

-> b

page: a page of self

-> m () 

Makes page the visible page of self.

Since: 1.5

setVisiblePageName

preferencesDialogSetVisiblePageName Source #

Arguments

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

self: a preferences dialog

-> Text

name: the name of the page to make visible

-> m () 

Makes the page with the given name visible.

See [propertypreferencesDialog:visible-page].

Since: 1.5

Properties

searchEnabled

Whether search is enabled.

Since: 1.5

constructPreferencesDialogSearchEnabled :: (IsPreferencesDialog o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getPreferencesDialogSearchEnabled :: (MonadIO m, IsPreferencesDialog o) => o -> m Bool Source #

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

get preferencesDialog #searchEnabled

setPreferencesDialogSearchEnabled :: (MonadIO m, IsPreferencesDialog o) => o -> Bool -> m () Source #

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

set preferencesDialog [ #searchEnabled := value ]

visiblePage

The currently visible page.

Since: 1.5

clearPreferencesDialogVisiblePage :: (MonadIO m, IsPreferencesDialog o) => o -> m () Source #

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

clear #visiblePage

constructPreferencesDialogVisiblePage :: (IsPreferencesDialog o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #

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

getPreferencesDialogVisiblePage :: (MonadIO m, IsPreferencesDialog o) => o -> m (Maybe Widget) Source #

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

get preferencesDialog #visiblePage

setPreferencesDialogVisiblePage :: (MonadIO m, IsPreferencesDialog o, IsWidget a) => o -> a -> m () Source #

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

set preferencesDialog [ #visiblePage := value ]

visiblePageName

The name of the currently visible page.

See [propertyadwPreferencesDialog:visible-page].

Since: 1.5

constructPreferencesDialogVisiblePageName :: (IsPreferencesDialog o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getPreferencesDialogVisiblePageName :: (MonadIO m, IsPreferencesDialog o) => o -> m (Maybe Text) Source #

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

get preferencesDialog #visiblePageName

setPreferencesDialogVisiblePageName :: (MonadIO m, IsPreferencesDialog o) => o -> Text -> m () Source #

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

set preferencesDialog [ #visiblePageName := value ]