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 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
.
Since: 1.0
Synopsis
- newtype PreferencesWindow = PreferencesWindow (ManagedPtr PreferencesWindow)
- class (GObject o, IsDescendantOf PreferencesWindow o) => IsPreferencesWindow o
- toPreferencesWindow :: (MonadIO m, IsPreferencesWindow o) => o -> m PreferencesWindow
- preferencesWindowAdd :: (HasCallStack, MonadIO m, IsPreferencesWindow a, IsPreferencesPage b) => a -> b -> m ()
- preferencesWindowAddToast :: (HasCallStack, MonadIO m, IsPreferencesWindow a, IsToast b) => a -> b -> m ()
- preferencesWindowCloseSubpage :: (HasCallStack, MonadIO m, IsPreferencesWindow a) => a -> m ()
- preferencesWindowGetCanNavigateBack :: (HasCallStack, MonadIO m, IsPreferencesWindow a) => a -> m Bool
- preferencesWindowGetSearchEnabled :: (HasCallStack, MonadIO m, IsPreferencesWindow a) => a -> m Bool
- preferencesWindowGetVisiblePage :: (HasCallStack, MonadIO m, IsPreferencesWindow a) => a -> m (Maybe PreferencesPage)
- preferencesWindowGetVisiblePageName :: (HasCallStack, MonadIO m, IsPreferencesWindow a) => a -> m (Maybe Text)
- preferencesWindowNew :: (HasCallStack, MonadIO m) => m PreferencesWindow
- preferencesWindowPresentSubpage :: (HasCallStack, MonadIO m, IsPreferencesWindow a, IsWidget b) => a -> b -> m ()
- preferencesWindowRemove :: (HasCallStack, MonadIO m, IsPreferencesWindow a, IsPreferencesPage b) => a -> b -> m ()
- preferencesWindowSetCanNavigateBack :: (HasCallStack, MonadIO m, IsPreferencesWindow a) => a -> Bool -> m ()
- preferencesWindowSetSearchEnabled :: (HasCallStack, MonadIO m, IsPreferencesWindow a) => a -> Bool -> m ()
- preferencesWindowSetVisiblePage :: (HasCallStack, MonadIO m, IsPreferencesWindow a, IsPreferencesPage b) => a -> b -> m ()
- preferencesWindowSetVisiblePageName :: (HasCallStack, MonadIO m, IsPreferencesWindow a) => a -> Text -> m ()
- constructPreferencesWindowCanNavigateBack :: (IsPreferencesWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPreferencesWindowCanNavigateBack :: (MonadIO m, IsPreferencesWindow o) => o -> m Bool
- setPreferencesWindowCanNavigateBack :: (MonadIO m, IsPreferencesWindow o) => o -> Bool -> m ()
- constructPreferencesWindowSearchEnabled :: (IsPreferencesWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPreferencesWindowSearchEnabled :: (MonadIO m, IsPreferencesWindow o) => o -> m Bool
- setPreferencesWindowSearchEnabled :: (MonadIO m, IsPreferencesWindow o) => o -> Bool -> m ()
- clearPreferencesWindowVisiblePage :: (MonadIO m, IsPreferencesWindow o) => o -> m ()
- constructPreferencesWindowVisiblePage :: (IsPreferencesWindow o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
- getPreferencesWindowVisiblePage :: (MonadIO m, IsPreferencesWindow o) => o -> m (Maybe Widget)
- setPreferencesWindowVisiblePage :: (MonadIO m, IsPreferencesWindow o, IsWidget a) => o -> a -> m ()
- constructPreferencesWindowVisiblePageName :: (IsPreferencesWindow o, MonadIO m) => Text -> m (GValueConstruct o)
- getPreferencesWindowVisiblePageName :: (MonadIO m, IsPreferencesWindow o) => o -> m (Maybe Text)
- setPreferencesWindowVisiblePageName :: (MonadIO m, IsPreferencesWindow o) => o -> Text -> m ()
Exported types
newtype PreferencesWindow Source #
Memory-managed wrapper type.
PreferencesWindow (ManagedPtr PreferencesWindow) |
Instances
class (GObject o, IsDescendantOf PreferencesWindow o) => IsPreferencesWindow o Source #
Type class for types which can be safely cast to PreferencesWindow
, for instance with toPreferencesWindow
.
Instances
(GObject o, IsDescendantOf PreferencesWindow o) => IsPreferencesWindow o Source # | |
Defined in GI.Adw.Objects.PreferencesWindow |
toPreferencesWindow :: (MonadIO m, IsPreferencesWindow o) => o -> m PreferencesWindow Source #
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, addController, addCssClass, addMnemonicLabel, addTickCallback, addToast, allocate, 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, isVisible, keynavFailed, listMnemonicLabels, map, maximize, measure, minimize, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, present, presentSubpage, presentWithTime, 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, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getApplication, getBuildableId, getCanFocus, getCanNavigateBack, getCanTarget, getChild, getChildVisible, getClipboard, getContent, getCssClasses, getCssName, getCursor, getData, getDecorated, getDefaultSize, getDefaultWidget, getDeletable, getDestroyWithParent, getDirection, getDisplay, 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, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, 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, getVisiblePage, getVisiblePageName, getWidth.
Setters
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
:: (HasCallStack, MonadIO m, IsPreferencesWindow a, IsPreferencesPage b) | |
=> a |
|
-> b |
|
-> m () |
Adds a preferences page to self
.
Since: 1.0
addToast
preferencesWindowAddToast Source #
:: (HasCallStack, MonadIO m, IsPreferencesWindow a, IsToast b) | |
=> a |
|
-> b |
|
-> m () |
Displays toast
.
See [methodtoastOverlay
.add_toast].
Since: 1.0
closeSubpage
preferencesWindowCloseSubpage Source #
:: (HasCallStack, MonadIO m, IsPreferencesWindow a) | |
=> a |
|
-> m () |
Closes the current subpage.
If there is no presented subpage, this does nothing.
Since: 1.0
getCanNavigateBack
preferencesWindowGetCanNavigateBack Source #
:: (HasCallStack, MonadIO m, IsPreferencesWindow a) | |
=> a |
|
-> m Bool | Returns: whether gestures and shortcuts are enabled. |
Gets whether gestures and shortcuts for closing subpages are enabled.
Since: 1.0
getSearchEnabled
preferencesWindowGetSearchEnabled Source #
:: (HasCallStack, MonadIO m, IsPreferencesWindow a) | |
=> a |
|
-> m Bool | Returns: whether search is enabled for |
Gets whether search is enabled for self
.
Since: 1.0
getVisiblePage
preferencesWindowGetVisiblePage Source #
:: (HasCallStack, MonadIO m, IsPreferencesWindow a) | |
=> a |
|
-> m (Maybe PreferencesPage) | Returns: the visible page |
Gets the currently visible page of self
.
Since: 1.0
getVisiblePageName
preferencesWindowGetVisiblePageName Source #
:: (HasCallStack, MonadIO m, IsPreferencesWindow a) | |
=> a |
|
-> m (Maybe Text) | Returns: the name of the visible page |
Gets the name of currently visible page of self
.
Since: 1.0
new
:: (HasCallStack, MonadIO m) | |
=> m PreferencesWindow | Returns: the newly created |
Creates a new AdwPreferencesWindow
.
Since: 1.0
presentSubpage
preferencesWindowPresentSubpage Source #
:: (HasCallStack, MonadIO m, IsPreferencesWindow a, IsWidget b) | |
=> a |
|
-> b |
|
-> m () |
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.
Since: 1.0
remove
preferencesWindowRemove Source #
:: (HasCallStack, MonadIO m, IsPreferencesWindow a, IsPreferencesPage b) | |
=> a |
|
-> b |
|
-> m () |
Removes a page from self
.
Since: 1.0
setCanNavigateBack
preferencesWindowSetCanNavigateBack Source #
:: (HasCallStack, MonadIO m, IsPreferencesWindow a) | |
=> a |
|
-> Bool |
|
-> m () |
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.
Since: 1.0
setSearchEnabled
preferencesWindowSetSearchEnabled Source #
:: (HasCallStack, MonadIO m, IsPreferencesWindow a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether search is enabled for self
.
Since: 1.0
setVisiblePage
preferencesWindowSetVisiblePage Source #
:: (HasCallStack, MonadIO m, IsPreferencesWindow a, IsPreferencesPage b) | |
=> a |
|
-> b |
|
-> m () |
Makes page
the visible page of self
.
Since: 1.0
setVisiblePageName
preferencesWindowSetVisiblePageName Source #
:: (HasCallStack, MonadIO m, IsPreferencesWindow a) | |
=> a |
|
-> Text |
|
-> m () |
Makes the page with the given name visible.
See [propertyviewStack
:visible-child].
Since: 1.0
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.
Since: 1.0
constructPreferencesWindowCanNavigateBack :: (IsPreferencesWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
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 Source #
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 () Source #
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.
Since: 1.0
constructPreferencesWindowSearchEnabled :: (IsPreferencesWindow 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
.
getPreferencesWindowSearchEnabled :: (MonadIO m, IsPreferencesWindow o) => o -> m Bool Source #
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 () Source #
Set the value of the “search-enabled
” property.
When overloading is enabled, this is equivalent to
set
preferencesWindow [ #searchEnabled:=
value ]
visiblePage
No description available in the introspection data.
clearPreferencesWindowVisiblePage :: (MonadIO m, IsPreferencesWindow o) => o -> m () Source #
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) Source #
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) Source #
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 () Source #
Set the value of the “visible-page
” property.
When overloading is enabled, this is equivalent to
set
preferencesWindow [ #visiblePage:=
value ]
visiblePageName
No description available in the introspection data.
constructPreferencesWindowVisiblePageName :: (IsPreferencesWindow 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
.
getPreferencesWindowVisiblePageName :: (MonadIO m, IsPreferencesWindow o) => o -> m (Maybe Text) Source #
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 () Source #
Set the value of the “visible-page-name
” property.
When overloading is enabled, this is equivalent to
set
preferencesWindow [ #visiblePageName:=
value ]