| 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.PreferencesRow
Description
A ListBoxRow used to present preferences.
The HdyPreferencesRow widget has a title that [classpreferencesWindow]
will use to let the user look for a preference. It doesn't present the title
in any way and lets you present the preference as you please.
- class
actionRow - and its derivatives are convenient to use as preference rows as they take care of presenting the preference's title while letting you compose the inputs of the preference around it.
Since: 1.0
Synopsis
- newtype PreferencesRow = PreferencesRow (ManagedPtr PreferencesRow)
- class (GObject o, IsDescendantOf PreferencesRow o) => IsPreferencesRow o
- toPreferencesRow :: (MonadIO m, IsPreferencesRow o) => o -> m PreferencesRow
- preferencesRowGetTitle :: (HasCallStack, MonadIO m, IsPreferencesRow a) => a -> m (Maybe Text)
- preferencesRowGetUseUnderline :: (HasCallStack, MonadIO m, IsPreferencesRow a) => a -> m Bool
- preferencesRowNew :: (HasCallStack, MonadIO m) => m PreferencesRow
- preferencesRowSetTitle :: (HasCallStack, MonadIO m, IsPreferencesRow a) => a -> Maybe Text -> m ()
- preferencesRowSetUseUnderline :: (HasCallStack, MonadIO m, IsPreferencesRow a) => a -> Bool -> m ()
- clearPreferencesRowTitle :: (MonadIO m, IsPreferencesRow o) => o -> m ()
- constructPreferencesRowTitle :: (IsPreferencesRow o, MonadIO m) => Text -> m (GValueConstruct o)
- getPreferencesRowTitle :: (MonadIO m, IsPreferencesRow o) => o -> m (Maybe Text)
- setPreferencesRowTitle :: (MonadIO m, IsPreferencesRow o) => o -> Text -> m ()
- constructPreferencesRowUseUnderline :: (IsPreferencesRow o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPreferencesRowUseUnderline :: (MonadIO m, IsPreferencesRow o) => o -> m Bool
- setPreferencesRowUseUnderline :: (MonadIO m, IsPreferencesRow o) => o -> Bool -> m ()
Exported types
newtype PreferencesRow Source #
Memory-managed wrapper type.
Constructors
| PreferencesRow (ManagedPtr PreferencesRow) |
Instances
class (GObject o, IsDescendantOf PreferencesRow o) => IsPreferencesRow o Source #
Type class for types which can be safely cast to PreferencesRow, for instance with toPreferencesRow.
Instances
| (GObject o, IsDescendantOf PreferencesRow o) => IsPreferencesRow o Source # | |
Defined in GI.Handy.Objects.PreferencesRow | |
toPreferencesRow :: (MonadIO m, IsPreferencesRow o) => o -> m PreferencesRow Source #
Cast to PreferencesRow, 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, changed, 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, isSelected, 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, getActionName, getActionTargetValue, getActivatable, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHasWindow, getHeader, getHexpand, getHexpandSet, getIndex, 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, getSelectable, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTitle, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getUseUnderline, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getWindow.
Setters
setAccelPath, setActionName, setActionTargetValue, setActivatable, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDetailedActionName, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHalign, setHasTooltip, setHasWindow, setHeader, setHexpand, setHexpandSet, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSelectable, setSensitive, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTitle, setTooltipMarkup, setTooltipText, setTooltipWindow, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.
getTitle
preferencesRowGetTitle Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPreferencesRow a) | |
| => a |
|
| -> m (Maybe Text) | Returns: the title of the preference represented
by |
Gets the title of the preference represented by self.
Since: 1.0
getUseUnderline
preferencesRowGetUseUnderline Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPreferencesRow a) | |
| => a |
|
| -> m Bool | Returns: whether an embedded underline in the title indicates a mnemonic |
Gets whether an embedded underline in the title indicates a mnemonic.
Since: 1.0
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m PreferencesRow | Returns: the newly created |
Creates a new HdyPreferencesRow.
Since: 1.0
setTitle
preferencesRowSetTitle Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPreferencesRow a) | |
| => a |
|
| -> Maybe Text |
|
| -> m () |
Sets the title of the preference represented by self.
Since: 1.0
setUseUnderline
preferencesRowSetUseUnderline Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPreferencesRow a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether an embedded underline in the title indicates a mnemonic.
Since: 1.0
Properties
title
The title of the preference represented by this row.
Since: 1.0
clearPreferencesRowTitle :: (MonadIO m, IsPreferencesRow o) => o -> m () Source #
Set the value of the “title” property to Nothing.
When overloading is enabled, this is equivalent to
clear #title
constructPreferencesRowTitle :: (IsPreferencesRow 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.
getPreferencesRowTitle :: (MonadIO m, IsPreferencesRow o) => o -> m (Maybe Text) Source #
Get the value of the “title” property.
When overloading is enabled, this is equivalent to
get preferencesRow #title
setPreferencesRowTitle :: (MonadIO m, IsPreferencesRow o) => o -> Text -> m () Source #
Set the value of the “title” property.
When overloading is enabled, this is equivalent to
setpreferencesRow [ #title:=value ]
useUnderline
Whether an embedded underline in the title indicates a mnemonic.
Since: 1.0
constructPreferencesRowUseUnderline :: (IsPreferencesRow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “use-underline” property. This is rarely needed directly, but it is used by new.
getPreferencesRowUseUnderline :: (MonadIO m, IsPreferencesRow o) => o -> m Bool Source #
Get the value of the “use-underline” property.
When overloading is enabled, this is equivalent to
get preferencesRow #useUnderline
setPreferencesRowUseUnderline :: (MonadIO m, IsPreferencesRow o) => o -> Bool -> m () Source #
Set the value of the “use-underline” property.
When overloading is enabled, this is equivalent to
setpreferencesRow [ #useUnderline:=value ]