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 ListBoxRow
used to present preferences.
The AdwPreferencesRow
widget has a title that PreferencesWindow
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.
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 Text
- preferencesRowGetUseUnderline :: (HasCallStack, MonadIO m, IsPreferencesRow a) => a -> m Bool
- preferencesRowNew :: (HasCallStack, MonadIO m) => m PreferencesRow
- preferencesRowSetTitle :: (HasCallStack, MonadIO m, IsPreferencesRow a) => a -> Text -> m ()
- preferencesRowSetUseUnderline :: (HasCallStack, MonadIO m, IsPreferencesRow a) => a -> Bool -> m ()
- constructPreferencesRowTitle :: (IsPreferencesRow o, MonadIO m) => Text -> m (GValueConstruct o)
- getPreferencesRowTitle :: (MonadIO m, IsPreferencesRow o) => o -> m 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.
Instances
Eq PreferencesRow Source # | |
Defined in GI.Adw.Objects.PreferencesRow (==) :: PreferencesRow -> PreferencesRow -> Bool # (/=) :: PreferencesRow -> PreferencesRow -> Bool # | |
GObject PreferencesRow Source # | |
Defined in GI.Adw.Objects.PreferencesRow | |
ManagedPtrNewtype PreferencesRow Source # | |
Defined in GI.Adw.Objects.PreferencesRow | |
TypedObject PreferencesRow Source # | |
Defined in GI.Adw.Objects.PreferencesRow | |
HasParentTypes PreferencesRow Source # | |
Defined in GI.Adw.Objects.PreferencesRow | |
IsGValue (Maybe PreferencesRow) Source # | Convert |
Defined in GI.Adw.Objects.PreferencesRow gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe PreferencesRow -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe PreferencesRow) # | |
type ParentTypes PreferencesRow Source # | |
Defined in GI.Adw.Objects.PreferencesRow type ParentTypes PreferencesRow = '[ListBoxRow, Widget, Object, Accessible, Actionable, Buildable, ConstraintTarget] |
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.Adw.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
actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, changed, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSelected, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccessibleRole, getActionName, getActionTargetValue, getActivatable, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBuildableId, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeader, getHeight, getHexpand, getHexpandSet, getIndex, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSelectable, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTitle, getTooltipMarkup, getTooltipText, getUseUnderline, getValign, getVexpand, getVexpandSet, getVisible, getWidth.
Setters
setActionName, setActionTargetValue, setActivatable, setCanFocus, setCanTarget, setChild, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDetailedActionName, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHeader, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setSelectable, setSensitive, setSizeRequest, setStateFlags, setTitle, setTooltipMarkup, setTooltipText, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible.
getTitle
preferencesRowGetTitle Source #
:: (HasCallStack, MonadIO m, IsPreferencesRow a) | |
=> a |
|
-> m Text | Returns: the title |
Gets the title of the preference represented by self
.
Since: 1.0
getUseUnderline
preferencesRowGetUseUnderline Source #
:: (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
:: (HasCallStack, MonadIO m) | |
=> m PreferencesRow | Returns: the newly created |
Creates a new AdwPreferencesRow
.
Since: 1.0
setTitle
preferencesRowSetTitle Source #
:: (HasCallStack, MonadIO m, IsPreferencesRow a) | |
=> a |
|
-> Text |
|
-> m () |
Sets the title of the preference represented by self
.
Since: 1.0
setUseUnderline
preferencesRowSetUseUnderline Source #
:: (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
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 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
set
preferencesRow [ #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
set
preferencesRow [ #useUnderline:=
value ]