GI.Gtk.Objects.EditableLabel

A GtkEditableLabel is a label that allows users to edit the text by switching to an “edit mode”.

GtkEditableLabel does not have API of its own, but it implements the Editable interface.

The default bindings for activating the edit mode is to click or press the Enter key. The default bindings for leaving the edit mode are the Enter key (to save the results) or the Escape key (to cancel the editing).

CSS nodes

editablelabel[.editing]
╰── stack
    ├── label
    ╰── text

GtkEditableLabel has a main node with the name editablelabel. When the entry is in editing mode, it gets the .editing style class.

For all the subnodes added to the text node in various situations, see Text.

Exported types

newtype EditableLabel

Memory-managed wrapper type.

Constructors

EditableLabel (ManagedPtr EditableLabel)

Instances

Eq EditableLabel

Defined in GI.Gtk.Objects.EditableLabel

Methods

(==) :: EditableLabel -> EditableLabel -> Bool

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

GObject EditableLabel

Defined in GI.Gtk.Objects.EditableLabel

ManagedPtrNewtype EditableLabel

Defined in GI.Gtk.Objects.EditableLabel

Methods

toManagedPtr :: EditableLabel -> ManagedPtr EditableLabel

TypedObject EditableLabel

Defined in GI.Gtk.Objects.EditableLabel

Methods

glibType :: IO GType

HasParentTypes EditableLabel

Defined in GI.Gtk.Objects.EditableLabel

IsGValue (Maybe EditableLabel)

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

Defined in GI.Gtk.Objects.EditableLabel

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes EditableLabel

Defined in GI.Gtk.Objects.EditableLabel

type ParentTypes EditableLabel = '[Widget, Object, Accessible, Buildable, ConstraintTarget, Editable]

class (GObject o, IsDescendantOf EditableLabel o) => IsEditableLabel o

Type class for types which can be safely cast to EditableLabel, for instance with toEditableLabel.

Instances

(GObject o, IsDescendantOf EditableLabel o) => IsEditableLabel o

Defined in GI.Gtk.Objects.EditableLabel

toEditableLabel :: (MonadIO m, IsEditableLabel o) => o -> m EditableLabel

Cast to EditableLabel, 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, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, delegateGetAccessiblePlatformState, deleteSelection, deleteText, disposeTemplate, dragCheckThreshold, errorBell, finishDelegate, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initDelegate, initTemplate, insertActionGroup, insertAfter, insertBefore, insertText, isAncestor, isDrawable, isFloating, isFocus, 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, selectRegion, shouldLayout, show, sizeAllocate, snapshotChild, startEditing, stealData, stealQdata, stopEditing, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleParent, getAccessibleRole, getAlignment, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getBounds, getBuildableId, getCanFocus, getCanTarget, getChars, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getData, getDelegate, getDirection, getDisplay, getEditable, getEditing, getEnableUndo, getFirstAccessibleChild, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, 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, getSelectionBounds, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getText, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, getWidthChars.

Setters

setAccessibleParent, setAlignment, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setEditable, setEnableUndo, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setMaxWidthChars, setName, setOpacity, setOverflow, setParent, setPosition, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setText, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, setWidthChars.

getEditing

editableLabelGetEditing

Arguments

:: (HasCallStack, MonadIO m, IsEditableLabel a)

=> a

self: a GtkEditableLabel

-> m Bool

Returns: True if self is currently in editing mode

Returns whether the label is currently in “editing mode”.

new

editableLabelNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

str: the text for the label

-> m EditableLabel

Returns: the new GtkEditableLabel

Creates a new GtkEditableLabel widget.

startEditing

editableLabelStartEditing

Arguments

:: (HasCallStack, MonadIO m, IsEditableLabel a)

=> a

self: a GtkEditableLabel

-> m ()

Switches the label into “editing mode”.

stopEditing

editableLabelStopEditing

Arguments

:: (HasCallStack, MonadIO m, IsEditableLabel a)

=> a

self: a GtkEditableLabel

-> Bool

commit: whether to set the edited text on the label

-> m ()

Switches the label out of “editing mode”.

If commit is True, the resulting text is kept as the Editable:text property value, otherwise the resulting text is discarded and the label will keep its previous Editable:text property value.

Properties

editing

This property is True while the widget is in edit mode.

constructEditableLabelEditing :: (IsEditableLabel o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getEditableLabelEditing :: (MonadIO m, IsEditableLabel o) => o -> m Bool

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

get editableLabel #editing

setEditableLabelEditing :: (MonadIO m, IsEditableLabel o) => o -> Bool -> m ()

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

set editableLabel [ #editing := value ]