GI.Adw.Objects.EntryRow

A ListBoxRow with an embedded text entry.

<picture> <source srcset="entry-row-dark.png" media="(prefers-color-scheme: dark)"> <img src="entry-row.png" alt="entry-row"> </picture>

AdwEntryRow has a title that doubles as placeholder text. It shows an icon indicating that it's editable and can receive additional widgets before or after the editable part.

If [propertyentryRow:show-apply-button] is set to TRUE, AdwEntryRow can show an apply button when editing its contents. This can be useful if changing its contents can result in an expensive operation, such as network activity.

AdwEntryRow provides only minimal API and should be used with the Editable API.

See also [classpasswordEntryRow].

AdwEntryRow as GtkBuildable

The AdwEntryRow implementation of the Buildable interface supports adding a child at its end by specifying “suffix” or omitting the “type” attribute of a <child> element.

It also supports adding a child as a prefix widget by specifying “prefix” as the “type” attribute of a <child> element.

CSS nodes

AdwEntryRow has a single CSS node with name row and the .entry style class.

Since: 1.2

Exported types

newtype EntryRow

Memory-managed wrapper type.

Constructors

EntryRow (ManagedPtr EntryRow)

Instances

Eq EntryRow

Defined in GI.Adw.Objects.EntryRow

Methods

(==) :: EntryRow -> EntryRow -> Bool

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

GObject EntryRow

Defined in GI.Adw.Objects.EntryRow

ManagedPtrNewtype EntryRow

Defined in GI.Adw.Objects.EntryRow

Methods

toManagedPtr :: EntryRow -> ManagedPtr EntryRow

TypedObject EntryRow

Defined in GI.Adw.Objects.EntryRow

Methods

glibType :: IO GType

HasParentTypes EntryRow

Defined in GI.Adw.Objects.EntryRow

IsGValue (Maybe EntryRow)

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

Defined in GI.Adw.Objects.EntryRow

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes EntryRow

Defined in GI.Adw.Objects.EntryRow

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

class (GObject o, IsDescendantOf EntryRow o) => IsEntryRow o

Type class for types which can be safely cast to EntryRow, for instance with toEntryRow.

Instances

(GObject o, IsDescendantOf EntryRow o) => IsEntryRow o

Defined in GI.Adw.Objects.EntryRow

toEntryRow :: (MonadIO m, IsEntryRow o) => o -> m EntryRow

Cast to EntryRow, 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, addPrefix, addSuffix, addTickCallback, allocate, bindProperty, bindPropertyFull, changed, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, delegateGetAccessiblePlatformState, deleteSelection, deleteText, disposeTemplate, dragCheckThreshold, errorBell, finishDelegate, forceFloating, freezeNotify, getv, grabFocus, grabFocusWithoutSelecting, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initDelegate, initTemplate, insertActionGroup, insertAfter, insertBefore, insertText, isAncestor, isDrawable, isFloating, isFocus, isSelected, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, remove, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, selectRegion, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleParent, getAccessibleRole, getActionName, getActionTargetValue, getActivatable, getActivatesDefault, getAlignment, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getAttributes, getBounds, getBuildableId, getCanFocus, getCanTarget, getChars, getChild, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getData, getDelegate, getDirection, getDisplay, getEditable, getEnableEmojiCompletion, getEnableUndo, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeader, getHeight, getHexpand, getHexpandSet, getIndex, getInputHints, getInputPurpose, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMaxWidthChars, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPlatformState, getPosition, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSelectable, getSelectionBounds, getSensitive, getSettings, getShowApplyButton, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getText, getTitle, getTitleSelectable, getTooltipMarkup, getTooltipText, getUseMarkup, getUseUnderline, getValign, getVexpand, getVexpandSet, getVisible, getWidth, getWidthChars.

Setters

setAccessibleParent, setActionName, setActionTargetValue, setActivatable, setActivatesDefault, setAlignment, setAttributes, setCanFocus, setCanTarget, setChild, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDetailedActionName, setDirection, setEditable, setEnableEmojiCompletion, setEnableUndo, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHeader, setHexpand, setHexpandSet, setInputHints, setInputPurpose, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setMaxWidthChars, setName, setOpacity, setOverflow, setParent, setPosition, setProperty, setReceivesDefault, setSelectable, setSensitive, setShowApplyButton, setSizeRequest, setStateFlags, setText, setTitle, setTitleSelectable, setTooltipMarkup, setTooltipText, setUseMarkup, setUseUnderline, setValign, setVexpand, setVexpandSet, setVisible, setWidthChars.

addPrefix

entryRowAddPrefix

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a, IsWidget b)

=> a

self: an entry row

-> b

widget: a widget

-> m ()

Adds a prefix widget to self.

Since: 1.2

