Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
A PreferencesGroup
represents a group or tightly related preferences,
which in turn are represented by HdyPreferencesRow.
To summarize the role of the preferences it gathers, a group can have both a
title and a description. The title will be used by PreferencesWindow
to
let the user look for a preference.
Since: 0.0.10
Synopsis
- newtype PreferencesGroup = PreferencesGroup (ManagedPtr PreferencesGroup)
- class (GObject o, IsDescendantOf PreferencesGroup o) => IsPreferencesGroup o
- toPreferencesGroup :: (MonadIO m, IsPreferencesGroup o) => o -> m PreferencesGroup
- preferencesGroupGetDescription :: (HasCallStack, MonadIO m, IsPreferencesGroup a) => a -> m Text
- preferencesGroupGetTitle :: (HasCallStack, MonadIO m, IsPreferencesGroup a) => a -> m Text
- preferencesGroupNew :: (HasCallStack, MonadIO m) => m PreferencesGroup
- preferencesGroupSetDescription :: (HasCallStack, MonadIO m, IsPreferencesGroup a) => a -> Text -> m ()
- preferencesGroupSetTitle :: (HasCallStack, MonadIO m, IsPreferencesGroup a) => a -> Text -> m ()
- constructPreferencesGroupDescription :: (IsPreferencesGroup o, MonadIO m) => Text -> m (GValueConstruct o)
- getPreferencesGroupDescription :: (MonadIO m, IsPreferencesGroup o) => o -> m Text
- setPreferencesGroupDescription :: (MonadIO m, IsPreferencesGroup o) => o -> Text -> m ()
- constructPreferencesGroupTitle :: (IsPreferencesGroup o, MonadIO m) => Text -> m (GValueConstruct o)
- getPreferencesGroupTitle :: (MonadIO m, IsPreferencesGroup o) => o -> m Text
- setPreferencesGroupTitle :: (MonadIO m, IsPreferencesGroup o) => o -> Text -> m ()
Exported types
newtype PreferencesGroup Source #
Memory-managed wrapper type.
PreferencesGroup (ManagedPtr PreferencesGroup) |
Instances
class (GObject o, IsDescendantOf PreferencesGroup o) => IsPreferencesGroup o Source #
Type class for types which can be safely cast to PreferencesGroup
, for instance with toPreferencesGroup
.
Instances
(GObject o, IsDescendantOf PreferencesGroup o) => IsPreferencesGroup o Source # | |
Defined in GI.Handy.Objects.PreferencesGroup |
toPreferencesGroup :: (MonadIO m, IsPreferencesGroup o) => o -> m PreferencesGroup Source #
Cast to PreferencesGroup
, 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, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, 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, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, packEnd, packStart, parserFinished, path, propagateDraw, queryChildPacking, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reorderChild, reparent, resetRcStyles, resetStyle, resizeChildren, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetStateFlags, watchClosure.
Getters
getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBaselinePosition, getBorderWidth, getCanDefault, getCanFocus, getCenterWidget, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDescription, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getHomogeneous, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, getOrientation, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getSizeRequest, getSpacing, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTitle, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.
Setters
setAccelPath, setAllocation, setAppPaintable, setBaselinePosition, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setCenterWidget, setChildPacking, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDescription, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setHomogeneous, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setOrientation, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSensitive, setSizeRequest, setSpacing, setState, setStateFlags, setStyle, setSupportMultidevice, setTitle, setTooltipMarkup, setTooltipText, setTooltipWindow, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.
getDescription
preferencesGroupGetDescription Source #
:: (HasCallStack, MonadIO m, IsPreferencesGroup a) | |
=> a |
|
-> m Text | Returns: the description of |
No description available in the introspection data.
Since: 0.0.10
getTitle
preferencesGroupGetTitle Source #
:: (HasCallStack, MonadIO m, IsPreferencesGroup a) | |
=> a |
|
-> m Text | Returns: the title of |
Gets the title of self
.
Since: 0.0.10
new
:: (HasCallStack, MonadIO m) | |
=> m PreferencesGroup | Returns: a new |
Creates a new PreferencesGroup
.
Since: 0.0.10
setDescription
preferencesGroupSetDescription Source #
:: (HasCallStack, MonadIO m, IsPreferencesGroup a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the description for self
.
Since: 0.0.10
setTitle
preferencesGroupSetTitle Source #
:: (HasCallStack, MonadIO m, IsPreferencesGroup a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the title for self
.
Since: 0.0.10
Properties
description
The description for this group of preferences.
Since: 0.0.10
constructPreferencesGroupDescription :: (IsPreferencesGroup o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “description
” property. This is rarely needed directly, but it is used by new
.
getPreferencesGroupDescription :: (MonadIO m, IsPreferencesGroup o) => o -> m Text Source #
Get the value of the “description
” property.
When overloading is enabled, this is equivalent to
get
preferencesGroup #description
setPreferencesGroupDescription :: (MonadIO m, IsPreferencesGroup o) => o -> Text -> m () Source #
Set the value of the “description
” property.
When overloading is enabled, this is equivalent to
set
preferencesGroup [ #description:=
value ]
title
The title for this group of preferences.
Since: 0.0.10
constructPreferencesGroupTitle :: (IsPreferencesGroup 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
.
getPreferencesGroupTitle :: (MonadIO m, IsPreferencesGroup o) => o -> m Text Source #
Get the value of the “title
” property.
When overloading is enabled, this is equivalent to
get
preferencesGroup #title
setPreferencesGroupTitle :: (MonadIO m, IsPreferencesGroup o) => o -> Text -> m () Source #
Set the value of the “title
” property.
When overloading is enabled, this is equivalent to
set
preferencesGroup [ #title:=
value ]