| 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 |
GI.Handy.Objects.PreferencesWindow
Description
A window to present an application's preferences.
The HdyPreferencesWindow widget presents an application's preferences
gathered into pages and groups. The preferences are searchable by the user.
CSS nodes
HdyPreferencesWindow 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
- preferencesWindowCloseSubpage :: (HasCallStack, MonadIO m, IsPreferencesWindow a) => a -> m ()
- preferencesWindowGetCanSwipeBack :: (HasCallStack, MonadIO m, IsPreferencesWindow a) => a -> m Bool
- preferencesWindowGetSearchEnabled :: (HasCallStack, MonadIO m, IsPreferencesWindow a) => a -> m Bool
- preferencesWindowNew :: (HasCallStack, MonadIO m) => m PreferencesWindow
- preferencesWindowPresentSubpage :: (HasCallStack, MonadIO m, IsPreferencesWindow a, IsWidget b) => a -> b -> m ()
- preferencesWindowSetCanSwipeBack :: (HasCallStack, MonadIO m, IsPreferencesWindow a) => a -> Bool -> m ()
- preferencesWindowSetSearchEnabled :: (HasCallStack, MonadIO m, IsPreferencesWindow a) => a -> Bool -> m ()
- constructPreferencesWindowCanSwipeBack :: (IsPreferencesWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPreferencesWindowCanSwipeBack :: (MonadIO m, IsPreferencesWindow o) => o -> m Bool
- setPreferencesWindowCanSwipeBack :: (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 ()
Exported types
newtype PreferencesWindow Source #
Memory-managed wrapper type.
Constructors
| 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.Handy.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
activate, activateDefault, activateFocus, activateKey, add, addAccelGroup, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonic, addMnemonicLabel, addTickCallback, beginMoveDrag, beginResizeDrag, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, close, closeSubpage, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, deiconify, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, fullscreen, fullscreenOnMonitor, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasGroup, hasRcStyle, hasScreen, hasToplevelFocus, hasVisibleFocus, hide, hideOnDelete, iconify, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isActive, isAncestor, isComposited, isDrawable, isFloating, isFocus, isMaximized, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, maximize, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, move, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parseGeometry, parserFinished, path, present, presentSubpage, presentWithTime, propagateDraw, propagateKeyEvent, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelGroup, removeAccelerator, removeMnemonic, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, reshowWithInitialSize, resize, resizeChildren, resizeGripIsVisible, resizeToGeometry, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, stick, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unfullscreen, unmap, unmaximize, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, unstick, watchClosure.
Getters
getAcceptFocus, getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getApplication, getAttachedTo, getBorderWidth, getCanDefault, getCanFocus, getCanSwipeBack, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDecorated, getDefaultSize, getDefaultWidget, getDeletable, getDestroyWithParent, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocus, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusOnMap, getFocusVadjustment, getFocusVisible, getFontMap, getFontOptions, getFrameClock, getGravity, getGroup, getHalign, getHasResizeGrip, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getHideTitlebarWhenMaximized, getIcon, getIconList, getIconName, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getMnemonicModifier, getMnemonicsVisible, getModal, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPosition, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizable, getResizeGripArea, getResizeMode, getRole, getRootWindow, getScaleFactor, getScreen, getSearchEnabled, getSensitive, getSettings, getSize, getSizeRequest, getSkipPagerHint, getSkipTaskbarHint, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTitle, getTitlebar, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getTransientFor, getTypeHint, getUrgencyHint, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow, getWindowType.
Setters
setAccelPath, setAcceptFocus, setAllocation, setAppPaintable, setApplication, setAttachedTo, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setCanSwipeBack, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDecorated, setDefault, setDefaultGeometry, setDefaultSize, setDeletable, setDestroyWithParent, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocus, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusOnMap, setFocusVadjustment, setFocusVisible, setFontMap, setFontOptions, setGeometryHints, setGravity, setHalign, setHasResizeGrip, setHasTooltip, setHasUserRefCount, setHasWindow, setHexpand, setHexpandSet, setHideTitlebarWhenMaximized, setIcon, setIconFromFile, setIconList, setIconName, setKeepAbove, setKeepBelow, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setMnemonicModifier, setMnemonicsVisible, setModal, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setPosition, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizable, setResizeMode, setRole, setScreen, setSearchEnabled, setSensitive, setSizeRequest, setSkipPagerHint, setSkipTaskbarHint, setStartupId, setState, setStateFlags, setStyle, setSupportMultidevice, setTitle, setTitlebar, setTooltipMarkup, setTooltipText, setTooltipWindow, setTransientFor, setTypeHint, setUrgencyHint, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow, setWmclass.
closeSubpage
preferencesWindowCloseSubpage Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPreferencesWindow a) | |
| => a |
|
| -> m () |
Closes the current subpage.
If there is no presented subpage, this does nothing.
Since: 1.0
getCanSwipeBack
preferencesWindowGetCanSwipeBack Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPreferencesWindow a) | |
| => a |
|
| -> m Bool | Returns: |
Gets whether swipe gestures allow switching from a subpage to the preferences.
Since: 1.0
getSearchEnabled
preferencesWindowGetSearchEnabled Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPreferencesWindow a) | |
| => a |
|
| -> m Bool | Returns: whether search is enabled for |
Gets whether search is enabled for self.
Since: 1.0
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m PreferencesWindow | Returns: the newly created |
Creates a new HdyPreferencesWindow.
Since: 1.0
presentSubpage
preferencesWindowPresentSubpage Source #
Arguments
| :: (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
setCanSwipeBack
preferencesWindowSetCanSwipeBack Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPreferencesWindow a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether swipe gestures allow switching from a subpage to the preferences.
Since: 1.0
setSearchEnabled
preferencesWindowSetSearchEnabled Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPreferencesWindow a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether search is enabled for self.
Since: 1.0
Properties
canSwipeBack
Whether the window allows closing the subpage via a swipe gesture.
Since: 1.0
constructPreferencesWindowCanSwipeBack :: (IsPreferencesWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “can-swipe-back” property. This is rarely needed directly, but it is used by new.
getPreferencesWindowCanSwipeBack :: (MonadIO m, IsPreferencesWindow o) => o -> m Bool Source #
Get the value of the “can-swipe-back” property.
When overloading is enabled, this is equivalent to
get preferencesWindow #canSwipeBack
setPreferencesWindowCanSwipeBack :: (MonadIO m, IsPreferencesWindow o) => o -> Bool -> m () Source #
Set the value of the “can-swipe-back” property.
When overloading is enabled, this is equivalent to
setpreferencesWindow [ #canSwipeBack:=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
setpreferencesWindow [ #searchEnabled:=value ]