addSuffix

entryRowAddSuffix

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a, IsWidget b)

=> a

self: an entry row

-> b

widget: a widget

-> m ()

Adds a suffix widget to self.

Since: 1.2

getActivatesDefault

entryRowGetActivatesDefault

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a)

=> a

self: an entry row

-> m Bool

Returns: whether to activate the default widget

Gets whether activating the embedded entry can activate the default widget.

Since: 1.2

getAttributes

entryRowGetAttributes

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a)

=> a

self: an entry row

-> m (Maybe AttrList)

Returns: the list of attributes

Gets Pango attributes applied to the text of the embedded entry.

Since: 1.2

getEnableEmojiCompletion

entryRowGetEnableEmojiCompletion

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a)

=> a

self: an entry row

-> m Bool

Returns: whether or not emoji completion is enabled

Gets whether to suggest emoji replacements on self.

Since: 1.2

getInputHints

entryRowGetInputHints

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a)

=> a

self: an entry row

-> m [InputHints]

Returns: The input hints

Gets the additional input hints of self.

Since: 1.2

getInputPurpose

entryRowGetInputPurpose

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a)

=> a

self: an entry row

-> m InputPurpose

Returns: the input purpose

Gets the input purpose of self.

Since: 1.2

getShowApplyButton

entryRowGetShowApplyButton

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a)

=> a

self: an entry row

-> m Bool

Returns: whether to show the apply button

Gets whether self can show the apply button.

Since: 1.2

grabFocusWithoutSelecting

entryRowGrabFocusWithoutSelecting

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a)

=> a

self: an entry row

-> m Bool

Returns: whether the focus is now inside self

Causes self to have keyboard focus without selecting the text.

See textGrabFocusWithoutSelecting for more information.

Since: 1.3

new

entryRowNew

Arguments

:: (HasCallStack, MonadIO m)

=> m EntryRow

Returns: the newly created AdwEntryRow

Creates a new AdwEntryRow.

Since: 1.2

remove

entryRowRemove

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a, IsWidget b)

=> a

self: an entry row

-> b

widget: the child to be removed

-> m ()

Removes a child from self.

Since: 1.2

setActivatesDefault

entryRowSetActivatesDefault

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a)

=> a

self: an entry row

-> Bool

activates: whether to activate the default widget

-> m ()

Sets whether activating the embedded entry can activate the default widget.

Since: 1.2

setAttributes

entryRowSetAttributes

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a)

=> a

self: an entry row

-> Maybe AttrList

attributes: a list of attributes

-> m ()

Sets Pango attributes to apply to the text of the embedded entry.

The [structpango.Attribute]'s start_index and end_index must refer to the EntryBuffer text, i.e. without the preedit string.

Since: 1.2

setEnableEmojiCompletion

entryRowSetEnableEmojiCompletion

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a)

=> a

self: an entry row

-> Bool

enableEmojiCompletion: Whether emoji completion should be enabled or not

-> m ()

Sets whether to suggest emoji replacements on self.

Emoji replacement is done with :-delimited names, like :heart:.

Since: 1.2

setInputHints

entryRowSetInputHints

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a)

=> a

self: an entry row

-> [InputHints]

hints: the hints

-> m ()

Set additional input hints for self.

Input hints allow input methods to fine-tune their behavior.

See also: [propertyadwEntryRow:input-purpose]

Since: 1.2

setInputPurpose

entryRowSetInputPurpose

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a)

=> a

self: an entry row

-> InputPurpose

purpose: the purpose

-> m ()

Sets the input purpose of self.

The input purpose can be used by input methods to adjust their behavior.

Since: 1.2

setShowApplyButton

entryRowSetShowApplyButton

Arguments

:: (HasCallStack, MonadIO m, IsEntryRow a)

=> a

self: an entry row

-> Bool

showApplyButton: whether to show the apply button

-> m ()

Sets whether self can show the apply button.

When set to TRUE, typing text in the entry will reveal an apply button. Clicking it or pressing the <kbd>Enter</kbd> key will hide the button and emit the signalentryRow[apply] signal.

This is useful if changing the entry contents can trigger an expensive operation, e.g. network activity, to avoid triggering it after typing every character.

Since: 1.2

Properties

activatesDefault

Whether activating the embedded entry can activate the default widget.

Since: 1.2

