GI.Adw.Objects.PreferencesRow

A ListBoxRow used to present preferences.

The AdwPreferencesRow 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.

classactionRow

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

Exported types

newtype PreferencesRow

Memory-managed wrapper type.

Constructors

PreferencesRow (ManagedPtr PreferencesRow)

Instances

Eq PreferencesRow

Defined in GI.Adw.Objects.PreferencesRow

Methods

(==) :: PreferencesRow -> PreferencesRow -> Bool

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

GObject PreferencesRow

Defined in GI.Adw.Objects.PreferencesRow

ManagedPtrNewtype PreferencesRow

Defined in GI.Adw.Objects.PreferencesRow

Methods

toManagedPtr :: PreferencesRow -> ManagedPtr PreferencesRow

TypedObject PreferencesRow

Defined in GI.Adw.Objects.PreferencesRow

Methods

glibType :: IO GType

HasParentTypes PreferencesRow

Defined in GI.Adw.Objects.PreferencesRow

IsGValue (Maybe PreferencesRow)

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

Defined in GI.Adw.Objects.PreferencesRow

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes PreferencesRow

Defined in GI.Adw.Objects.PreferencesRow

type ParentTypes PreferencesRow = '[ListBoxRow, Widget, Object, Accessible, Actionable, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf PreferencesRow o) => IsPreferencesRow o

Type class for types which can be safely cast to PreferencesRow, for instance with toPreferencesRow.

Instances

(GObject o, IsDescendantOf PreferencesRow o) => IsPreferencesRow o

Defined in GI.Adw.Objects.PreferencesRow

toPreferencesRow :: (MonadIO m, IsPreferencesRow o) => o -> m PreferencesRow

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, disposeTemplate, 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, getTitleSelectable, getTooltipMarkup, getTooltipText, getUseMarkup, 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, setTitleSelectable, setTooltipMarkup, setTooltipText, setUseMarkup, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible.

getTitle

preferencesRowGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesRow a)

=> a

self: a preferences row

-> m Text

Returns: the title

Gets the title of the preference represented by self.

Since: 1.0

getTitleSelectable

preferencesRowGetTitleSelectable

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesRow a)

=> a

self: a AdwPreferencesRow

-> m Bool

Returns: whether the user can copy the title from the label

Gets whether the user can copy the title from the label

Since: 1.1

getUseMarkup

preferencesRowGetUseMarkup

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesRow a)

=> a

self: a preferences row

-> m Bool

Returns: whether to use markup

Gets whether to use Pango markup for the title label.

Since: 1.2

getUseUnderline

preferencesRowGetUseUnderline

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesRow a)

=> a

self: a preferences row

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

preferencesRowNew

Arguments

:: (HasCallStack, MonadIO m)

=> m PreferencesRow

Returns: the newly created AdwPreferencesRow

Creates a new AdwPreferencesRow.

Since: 1.0

setTitle

preferencesRowSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesRow a)

=> a

self: a preferences row

-> Text

title: the title

-> m ()

Sets the title of the preference represented by self.

The title is interpreted as Pango markup unless [propertypreferencesRow:use-markup] is set to FALSE.

Since: 1.0

setTitleSelectable

preferencesRowSetTitleSelectable

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesRow a)

=> a

self: a AdwPreferencesRow

-> Bool

titleSelectable: TRUE if the user can copy the title from the label

-> m ()

Sets whether the user can copy the title from the label

See also Label:selectable.

Since: 1.1

setUseMarkup

preferencesRowSetUseMarkup

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesRow a)

=> a

self: a preferences row

-> Bool

useMarkup: whether to use markup

-> m ()

Sets whether to use Pango markup for the title label.

Subclasses may also use it for other labels, such as subtitle.

See also parseMarkup.

Since: 1.2

setUseUnderline

preferencesRowSetUseUnderline

Arguments

:: (HasCallStack, MonadIO m, IsPreferencesRow a)

=> a

self: a preferences row

-> Bool

useUnderline: TRUE if underlines in the text indicate mnemonics

-> 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.

The title is interpreted as Pango markup unless [propertypreferencesRow:use-markup] is set to FALSE.

Since: 1.0

constructPreferencesRowTitle :: (IsPreferencesRow 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.

getPreferencesRowTitle :: (MonadIO m, IsPreferencesRow o) => o -> m Text

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

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

set preferencesRow [ #title := value ]

titleSelectable

Whether the user can copy the title from the label.

See also Label:selectable.

Since: 1.1

constructPreferencesRowTitleSelectable :: (IsPreferencesRow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getPreferencesRowTitleSelectable :: (MonadIO m, IsPreferencesRow o) => o -> m Bool

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

get preferencesRow #titleSelectable

setPreferencesRowTitleSelectable :: (MonadIO m, IsPreferencesRow o) => o -> Bool -> m ()

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

set preferencesRow [ #titleSelectable := value ]

useMarkup

Whether to use Pango markup for the title label.

Subclasses may also use it for other labels, such as subtitle.

See also parseMarkup.

Since: 1.2

constructPreferencesRowUseMarkup :: (IsPreferencesRow 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.

getPreferencesRowUseMarkup :: (MonadIO m, IsPreferencesRow o) => o -> m Bool

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

get preferencesRow #useMarkup

setPreferencesRowUseMarkup :: (MonadIO m, IsPreferencesRow o) => o -> Bool -> m ()

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

set preferencesRow [ #useMarkup := value ]

useUnderline

Whether an embedded underline in the title indicates a mnemonic.

Since: 1.0

constructPreferencesRowUseUnderline :: (IsPreferencesRow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

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

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

set preferencesRow [ #useUnderline := value ]