GI.Adw.Objects.PreferencesWindow

A window to present an application's preferences.

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

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

CSS nodes

AdwPreferencesWindow has a main CSS node with the name window and the style class .preferences.

Exported types

newtype PreferencesWindow

Memory-managed wrapper type.

Constructors

PreferencesWindow (ManagedPtr PreferencesWindow)

Instances

Eq PreferencesWindow

Defined in GI.Adw.Objects.PreferencesWindow

Methods

(==) :: PreferencesWindow -> PreferencesWindow -> Bool

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

GObject PreferencesWindow

Defined in GI.Adw.Objects.PreferencesWindow

ManagedPtrNewtype PreferencesWindow

Defined in GI.Adw.Objects.PreferencesWindow

Methods

toManagedPtr :: PreferencesWindow -> ManagedPtr PreferencesWindow

TypedObject PreferencesWindow

Defined in GI.Adw.Objects.PreferencesWindow

Methods

glibType :: IO GType

HasParentTypes PreferencesWindow

Defined in GI.Adw.Objects.PreferencesWindow

IsGValue (Maybe PreferencesWindow)

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

Defined in GI.Adw.Objects.PreferencesWindow

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes PreferencesWindow

Defined in GI.Adw.Objects.PreferencesWindow

type ParentTypes PreferencesWindow = '[Window, Window, Widget, Object, Accessible, Buildable, ConstraintTarget, Native, Root, ShortcutManager]

class (GObject o, IsDescendantOf PreferencesWindow o) => IsPreferencesWindow o

Type class for types which can be safely cast to PreferencesWindow, for instance with toPreferencesWindow.

Instances

(GObject o, IsDescendantOf PreferencesWindow o) => IsPreferencesWindow o

Defined in GI.Adw.Objects.PreferencesWindow

toPreferencesWindow :: (MonadIO m, IsPreferencesWindow o) => o -> m PreferencesWindow

Cast to PreferencesWindow, 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, addBreakpoint, addController, addCssClass, addMnemonicLabel, addTickCallback, addToast, allocate, announce, bindProperty, bindPropertyFull, childFocus, close, closeSubpage, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, destroy, disposeTemplate, dragCheckThreshold, errorBell, forceFloating, freezeNotify, fullscreen, fullscreenOnMonitor, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasGroup, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isActive, isAncestor, isDrawable, isFloating, isFocus, isFullscreen, isMaximized, isSensitive, isSuspended, isVisible, keynavFailed, listMnemonicLabels, map, maximize, measure, minimize, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, popSubpage, present, presentSubpage, presentWithTime, 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, unfullscreen, unmap, unmaximize, unminimize, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleParent, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getApplication, getAtContext, getBaseline, getBounds, getBuildableId, getCanFocus, getCanNavigateBack, getCanTarget, getChild, getChildVisible, getClipboard, getColor, getContent, getCssClasses, getCssName, getCurrentBreakpoint, getCursor, getData, getDecorated, getDefaultSize, getDefaultWidget, getDeletable, getDestroyWithParent, getDialogs, getDirection, getDisplay, getFirstAccessibleChild, getFirstChild, getFocus, getFocusChild, getFocusOnClick, getFocusVisible, getFocusable, getFontMap, getFontOptions, getFrameClock, getGroup, getHalign, getHandleMenubarAccel, getHasTooltip, getHeight, getHexpand, getHexpandSet, getHideOnClose, getIconName, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMnemonicsVisible, getModal, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPlatformState, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRenderer, getRequestMode, getResizable, getRoot, getScaleFactor, getSearchEnabled, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getSurface, getSurfaceTransform, getTemplateChild, getTitle, getTitlebar, getTooltipMarkup, getTooltipText, getTransientFor, getValign, getVexpand, getVexpandSet, getVisible, getVisibleDialog, getVisiblePage, getVisiblePageName, getWidth.

Setters

setAccessibleParent, setApplication, setCanFocus, setCanNavigateBack, setCanTarget, setChild, setChildVisible, setContent, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDecorated, setDefaultSize, setDefaultWidget, setDeletable, setDestroyWithParent, setDirection, setDisplay, setFocus, setFocusChild, setFocusOnClick, setFocusVisible, setFocusable, setFontMap, setFontOptions, setHalign, setHandleMenubarAccel, setHasTooltip, setHexpand, setHexpandSet, setHideOnClose, setIconName, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setMnemonicsVisible, setModal, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setResizable, setSearchEnabled, setSensitive, setSizeRequest, setStartupId, setStateFlags, setTitle, setTitlebar, setTooltipMarkup, setTooltipText, setTransientFor, setValign, setVexpand, setVexpandSet, setVisible, setVisiblePage, setVisiblePageName.

add

preferencesWindowAdd

Arguments

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

=> a

self: a preferences window

-> b

page: the page to add

-> m ()

Adds a preferences page to self.

addToast

preferencesWindowAddToast

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesWindow a, IsToast b)

=> a

self: a preferences window

-> b

toast: a toast

-> m ()

Displays toast.

See [methodtoastOverlay.add_toast].

closeSubpage

preferencesWindowCloseSubpage

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesWindow a)

=> a

self: a preferences window

-> m ()

Deprecated: (Since version 1.4)Use [methodpreferencesWindow.pop_subpage] instead.

Closes the current subpage.

If there is no presented subpage, this does nothing.

getCanNavigateBack

preferencesWindowGetCanNavigateBack

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesWindow a)

=> a

self: a preferences window

-> m Bool

Returns: whether gestures and shortcuts are enabled.

Deprecated: (Since version 1.4)Use [methodnavigationPage.get_can_pop] instead.

Gets whether gestures and shortcuts for closing subpages are enabled.

getSearchEnabled