constructEntryRowActivatesDefault :: (IsEntryRow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getEntryRowActivatesDefault :: (MonadIO m, IsEntryRow o) => o -> m Bool

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

get entryRow #activatesDefault

setEntryRowActivatesDefault :: (MonadIO m, IsEntryRow o) => o -> Bool -> m ()

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

set entryRow [ #activatesDefault := value ]

attributes

A list of Pango attributes to apply to the text of the embedded entry.

The [structpango.Attribute]'s start_index and end_index must refer to the EntryBuffer text, i.e. without the preedit string.

Since: 1.2

clearEntryRowAttributes :: (MonadIO m, IsEntryRow o) => o -> m ()

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

clear #attributes

constructEntryRowAttributes :: (IsEntryRow o, MonadIO m) => AttrList -> m (GValueConstruct o)

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

getEntryRowAttributes :: (MonadIO m, IsEntryRow o) => o -> m (Maybe AttrList)

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

get entryRow #attributes

setEntryRowAttributes :: (MonadIO m, IsEntryRow o) => o -> AttrList -> m ()

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

set entryRow [ #attributes := value ]

enableEmojiCompletion

Whether to suggest emoji replacements on the entry row.

Emoji replacement is done with :-delimited names, like :heart:.

Since: 1.2

constructEntryRowEnableEmojiCompletion :: (IsEntryRow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getEntryRowEnableEmojiCompletion :: (MonadIO m, IsEntryRow o) => o -> m Bool

Get the value of the “enable-emoji-completion” property. When overloading is enabled, this is equivalent to

get entryRow #enableEmojiCompletion

setEntryRowEnableEmojiCompletion :: (MonadIO m, IsEntryRow o) => o -> Bool -> m ()

Set the value of the “enable-emoji-completion” property. When overloading is enabled, this is equivalent to

set entryRow [ #enableEmojiCompletion := value ]

inputHints

Additional input hints for the entry row.

Input hints allow input methods to fine-tune their behavior.

See also: EntryRow:inputPurpose

Since: 1.2

constructEntryRowInputHints :: (IsEntryRow o, MonadIO m) => [InputHints] -> m (GValueConstruct o)

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

getEntryRowInputHints :: (MonadIO m, IsEntryRow o) => o -> m [InputHints]

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

get entryRow #inputHints

setEntryRowInputHints :: (MonadIO m, IsEntryRow o) => o -> [InputHints] -> m ()

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

set entryRow [ #inputHints := value ]

inputPurpose

The input purpose of the entry row.

The input purpose can be used by input methods to adjust their behavior.

Since: 1.2

constructEntryRowInputPurpose :: (IsEntryRow o, MonadIO m) => InputPurpose -> m (GValueConstruct o)

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

getEntryRowInputPurpose :: (MonadIO m, IsEntryRow o) => o -> m InputPurpose

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

get entryRow #inputPurpose

setEntryRowInputPurpose :: (MonadIO m, IsEntryRow o) => o -> InputPurpose -> m ()

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

set entryRow [ #inputPurpose := value ]

showApplyButton

Whether to show the apply button.

When set to TRUE, typing text in the entry will reveal an apply button. Clicking it or pressing the <kbd>Enter</kbd> key will hide the button and emit the signalentryRow[apply] signal.

This is useful if changing the entry contents can trigger an expensive operation, e.g. network activity, to avoid triggering it after typing every character.

Since: 1.2

constructEntryRowShowApplyButton :: (IsEntryRow o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getEntryRowShowApplyButton :: (MonadIO m, IsEntryRow o) => o -> m Bool

Get the value of the “show-apply-button” property. When overloading is enabled, this is equivalent to

get entryRow #showApplyButton

setEntryRowShowApplyButton :: (MonadIO m, IsEntryRow o) => o -> Bool -> m ()

Set the value of the “show-apply-button” property. When overloading is enabled, this is equivalent to

set entryRow [ #showApplyButton := value ]

Signals

apply

type EntryRowApplyCallback = IO ()

Emitted when the apply button is pressed.

See [propertyentryRow:show-apply-button].

Since: 1.2

afterEntryRowApply :: (IsEntryRow a, MonadIO m) => a -> ((?self :: a) => EntryRowApplyCallback) -> m SignalHandlerId

Connect a signal handler for the apply signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after entryRow #apply callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onEntryRowApply :: (IsEntryRow a, MonadIO m) => a -> ((?self :: a) => EntryRowApplyCallback) -> m SignalHandlerId

Connect a signal handler for the apply signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on entryRow #apply callback

entryActivated

type EntryRowEntryActivatedCallback = IO ()

Emitted when the embedded entry is activated.

Since: 1.2

afterEntryRowEntryActivated :: (IsEntryRow a, MonadIO m) => a -> ((?self :: a) => EntryRowEntryActivatedCallback) -> m SignalHandlerId

Connect a signal handler for the entryActivated signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after entryRow #entryActivated callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onEntryRowEntryActivated :: (IsEntryRow a, MonadIO m) => a -> ((?self :: a) => EntryRowEntryActivatedCallback) -> m SignalHandlerId

Connect a signal handler for the entryActivated signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on entryRow #entryActivated callback