GI.Handy.Objects.PreferencesGroup

A group of preference rows.

A HdyPreferencesGroup represents a group or tightly related preferences, which in turn are represented by [classpreferencesRow].

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 [classpreferencesWindow] to let the user look for a preference.

CSS nodes

HdyPreferencesGroup has a single CSS node with name preferencesgroup.

Since: 1.0

Exported types

newtype PreferencesGroup

Memory-managed wrapper type.

Constructors

PreferencesGroup (ManagedPtr PreferencesGroup)

Instances

Eq PreferencesGroup

Defined in GI.Handy.Objects.PreferencesGroup

Methods

(==) :: PreferencesGroup -> PreferencesGroup -> Bool

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

GObject PreferencesGroup

Defined in GI.Handy.Objects.PreferencesGroup

ManagedPtrNewtype PreferencesGroup

Defined in GI.Handy.Objects.PreferencesGroup

Methods

toManagedPtr :: PreferencesGroup -> ManagedPtr PreferencesGroup

TypedObject PreferencesGroup

Defined in GI.Handy.Objects.PreferencesGroup

Methods

glibType :: IO GType

HasParentTypes PreferencesGroup

Defined in GI.Handy.Objects.PreferencesGroup

IsGValue (Maybe PreferencesGroup)

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

Defined in GI.Handy.Objects.PreferencesGroup

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes PreferencesGroup

Defined in GI.Handy.Objects.PreferencesGroup

type ParentTypes PreferencesGroup = '[Bin, Container, Widget, Object, ImplementorIface, Buildable]

class (GObject o, IsDescendantOf PreferencesGroup o) => IsPreferencesGroup o

Type class for types which can be safely cast to PreferencesGroup, for instance with toPreferencesGroup.

Instances

(GObject o, IsDescendantOf PreferencesGroup o) => IsPreferencesGroup o

Defined in GI.Handy.Objects.PreferencesGroup

toPreferencesGroup :: (MonadIO m, IsPreferencesGroup o) => o -> m PreferencesGroup

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, parserFinished, path, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, 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, getBorderWidth, getCanDefault, getCanFocus, getChild, 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, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getName, getNoShowAll, getOpacity, 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, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTitle, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getUseMarkup, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.

Setters

setAccelPath, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDescription, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTitle, setTooltipMarkup, setTooltipText, setTooltipWindow, setUseMarkup, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.

getDescription

preferencesGroupGetDescription

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesGroup a)

=> a

self: a preferences group

-> m Text

Returns: the description of self

No description available in the introspection data.

Since: 1.0

getTitle

preferencesGroupGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesGroup a)

=> a

self: a preferences group

-> m Text

Returns: the title of self

Gets the title of self.

Since: 1.0

getUseMarkup

preferencesGroupGetUseMarkup

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesGroup a)

=> a

self: a preferences group

-> m Bool

Returns: whether self uses markup for its labels

Gets whether self uses markup for the title and description.

Since: 1.4

new

preferencesGroupNew

Arguments

:: (HasCallStack, MonadIO m)

=> m PreferencesGroup

Returns: the newly created HdyPreferencesGroup

Creates a new HdyPreferencesGroup.

Since: 1.0

setDescription

preferencesGroupSetDescription

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesGroup a)

=> a

self: a preferences group

-> Text

description: the description

-> m ()

Sets the description for self.

Since: 1.0

setTitle

preferencesGroupSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesGroup a)

=> a

self: a preferences group

-> Text

title: the title

-> m ()

Sets the title for self.

Since: 1.0

setUseMarkup

preferencesGroupSetUseMarkup

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesGroup a)

=> a

self: a preferences group

-> Bool

useMarkup: whether to use markup

-> m ()

Sets whether self uses markup for the title and description.

Since: 1.4

Properties

description

The description for this group of preferences.

Since: 1.0

constructPreferencesGroupDescription :: (IsPreferencesGroup o, MonadIO m) => Text -> m (GValueConstruct o)

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

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 ()

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: 1.0

constructPreferencesGroupTitle :: (IsPreferencesGroup o, MonadIO m) => Text -> m (GValueConstruct o)

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

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 ()

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

set preferencesGroup [ #title := value ]

useMarkup

Whether to use markup for the title and description.

Since: 1.4

constructPreferencesGroupUseMarkup :: (IsPreferencesGroup o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getPreferencesGroupUseMarkup :: (MonadIO m, IsPreferencesGroup o) => o -> m Bool

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

get preferencesGroup #useMarkup

setPreferencesGroupUseMarkup :: (MonadIO m, IsPreferencesGroup o) => o -> Bool -> m ()

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

set preferencesGroup [ #useMarkup := value ]