preferencesWindowGetSearchEnabled

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesWindow a)

=> a

self: a preferences window

-> m Bool

Returns: whether search is enabled for self.

Gets whether search is enabled for self.

getVisiblePage

preferencesWindowGetVisiblePage

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesWindow a)

=> a

self: a preferences window

-> m (Maybe PreferencesPage)

Returns: the visible page

Gets the currently visible page of self.

getVisiblePageName

preferencesWindowGetVisiblePageName

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesWindow a)

=> a

self: a preferences window

-> m (Maybe Text)

Returns: the name of the visible page

Gets the name of currently visible page of self.

new

preferencesWindowNew

Arguments

:: (HasCallStack, MonadIO m)

=> m PreferencesWindow

Returns: the newly created AdwPreferencesWindow

Creates a new AdwPreferencesWindow.

popSubpage

preferencesWindowPopSubpage

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesWindow a)

=> a

self: a preferences window

-> m Bool

Returns: TRUE if a page has been popped

Pop the visible page from the subpage stack of self.

Since: 1.4

presentSubpage

preferencesWindowPresentSubpage

Arguments

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

=> a

self: a preferences window

-> b

subpage: the subpage

-> m ()

Deprecated: (Since version 1.4)Use [methodpreferencesWindow.push_subpage] instead.

Sets subpage as the window's subpage and opens it.

The transition can be cancelled by the user, in which case visible child will change back to the previously visible child.

pushSubpage

preferencesWindowPushSubpage

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesWindow a, IsNavigationPage b)

=> a

self: a preferences window

-> b

page: the subpage

-> m ()

Pushes page onto the subpage stack of self.

The page will be automatically removed when popped.

Since: 1.4

remove

preferencesWindowRemove

Arguments

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

=> a

self: a preferences window

-> b

page: the page to remove

-> m ()

Removes a page from self.

setCanNavigateBack

preferencesWindowSetCanNavigateBack

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesWindow a)

=> a

self: a preferences window

-> Bool

canNavigateBack: the new value

-> m ()

Deprecated: (Since version 1.4)Use [methodnavigationPage.set_can_pop] instead.Has no effect for subpages added with [methodpreferencesWindow.push_subpage].

Sets whether gestures and shortcuts for closing subpages are enabled.

The supported gestures are:

• One-finger swipe on touchscreens
• Horizontal scrolling on touchpads (usually two-finger swipe)
• Back mouse button

The keyboard back key is also supported, as well as the <kbd>Alt</kbd>+<kbd>←</kbd> shortcut.

For right-to-left locales, gestures and shortcuts are reversed.

setSearchEnabled

preferencesWindowSetSearchEnabled

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesWindow a)

=> a

self: a preferences window

-> Bool

searchEnabled: whether search is enabled

-> m ()

Sets whether search is enabled for self.

setVisiblePage

preferencesWindowSetVisiblePage

Arguments

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

=> a

self: a preferences window

-> b

page: a page of self

-> m ()

Makes page the visible page of self.

setVisiblePageName

preferencesWindowSetVisiblePageName

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesWindow a)

=> a

self: a preferences window

-> Text

name: the name of the page to make visible

-> m ()

Makes the page with the given name visible.

See [propertypreferencesWindow:visible-page].

Properties

canNavigateBack

Whether gestures and shortcuts for closing subpages are enabled.

The supported gestures are:

• One-finger swipe on touchscreens
• Horizontal scrolling on touchpads (usually two-finger swipe)
• Back mouse button

The keyboard back key is also supported, as well as the <kbd>Alt</kbd>+<kbd>←</kbd> shortcut.

For right-to-left locales, gestures and shortcuts are reversed.

constructPreferencesWindowCanNavigateBack :: (IsPreferencesWindow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getPreferencesWindowCanNavigateBack :: (MonadIO m, IsPreferencesWindow o) => o -> m Bool

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

get preferencesWindow #canNavigateBack

setPreferencesWindowCanNavigateBack :: (MonadIO m, IsPreferencesWindow o) => o -> Bool -> m ()

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

set preferencesWindow [ #canNavigateBack := value ]

searchEnabled

Whether search is enabled.

constructPreferencesWindowSearchEnabled :: (IsPreferencesWindow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getPreferencesWindowSearchEnabled :: (MonadIO m, IsPreferencesWindow o) => o -> m Bool

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

get preferencesWindow #searchEnabled

setPreferencesWindowSearchEnabled :: (MonadIO m, IsPreferencesWindow o) => o -> Bool -> m ()

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

set preferencesWindow [ #searchEnabled := value ]

visiblePage

The currently visible page.

clearPreferencesWindowVisiblePage :: (MonadIO m, IsPreferencesWindow o) => o -> m ()

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

clear #visiblePage

constructPreferencesWindowVisiblePage :: (IsPreferencesWindow o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

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

getPreferencesWindowVisiblePage :: (MonadIO m, IsPreferencesWindow o) => o -> m (Maybe Widget)

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

get preferencesWindow #visiblePage

setPreferencesWindowVisiblePage :: (MonadIO m, IsPreferencesWindow o, IsWidget a) => o -> a -> m ()

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

set preferencesWindow [ #visiblePage := value ]

visiblePageName

The name of the currently visible page.

See [propertypreferencesWindow:visible-page].

constructPreferencesWindowVisiblePageName :: (IsPreferencesWindow o, MonadIO m) => Text -> m (GValueConstruct o)

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

getPreferencesWindowVisiblePageName :: (MonadIO m, IsPreferencesWindow o) => o -> m (Maybe Text)

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

get preferencesWindow #visiblePageName

setPreferencesWindowVisiblePageName :: (MonadIO m, IsPreferencesWindow o) => o -> Text -> m ()

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

set preferencesWindow [ #visiblePageName := value ]