Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Exported types
- Methods
- getActivatesDefault
- getAttributes
- getBuffer
- getEnableEmojiCompletion
- getExtraMenu
- getInputHints
- getInputPurpose
- getInvisibleChar
- getMaxLength
- getOverwriteMode
- getPlaceholderText
- getPropagateTextWidth
- getTabs
- getTextLength
- getTruncateMultiline
- getVisibility
- grabFocusWithoutSelecting
- new
- newWithBuffer
- setActivatesDefault
- setAttributes
- setBuffer
- setEnableEmojiCompletion
- setExtraMenu
- setInputHints
- setInputPurpose
- setInvisibleChar
- setMaxLength
- setOverwriteMode
- setPlaceholderText
- setPropagateTextWidth
- setTabs
- setTruncateMultiline
- setVisibility
- unsetInvisibleChar
- Properties
- Signals
The Text
widget is a single line text entry widget.
A fairly large set of key bindings are supported by default. If the entered text is longer than the allocation of the widget, the widget will scroll so that the cursor position is visible.
When using an entry for passwords and other sensitive information,
it can be put into “password mode” using textSetVisibility
.
In this mode, entered text is displayed using a “invisible” character.
By default, GTK picks the best invisible character that is available
in the current font, but it can be changed with textSetInvisibleChar
.
If you are looking to add icons or progress display in an entry, look
at Entry
. There other alternatives for more specialized use cases,
such as SearchEntry
.
If you need multi-line editable text, look at TextView
.
CSS nodes
plain code
text[.read-only] ├── placeholder ├── undershoot.left ├── undershoot.right ├── [selection] ├── [block-cursor] ╰── [window.popup]
GtkText has a main node with the name text. Depending on the properties of the widget, the .read-only style class may appear.
When the entry has a selection, it adds a subnode with the name selection.
When the entry is in overwrite mode, it adds a subnode with the name block-cursor that determines how the block cursor is drawn.
The CSS node for a context menu is added as a subnode below text as well.
The undershoot nodes are used to draw the underflow indication when content is scrolled out of view. These nodes get the .left and .right style classes added depending on where the indication is drawn.
When touch is used and touch selection handles are shown, they are using CSS nodes with name cursor-handle. They get the .top or .bottom style class depending on where they are shown in relation to the selection. If there is just a single handle for the text cursor, it gets the style class .insertion-cursor.
Accessibility
GtkText uses the GTK_ACCESSIBLE_ROLE_NONE
role, which causes it to be skipped
for accessibility. This is because GtkText is expected to be used as a delegate
for a Editable
implementation that will be represented to accessibility.
Synopsis
- newtype Text = Text (ManagedPtr Text)
- class (GObject o, IsDescendantOf Text o) => IsText o
- toText :: (MonadIO m, IsText o) => o -> m Text
- textGetActivatesDefault :: (HasCallStack, MonadIO m, IsText a) => a -> m Bool
- textGetAttributes :: (HasCallStack, MonadIO m, IsText a) => a -> m (Maybe AttrList)
- textGetBuffer :: (HasCallStack, MonadIO m, IsText a) => a -> m EntryBuffer
- textGetEnableEmojiCompletion :: (HasCallStack, MonadIO m, IsText a) => a -> m Bool
- textGetExtraMenu :: (HasCallStack, MonadIO m, IsText a) => a -> m (Maybe MenuModel)
- textGetInputHints :: (HasCallStack, MonadIO m, IsText a) => a -> m [InputHints]
- textGetInputPurpose :: (HasCallStack, MonadIO m, IsText a) => a -> m InputPurpose
- textGetInvisibleChar :: (HasCallStack, MonadIO m, IsText a) => a -> m Char
- textGetMaxLength :: (HasCallStack, MonadIO m, IsText a) => a -> m Int32
- textGetOverwriteMode :: (HasCallStack, MonadIO m, IsText a) => a -> m Bool
- textGetPlaceholderText :: (HasCallStack, MonadIO m, IsText a) => a -> m (Maybe Text)
- textGetPropagateTextWidth :: (HasCallStack, MonadIO m, IsText a) => a -> m Bool
- textGetTabs :: (HasCallStack, MonadIO m, IsText a) => a -> m (Maybe TabArray)
- textGetTextLength :: (HasCallStack, MonadIO m, IsText a) => a -> m Word16
- textGetTruncateMultiline :: (HasCallStack, MonadIO m, IsText a) => a -> m Bool
- textGetVisibility :: (HasCallStack, MonadIO m, IsText a) => a -> m Bool
- textGrabFocusWithoutSelecting :: (HasCallStack, MonadIO m, IsText a) => a -> m Bool
- textNew :: (HasCallStack, MonadIO m) => m Text
- textNewWithBuffer :: (HasCallStack, MonadIO m, IsEntryBuffer a) => a -> m Text
- textSetActivatesDefault :: (HasCallStack, MonadIO m, IsText a) => a -> Bool -> m ()
- textSetAttributes :: (HasCallStack, MonadIO m, IsText a) => a -> Maybe AttrList -> m ()
- textSetBuffer :: (HasCallStack, MonadIO m, IsText a, IsEntryBuffer b) => a -> b -> m ()
- textSetEnableEmojiCompletion :: (HasCallStack, MonadIO m, IsText a) => a -> Bool -> m ()
- textSetExtraMenu :: (HasCallStack, MonadIO m, IsText a, IsMenuModel b) => a -> Maybe b -> m ()
- textSetInputHints :: (HasCallStack, MonadIO m, IsText a) => a -> [InputHints] -> m ()
- textSetInputPurpose :: (HasCallStack, MonadIO m, IsText a) => a -> InputPurpose -> m ()
- textSetInvisibleChar :: (HasCallStack, MonadIO m, IsText a) => a -> Char -> m ()
- textSetMaxLength :: (HasCallStack, MonadIO m, IsText a) => a -> Int32 -> m ()
- textSetOverwriteMode :: (HasCallStack, MonadIO m, IsText a) => a -> Bool -> m ()
- textSetPlaceholderText :: (HasCallStack, MonadIO m, IsText a) => a -> Maybe Text -> m ()
- textSetPropagateTextWidth :: (HasCallStack, MonadIO m, IsText a) => a -> Bool -> m ()
- textSetTabs :: (HasCallStack, MonadIO m, IsText a) => a -> Maybe TabArray -> m ()
- textSetTruncateMultiline :: (HasCallStack, MonadIO m, IsText a) => a -> Bool -> m ()
- textSetVisibility :: (HasCallStack, MonadIO m, IsText a) => a -> Bool -> m ()
- textUnsetInvisibleChar :: (HasCallStack, MonadIO m, IsText a) => a -> m ()
- constructTextActivatesDefault :: (IsText o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTextActivatesDefault :: (MonadIO m, IsText o) => o -> m Bool
- setTextActivatesDefault :: (MonadIO m, IsText o) => o -> Bool -> m ()
- clearTextAttributes :: (MonadIO m, IsText o) => o -> m ()
- constructTextAttributes :: (IsText o, MonadIO m) => AttrList -> m (GValueConstruct o)
- getTextAttributes :: (MonadIO m, IsText o) => o -> m (Maybe AttrList)
- setTextAttributes :: (MonadIO m, IsText o) => o -> AttrList -> m ()
- constructTextBuffer :: (IsText o, MonadIO m, IsEntryBuffer a) => a -> m (GValueConstruct o)
- getTextBuffer :: (MonadIO m, IsText o) => o -> m EntryBuffer
- setTextBuffer :: (MonadIO m, IsText o, IsEntryBuffer a) => o -> a -> m ()
- constructTextEnableEmojiCompletion :: (IsText o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTextEnableEmojiCompletion :: (MonadIO m, IsText o) => o -> m Bool
- setTextEnableEmojiCompletion :: (MonadIO m, IsText o) => o -> Bool -> m ()
- clearTextExtraMenu :: (MonadIO m, IsText o) => o -> m ()
- constructTextExtraMenu :: (IsText o, MonadIO m, IsMenuModel a) => a -> m (GValueConstruct o)
- getTextExtraMenu :: (MonadIO m, IsText o) => o -> m (Maybe MenuModel)
- setTextExtraMenu :: (MonadIO m, IsText o, IsMenuModel a) => o -> a -> m ()
- clearTextImModule :: (MonadIO m, IsText o) => o -> m ()
- constructTextImModule :: (IsText o, MonadIO m) => Text -> m (GValueConstruct o)
- getTextImModule :: (MonadIO m, IsText o) => o -> m (Maybe Text)
- setTextImModule :: (MonadIO m, IsText o) => o -> Text -> m ()
- constructTextInputHints :: (IsText o, MonadIO m) => [InputHints] -> m (GValueConstruct o)
- getTextInputHints :: (MonadIO m, IsText o) => o -> m [InputHints]
- setTextInputHints :: (MonadIO m, IsText o) => o -> [InputHints] -> m ()
- constructTextInputPurpose :: (IsText o, MonadIO m) => InputPurpose -> m (GValueConstruct o)
- getTextInputPurpose :: (MonadIO m, IsText o) => o -> m InputPurpose
- setTextInputPurpose :: (MonadIO m, IsText o) => o -> InputPurpose -> m ()
- constructTextInvisibleChar :: (IsText o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getTextInvisibleChar :: (MonadIO m, IsText o) => o -> m Word32
- setTextInvisibleChar :: (MonadIO m, IsText o) => o -> Word32 -> m ()
- constructTextInvisibleCharSet :: (IsText o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTextInvisibleCharSet :: (MonadIO m, IsText o) => o -> m Bool
- setTextInvisibleCharSet :: (MonadIO m, IsText o) => o -> Bool -> m ()
- constructTextMaxLength :: (IsText o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getTextMaxLength :: (MonadIO m, IsText o) => o -> m Int32
- setTextMaxLength :: (MonadIO m, IsText o) => o -> Int32 -> m ()
- constructTextOverwriteMode :: (IsText o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTextOverwriteMode :: (MonadIO m, IsText o) => o -> m Bool
- setTextOverwriteMode :: (MonadIO m, IsText o) => o -> Bool -> m ()
- clearTextPlaceholderText :: (MonadIO m, IsText o) => o -> m ()
- constructTextPlaceholderText :: (IsText o, MonadIO m) => Text -> m (GValueConstruct o)
- getTextPlaceholderText :: (MonadIO m, IsText o) => o -> m (Maybe Text)
- setTextPlaceholderText :: (MonadIO m, IsText o) => o -> Text -> m ()
- constructTextPropagateTextWidth :: (IsText o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTextPropagateTextWidth :: (MonadIO m, IsText o) => o -> m Bool
- setTextPropagateTextWidth :: (MonadIO m, IsText o) => o -> Bool -> m ()
- getTextScrollOffset :: (MonadIO m, IsText o) => o -> m Int32
- clearTextTabs :: (MonadIO m, IsText o) => o -> m ()
- constructTextTabs :: (IsText o, MonadIO m) => TabArray -> m (GValueConstruct o)
- getTextTabs :: (MonadIO m, IsText o) => o -> m (Maybe TabArray)
- setTextTabs :: (MonadIO m, IsText o) => o -> TabArray -> m ()
- constructTextTruncateMultiline :: (IsText o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTextTruncateMultiline :: (MonadIO m, IsText o) => o -> m Bool
- setTextTruncateMultiline :: (MonadIO m, IsText o) => o -> Bool -> m ()
- constructTextVisibility :: (IsText o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTextVisibility :: (MonadIO m, IsText o) => o -> m Bool
- setTextVisibility :: (MonadIO m, IsText o) => o -> Bool -> m ()
- type C_TextActivateCallback = Ptr () -> Ptr () -> IO ()
- type TextActivateCallback = IO ()
- afterTextActivate :: (IsText a, MonadIO m) => a -> TextActivateCallback -> m SignalHandlerId
- genClosure_TextActivate :: MonadIO m => TextActivateCallback -> m (GClosure C_TextActivateCallback)
- mk_TextActivateCallback :: C_TextActivateCallback -> IO (FunPtr C_TextActivateCallback)
- noTextActivateCallback :: Maybe TextActivateCallback
- onTextActivate :: (IsText a, MonadIO m) => a -> TextActivateCallback -> m SignalHandlerId
- wrap_TextActivateCallback :: TextActivateCallback -> C_TextActivateCallback
- type C_TextBackspaceCallback = Ptr () -> Ptr () -> IO ()
- type TextBackspaceCallback = IO ()
- afterTextBackspace :: (IsText a, MonadIO m) => a -> TextBackspaceCallback -> m SignalHandlerId
- genClosure_TextBackspace :: MonadIO m => TextBackspaceCallback -> m (GClosure C_TextBackspaceCallback)
- mk_TextBackspaceCallback :: C_TextBackspaceCallback -> IO (FunPtr C_TextBackspaceCallback)
- noTextBackspaceCallback :: Maybe TextBackspaceCallback
- onTextBackspace :: (IsText a, MonadIO m) => a -> TextBackspaceCallback -> m SignalHandlerId
- wrap_TextBackspaceCallback :: TextBackspaceCallback -> C_TextBackspaceCallback
- type C_TextCopyClipboardCallback = Ptr () -> Ptr () -> IO ()
- type TextCopyClipboardCallback = IO ()
- afterTextCopyClipboard :: (IsText a, MonadIO m) => a -> TextCopyClipboardCallback -> m SignalHandlerId
- genClosure_TextCopyClipboard :: MonadIO m => TextCopyClipboardCallback -> m (GClosure C_TextCopyClipboardCallback)
- mk_TextCopyClipboardCallback :: C_TextCopyClipboardCallback -> IO (FunPtr C_TextCopyClipboardCallback)
- noTextCopyClipboardCallback :: Maybe TextCopyClipboardCallback
- onTextCopyClipboard :: (IsText a, MonadIO m) => a -> TextCopyClipboardCallback -> m SignalHandlerId
- wrap_TextCopyClipboardCallback :: TextCopyClipboardCallback -> C_TextCopyClipboardCallback
- type C_TextCutClipboardCallback = Ptr () -> Ptr () -> IO ()
- type TextCutClipboardCallback = IO ()
- afterTextCutClipboard :: (IsText a, MonadIO m) => a -> TextCutClipboardCallback -> m SignalHandlerId
- genClosure_TextCutClipboard :: MonadIO m => TextCutClipboardCallback -> m (GClosure C_TextCutClipboardCallback)
- mk_TextCutClipboardCallback :: C_TextCutClipboardCallback -> IO (FunPtr C_TextCutClipboardCallback)
- noTextCutClipboardCallback :: Maybe TextCutClipboardCallback
- onTextCutClipboard :: (IsText a, MonadIO m) => a -> TextCutClipboardCallback -> m SignalHandlerId
- wrap_TextCutClipboardCallback :: TextCutClipboardCallback -> C_TextCutClipboardCallback
- type C_TextDeleteFromCursorCallback = Ptr () -> CUInt -> Int32 -> Ptr () -> IO ()
- type TextDeleteFromCursorCallback = DeleteType -> Int32 -> IO ()
- afterTextDeleteFromCursor :: (IsText a, MonadIO m) => a -> TextDeleteFromCursorCallback -> m SignalHandlerId
- genClosure_TextDeleteFromCursor :: MonadIO m => TextDeleteFromCursorCallback -> m (GClosure C_TextDeleteFromCursorCallback)
- mk_TextDeleteFromCursorCallback :: C_TextDeleteFromCursorCallback -> IO (FunPtr C_TextDeleteFromCursorCallback)
- noTextDeleteFromCursorCallback :: Maybe TextDeleteFromCursorCallback
- onTextDeleteFromCursor :: (IsText a, MonadIO m) => a -> TextDeleteFromCursorCallback -> m SignalHandlerId
- wrap_TextDeleteFromCursorCallback :: TextDeleteFromCursorCallback -> C_TextDeleteFromCursorCallback
- type C_TextInsertAtCursorCallback = Ptr () -> CString -> Ptr () -> IO ()
- type TextInsertAtCursorCallback = Text -> IO ()
- afterTextInsertAtCursor :: (IsText a, MonadIO m) => a -> TextInsertAtCursorCallback -> m SignalHandlerId
- genClosure_TextInsertAtCursor :: MonadIO m => TextInsertAtCursorCallback -> m (GClosure C_TextInsertAtCursorCallback)
- mk_TextInsertAtCursorCallback :: C_TextInsertAtCursorCallback -> IO (FunPtr C_TextInsertAtCursorCallback)
- noTextInsertAtCursorCallback :: Maybe TextInsertAtCursorCallback
- onTextInsertAtCursor :: (IsText a, MonadIO m) => a -> TextInsertAtCursorCallback -> m SignalHandlerId
- wrap_TextInsertAtCursorCallback :: TextInsertAtCursorCallback -> C_TextInsertAtCursorCallback
- type C_TextInsertEmojiCallback = Ptr () -> Ptr () -> IO ()
- type TextInsertEmojiCallback = IO ()
- afterTextInsertEmoji :: (IsText a, MonadIO m) => a -> TextInsertEmojiCallback -> m SignalHandlerId
- genClosure_TextInsertEmoji :: MonadIO m => TextInsertEmojiCallback -> m (GClosure C_TextInsertEmojiCallback)
- mk_TextInsertEmojiCallback :: C_TextInsertEmojiCallback -> IO (FunPtr C_TextInsertEmojiCallback)
- noTextInsertEmojiCallback :: Maybe TextInsertEmojiCallback
- onTextInsertEmoji :: (IsText a, MonadIO m) => a -> TextInsertEmojiCallback -> m SignalHandlerId
- wrap_TextInsertEmojiCallback :: TextInsertEmojiCallback -> C_TextInsertEmojiCallback
- type C_TextMoveCursorCallback = Ptr () -> CUInt -> Int32 -> CInt -> Ptr () -> IO ()
- type TextMoveCursorCallback = MovementStep -> Int32 -> Bool -> IO ()
- afterTextMoveCursor :: (IsText a, MonadIO m) => a -> TextMoveCursorCallback -> m SignalHandlerId
- genClosure_TextMoveCursor :: MonadIO m => TextMoveCursorCallback -> m (GClosure C_TextMoveCursorCallback)
- mk_TextMoveCursorCallback :: C_TextMoveCursorCallback -> IO (FunPtr C_TextMoveCursorCallback)
- noTextMoveCursorCallback :: Maybe TextMoveCursorCallback
- onTextMoveCursor :: (IsText a, MonadIO m) => a -> TextMoveCursorCallback -> m SignalHandlerId
- wrap_TextMoveCursorCallback :: TextMoveCursorCallback -> C_TextMoveCursorCallback
- type C_TextPasteClipboardCallback = Ptr () -> Ptr () -> IO ()
- type TextPasteClipboardCallback = IO ()
- afterTextPasteClipboard :: (IsText a, MonadIO m) => a -> TextPasteClipboardCallback -> m SignalHandlerId
- genClosure_TextPasteClipboard :: MonadIO m => TextPasteClipboardCallback -> m (GClosure C_TextPasteClipboardCallback)
- mk_TextPasteClipboardCallback :: C_TextPasteClipboardCallback -> IO (FunPtr C_TextPasteClipboardCallback)
- noTextPasteClipboardCallback :: Maybe TextPasteClipboardCallback
- onTextPasteClipboard :: (IsText a, MonadIO m) => a -> TextPasteClipboardCallback -> m SignalHandlerId
- wrap_TextPasteClipboardCallback :: TextPasteClipboardCallback -> C_TextPasteClipboardCallback
- type C_TextPreeditChangedCallback = Ptr () -> CString -> Ptr () -> IO ()
- type TextPreeditChangedCallback = Text -> IO ()
- afterTextPreeditChanged :: (IsText a, MonadIO m) => a -> TextPreeditChangedCallback -> m SignalHandlerId
- genClosure_TextPreeditChanged :: MonadIO m => TextPreeditChangedCallback -> m (GClosure C_TextPreeditChangedCallback)
- mk_TextPreeditChangedCallback :: C_TextPreeditChangedCallback -> IO (FunPtr C_TextPreeditChangedCallback)
- noTextPreeditChangedCallback :: Maybe TextPreeditChangedCallback
- onTextPreeditChanged :: (IsText a, MonadIO m) => a -> TextPreeditChangedCallback -> m SignalHandlerId
- wrap_TextPreeditChangedCallback :: TextPreeditChangedCallback -> C_TextPreeditChangedCallback
- type C_TextToggleOverwriteCallback = Ptr () -> Ptr () -> IO ()
- type TextToggleOverwriteCallback = IO ()
- afterTextToggleOverwrite :: (IsText a, MonadIO m) => a -> TextToggleOverwriteCallback -> m SignalHandlerId
- genClosure_TextToggleOverwrite :: MonadIO m => TextToggleOverwriteCallback -> m (GClosure C_TextToggleOverwriteCallback)
- mk_TextToggleOverwriteCallback :: C_TextToggleOverwriteCallback -> IO (FunPtr C_TextToggleOverwriteCallback)
- noTextToggleOverwriteCallback :: Maybe TextToggleOverwriteCallback
- onTextToggleOverwrite :: (IsText a, MonadIO m) => a -> TextToggleOverwriteCallback -> m SignalHandlerId
- wrap_TextToggleOverwriteCallback :: TextToggleOverwriteCallback -> C_TextToggleOverwriteCallback
Exported types
Memory-managed wrapper type.
Instances
Eq Text Source # | |
GObject Text Source # | |
Defined in GI.Gtk.Objects.Text | |
ManagedPtrNewtype Text Source # | |
Defined in GI.Gtk.Objects.Text toManagedPtr :: Text -> ManagedPtr Text | |
TypedObject Text Source # | |
Defined in GI.Gtk.Objects.Text | |
HasParentTypes Text Source # | |
Defined in GI.Gtk.Objects.Text | |
IsGValue (Maybe Text) Source # | Convert |
Defined in GI.Gtk.Objects.Text gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Text -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Text) | |
type ParentTypes Text Source # | |
Defined in GI.Gtk.Objects.Text |
class (GObject o, IsDescendantOf Text o) => IsText o Source #
Instances
(GObject o, IsDescendantOf Text o) => IsText o Source # | |
Defined in GI.Gtk.Objects.Text |
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, deleteSelection, deleteText, dragCheckThreshold, errorBell, finishDelegate, forceFloating, freezeNotify, getv, grabFocus, grabFocusWithoutSelecting, 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, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetInvisibleChar, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccessibleRole, getActivatesDefault, getAlignment, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAttributes, getBuffer, getBuildableId, getCanFocus, getCanTarget, getChars, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDelegate, getDirection, getDisplay, getEditable, getEnableEmojiCompletion, getEnableUndo, getExtraMenu, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getInputHints, getInputPurpose, getInvisibleChar, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMaxLength, getMaxWidthChars, getName, getNative, getNextSibling, getOpacity, getOverflow, getOverwriteMode, getPangoContext, getParent, getPlaceholderText, getPosition, getPreferredSize, getPrevSibling, getPrimaryClipboard, getPropagateTextWidth, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSelectionBounds, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTabs, getTemplateChild, getText, getTextLength, getTooltipMarkup, getTooltipText, getTruncateMultiline, getValign, getVexpand, getVexpandSet, getVisibility, getVisible, getWidth, getWidthChars.
Setters
setActivatesDefault, setAlignment, setAttributes, setBuffer, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setEditable, setEnableEmojiCompletion, setEnableUndo, setExtraMenu, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setInputHints, setInputPurpose, setInvisibleChar, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setMaxLength, setMaxWidthChars, setName, setOpacity, setOverflow, setOverwriteMode, setParent, setPlaceholderText, setPosition, setPropagateTextWidth, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTabs, setText, setTooltipMarkup, setTooltipText, setTruncateMultiline, setValign, setVexpand, setVexpandSet, setVisibility, setVisible, setWidthChars.
getActivatesDefault
textGetActivatesDefault Source #
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m Bool | Returns: |
Retrieves the value set by textSetActivatesDefault
.
getAttributes
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m (Maybe AttrList) | Returns: the attribute list, or |
Gets the attribute list that was set on the self using
textSetAttributes
, if any.
getBuffer
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m EntryBuffer | Returns: A |
Get the EntryBuffer
object which holds the text for
this self.
getEnableEmojiCompletion
textGetEnableEmojiCompletion Source #
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether Emoji completion is enabled for this GtkText widget.
getExtraMenu
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m (Maybe MenuModel) | Returns: the menu model |
Gets the menu model set with textSetExtraMenu
.
getInputHints
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m [InputHints] |
Gets the value of the Text
:input-hints
property.
getInputPurpose
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m InputPurpose |
Gets the value of the Text
:input-purpose
property.
getInvisibleChar
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m Char | Returns: the current invisible char, or 0, if |
Retrieves the character displayed in place of the real characters
for entries with visibility set to false. Note that GTK does not
compute this value unless it needs it, so the value returned by
this function is not very useful unless it has been explicitly
set with textSetInvisibleChar
getMaxLength
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m Int32 | Returns: the maximum allowed number of characters
in |
Retrieves the maximum allowed length of the text in
self
. See textSetMaxLength
.
This is equivalent to getting self
's EntryBuffer
and
calling entryBufferGetMaxLength
on it.
getOverwriteMode
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m Bool | Returns: whether the text is overwritten when typing. |
Gets the value set by textSetOverwriteMode
.
getPlaceholderText
textGetPlaceholderText Source #
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m (Maybe Text) | Returns: a pointer to the placeholder text as a string.
This string points to internally allocated storage in the widget and must
not be freed, modified or stored. If no placeholder text has been set,
|
Retrieves the text that will be displayed when self
is empty and unfocused
getPropagateTextWidth
textGetPropagateTextWidth Source #
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the Text
will grow and shrink
with the content.
getTabs
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m (Maybe TabArray) | Returns: the tabstops, or |
Gets the tabstops that were set on the self using textSetTabs
, if
any.
getTextLength
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m Word16 | Returns: the current number of characters
in |
Retrieves the current length of the text in
self
.
This is equivalent to getting self
's EntryBuffer
and
calling entryBufferGetLength
on it.
getTruncateMultiline
textGetTruncateMultiline Source #
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the Text
will truncate multi-line text
that is pasted into the widget
getVisibility
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m Bool | Returns: |
Retrieves whether the text in self
is visible.
See textSetVisibility
.
grabFocusWithoutSelecting
textGrabFocusWithoutSelecting Source #
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m Bool | Returns: |
Causes self
to have keyboard focus.
It behaves like widgetGrabFocus
,
except that it doesn't select the contents of self
.
You only want to call this on some special entries
which the user usually doesn't want to replace all text in,
such as search-as-you-type entries.
new
newWithBuffer
:: (HasCallStack, MonadIO m, IsEntryBuffer a) | |
=> a |
|
-> m Text | Returns: a new |
Creates a new self with the specified text buffer.
setActivatesDefault
textSetActivatesDefault Source #
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> Bool |
|
-> m () |
If activates
is True
, pressing Enter in the self
will activate the default
widget for the window containing the self. This usually means that
the dialog box containing the self will be closed, since the default
widget is usually one of the dialog buttons.
setAttributes
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> Maybe AttrList | |
-> m () |
Sets a AttrList
; the attributes in the list are applied to the
text.
setBuffer
:: (HasCallStack, MonadIO m, IsText a, IsEntryBuffer b) | |
=> a |
|
-> b |
|
-> m () |
Set the EntryBuffer
object which holds the text for
this widget.
setEnableEmojiCompletion
textSetEnableEmojiCompletion Source #
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether Emoji completion is enabled. If it is, typing ':', followed by a recognized keyword, will pop up a window with suggested Emojis matching the keyword.
setExtraMenu
:: (HasCallStack, MonadIO m, IsText a, IsMenuModel b) | |
=> a |
|
-> Maybe b |
|
-> m () |
Sets a menu model to add when constructing
the context menu for self
.
setInputHints
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> [InputHints] |
|
-> m () |
Sets the Text
:input-hints
property, which
allows input methods to fine-tune their behaviour.
setInputPurpose
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> InputPurpose |
|
-> m () |
Sets the Text
:input-purpose
property which
can be used by on-screen keyboards and other input
methods to adjust their behaviour.
setInvisibleChar
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> Char |
|
-> m () |
Sets the character to use in place of the actual text when
textSetVisibility
has been called to set text visibility
to False
. i.e. this is the character used in “password mode” to
show the user how many characters have been typed.
By default, GTK picks the best invisible char available in the current font. If you set the invisible char to 0, then the user will get no feedback at all; there will be no text on the screen as they type.
setMaxLength
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> Int32 |
|
-> m () |
Sets the maximum allowed length of the contents of the widget.
If the current contents are longer than the given length, then they will be truncated to fit.
This is equivalent to getting self
's EntryBuffer
and
calling entryBufferSetMaxLength
on it.
]|
setOverwriteMode
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the text is overwritten when typing in the Text
.
setPlaceholderText
textSetPlaceholderText Source #
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> Maybe Text |
|
-> m () |
Sets text to be displayed in self
when it is empty.
This can be used to give a visual hint of the expected contents of the self.
setPropagateTextWidth
textSetPropagateTextWidth Source #
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the GtkText should grow and shrink with the content.
setTabs
Sets a TabArray
; the tabstops in the array are applied to the self
text.
setTruncateMultiline
textSetTruncateMultiline Source #
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the GtkText should truncate multi-line text that is pasted into the widget.
setVisibility
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the contents of the self are visible or not.
When visibility is set to False
, characters are displayed
as the invisible char, and will also appear that way when
the text in the self widget is copied to the clipboard.
By default, GTK picks the best invisible character available
in the current font, but it can be changed with
textSetInvisibleChar
.
Note that you probably want to set Text
:input-purpose
to InputPurposePassword
or InputPurposePin
to
inform input methods about the purpose of this self,
in addition to setting visibility to False
.
unsetInvisibleChar
textUnsetInvisibleChar Source #
:: (HasCallStack, MonadIO m, IsText a) | |
=> a |
|
-> m () |
Unsets the invisible char previously set with
textSetInvisibleChar
. So that the
default invisible char is used again.
Properties
activatesDefault
No description available in the introspection data.
constructTextActivatesDefault :: (IsText o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “activates-default
” property. This is rarely needed directly, but it is used by new
.
getTextActivatesDefault :: (MonadIO m, IsText o) => o -> m Bool Source #
Get the value of the “activates-default
” property.
When overloading is enabled, this is equivalent to
get
text #activatesDefault
setTextActivatesDefault :: (MonadIO m, IsText o) => o -> Bool -> m () Source #
Set the value of the “activates-default
” property.
When overloading is enabled, this is equivalent to
set
text [ #activatesDefault:=
value ]
attributes
A list of Pango attributes to apply to the text of the self.
This is mainly useful to change the size or weight of the text.
The Attribute
's startIndex
and endIndex
must refer to the
EntryBuffer
text, i.e. without the preedit string.
clearTextAttributes :: (MonadIO m, IsText o) => o -> m () Source #
Set the value of the “attributes
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#attributes
constructTextAttributes :: (IsText o, MonadIO m) => AttrList -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “attributes
” property. This is rarely needed directly, but it is used by new
.
getTextAttributes :: (MonadIO m, IsText o) => o -> m (Maybe AttrList) Source #
Get the value of the “attributes
” property.
When overloading is enabled, this is equivalent to
get
text #attributes
setTextAttributes :: (MonadIO m, IsText o) => o -> AttrList -> m () Source #
Set the value of the “attributes
” property.
When overloading is enabled, this is equivalent to
set
text [ #attributes:=
value ]
buffer
No description available in the introspection data.
constructTextBuffer :: (IsText o, MonadIO m, IsEntryBuffer a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “buffer
” property. This is rarely needed directly, but it is used by new
.
getTextBuffer :: (MonadIO m, IsText o) => o -> m EntryBuffer Source #
Get the value of the “buffer
” property.
When overloading is enabled, this is equivalent to
get
text #buffer
setTextBuffer :: (MonadIO m, IsText o, IsEntryBuffer a) => o -> a -> m () Source #
Set the value of the “buffer
” property.
When overloading is enabled, this is equivalent to
set
text [ #buffer:=
value ]
enableEmojiCompletion
No description available in the introspection data.
constructTextEnableEmojiCompletion :: (IsText o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “enable-emoji-completion
” property. This is rarely needed directly, but it is used by new
.
getTextEnableEmojiCompletion :: (MonadIO m, IsText o) => o -> m Bool Source #
Get the value of the “enable-emoji-completion
” property.
When overloading is enabled, this is equivalent to
get
text #enableEmojiCompletion
setTextEnableEmojiCompletion :: (MonadIO m, IsText o) => o -> Bool -> m () Source #
Set the value of the “enable-emoji-completion
” property.
When overloading is enabled, this is equivalent to
set
text [ #enableEmojiCompletion:=
value ]
extraMenu
A menu model whose contents will be appended to the context menu.
clearTextExtraMenu :: (MonadIO m, IsText o) => o -> m () Source #
Set the value of the “extra-menu
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#extraMenu
constructTextExtraMenu :: (IsText o, MonadIO m, IsMenuModel a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “extra-menu
” property. This is rarely needed directly, but it is used by new
.
getTextExtraMenu :: (MonadIO m, IsText o) => o -> m (Maybe MenuModel) Source #
Get the value of the “extra-menu
” property.
When overloading is enabled, this is equivalent to
get
text #extraMenu
setTextExtraMenu :: (MonadIO m, IsText o, IsMenuModel a) => o -> a -> m () Source #
Set the value of the “extra-menu
” property.
When overloading is enabled, this is equivalent to
set
text [ #extraMenu:=
value ]
imModule
Which IM (input method) module should be used for this self.
See IMContext
.
Setting this to a non-Nothing
value overrides the
system-wide IM module setting. See the GtkSettings
Settings
:gtk-im-module
property.
clearTextImModule :: (MonadIO m, IsText o) => o -> m () Source #
Set the value of the “im-module
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#imModule
constructTextImModule :: (IsText o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “im-module
” property. This is rarely needed directly, but it is used by new
.
getTextImModule :: (MonadIO m, IsText o) => o -> m (Maybe Text) Source #
Get the value of the “im-module
” property.
When overloading is enabled, this is equivalent to
get
text #imModule
setTextImModule :: (MonadIO m, IsText o) => o -> Text -> m () Source #
Set the value of the “im-module
” property.
When overloading is enabled, this is equivalent to
set
text [ #imModule:=
value ]
inputHints
Additional hints (beyond Text
:input-purpose
) that
allow input methods to fine-tune their behaviour.
constructTextInputHints :: (IsText o, MonadIO m) => [InputHints] -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “input-hints
” property. This is rarely needed directly, but it is used by new
.
getTextInputHints :: (MonadIO m, IsText o) => o -> m [InputHints] Source #
Get the value of the “input-hints
” property.
When overloading is enabled, this is equivalent to
get
text #inputHints
setTextInputHints :: (MonadIO m, IsText o) => o -> [InputHints] -> m () Source #
Set the value of the “input-hints
” property.
When overloading is enabled, this is equivalent to
set
text [ #inputHints:=
value ]
inputPurpose
The purpose of this text field.
This property can be used by on-screen keyboards and other input methods to adjust their behaviour.
Note that setting the purpose to InputPurposePassword
or
InputPurposePin
is independent from setting
Text
:visibility
.
constructTextInputPurpose :: (IsText o, MonadIO m) => InputPurpose -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “input-purpose
” property. This is rarely needed directly, but it is used by new
.
getTextInputPurpose :: (MonadIO m, IsText o) => o -> m InputPurpose Source #
Get the value of the “input-purpose
” property.
When overloading is enabled, this is equivalent to
get
text #inputPurpose
setTextInputPurpose :: (MonadIO m, IsText o) => o -> InputPurpose -> m () Source #
Set the value of the “input-purpose
” property.
When overloading is enabled, this is equivalent to
set
text [ #inputPurpose:=
value ]
invisibleChar
No description available in the introspection data.
constructTextInvisibleChar :: (IsText o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “invisible-char
” property. This is rarely needed directly, but it is used by new
.
getTextInvisibleChar :: (MonadIO m, IsText o) => o -> m Word32 Source #
Get the value of the “invisible-char
” property.
When overloading is enabled, this is equivalent to
get
text #invisibleChar
setTextInvisibleChar :: (MonadIO m, IsText o) => o -> Word32 -> m () Source #
Set the value of the “invisible-char
” property.
When overloading is enabled, this is equivalent to
set
text [ #invisibleChar:=
value ]
invisibleCharSet
Whether the invisible char has been set for the Text
.
constructTextInvisibleCharSet :: (IsText o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “invisible-char-set
” property. This is rarely needed directly, but it is used by new
.
getTextInvisibleCharSet :: (MonadIO m, IsText o) => o -> m Bool Source #
Get the value of the “invisible-char-set
” property.
When overloading is enabled, this is equivalent to
get
text #invisibleCharSet
setTextInvisibleCharSet :: (MonadIO m, IsText o) => o -> Bool -> m () Source #
Set the value of the “invisible-char-set
” property.
When overloading is enabled, this is equivalent to
set
text [ #invisibleCharSet:=
value ]
maxLength
No description available in the introspection data.
constructTextMaxLength :: (IsText o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “max-length
” property. This is rarely needed directly, but it is used by new
.
getTextMaxLength :: (MonadIO m, IsText o) => o -> m Int32 Source #
Get the value of the “max-length
” property.
When overloading is enabled, this is equivalent to
get
text #maxLength
setTextMaxLength :: (MonadIO m, IsText o) => o -> Int32 -> m () Source #
Set the value of the “max-length
” property.
When overloading is enabled, this is equivalent to
set
text [ #maxLength:=
value ]
overwriteMode
If text is overwritten when typing in the Text
.
constructTextOverwriteMode :: (IsText o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “overwrite-mode
” property. This is rarely needed directly, but it is used by new
.
getTextOverwriteMode :: (MonadIO m, IsText o) => o -> m Bool Source #
Get the value of the “overwrite-mode
” property.
When overloading is enabled, this is equivalent to
get
text #overwriteMode
setTextOverwriteMode :: (MonadIO m, IsText o) => o -> Bool -> m () Source #
Set the value of the “overwrite-mode
” property.
When overloading is enabled, this is equivalent to
set
text [ #overwriteMode:=
value ]
placeholderText
The text that will be displayed in the Text
when it is empty
and unfocused.
clearTextPlaceholderText :: (MonadIO m, IsText o) => o -> m () Source #
Set the value of the “placeholder-text
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#placeholderText
constructTextPlaceholderText :: (IsText o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “placeholder-text
” property. This is rarely needed directly, but it is used by new
.
getTextPlaceholderText :: (MonadIO m, IsText o) => o -> m (Maybe Text) Source #
Get the value of the “placeholder-text
” property.
When overloading is enabled, this is equivalent to
get
text #placeholderText
setTextPlaceholderText :: (MonadIO m, IsText o) => o -> Text -> m () Source #
Set the value of the “placeholder-text
” property.
When overloading is enabled, this is equivalent to
set
text [ #placeholderText:=
value ]
propagateTextWidth
No description available in the introspection data.
constructTextPropagateTextWidth :: (IsText o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “propagate-text-width
” property. This is rarely needed directly, but it is used by new
.
getTextPropagateTextWidth :: (MonadIO m, IsText o) => o -> m Bool Source #
Get the value of the “propagate-text-width
” property.
When overloading is enabled, this is equivalent to
get
text #propagateTextWidth
setTextPropagateTextWidth :: (MonadIO m, IsText o) => o -> Bool -> m () Source #
Set the value of the “propagate-text-width
” property.
When overloading is enabled, this is equivalent to
set
text [ #propagateTextWidth:=
value ]
scrollOffset
No description available in the introspection data.
getTextScrollOffset :: (MonadIO m, IsText o) => o -> m Int32 Source #
Get the value of the “scroll-offset
” property.
When overloading is enabled, this is equivalent to
get
text #scrollOffset
tabs
A list of tabstops to apply to the text of the self.
clearTextTabs :: (MonadIO m, IsText o) => o -> m () Source #
Set the value of the “tabs
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#tabs
constructTextTabs :: (IsText o, MonadIO m) => TabArray -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “tabs
” property. This is rarely needed directly, but it is used by new
.
getTextTabs :: (MonadIO m, IsText o) => o -> m (Maybe TabArray) Source #
Get the value of the “tabs
” property.
When overloading is enabled, this is equivalent to
get
text #tabs
setTextTabs :: (MonadIO m, IsText o) => o -> TabArray -> m () Source #
Set the value of the “tabs
” property.
When overloading is enabled, this is equivalent to
set
text [ #tabs:=
value ]
truncateMultiline
When True
, pasted multi-line text is truncated to the first line.
constructTextTruncateMultiline :: (IsText o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “truncate-multiline
” property. This is rarely needed directly, but it is used by new
.
getTextTruncateMultiline :: (MonadIO m, IsText o) => o -> m Bool Source #
Get the value of the “truncate-multiline
” property.
When overloading is enabled, this is equivalent to
get
text #truncateMultiline
setTextTruncateMultiline :: (MonadIO m, IsText o) => o -> Bool -> m () Source #
Set the value of the “truncate-multiline
” property.
When overloading is enabled, this is equivalent to
set
text [ #truncateMultiline:=
value ]
visibility
No description available in the introspection data.
constructTextVisibility :: (IsText o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “visibility
” property. This is rarely needed directly, but it is used by new
.
getTextVisibility :: (MonadIO m, IsText o) => o -> m Bool Source #
Get the value of the “visibility
” property.
When overloading is enabled, this is equivalent to
get
text #visibility
setTextVisibility :: (MonadIO m, IsText o) => o -> Bool -> m () Source #
Set the value of the “visibility
” property.
When overloading is enabled, this is equivalent to
set
text [ #visibility:=
value ]
Signals
activate
type C_TextActivateCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type TextActivateCallback = IO () Source #
The activate signal is emitted when the user hits the Enter key.
The default bindings for this signal are all forms of the Enter key.
afterTextActivate :: (IsText a, MonadIO m) => a -> TextActivateCallback -> m SignalHandlerId Source #
Connect a signal handler for the activate signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
text #activate callback
genClosure_TextActivate :: MonadIO m => TextActivateCallback -> m (GClosure C_TextActivateCallback) Source #
Wrap the callback into a GClosure
.
mk_TextActivateCallback :: C_TextActivateCallback -> IO (FunPtr C_TextActivateCallback) Source #
Generate a function pointer callable from C code, from a C_TextActivateCallback
.
noTextActivateCallback :: Maybe TextActivateCallback Source #
A convenience synonym for
.Nothing
:: Maybe
TextActivateCallback
onTextActivate :: (IsText a, MonadIO m) => a -> TextActivateCallback -> m SignalHandlerId Source #
Connect a signal handler for the activate signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
text #activate callback
wrap_TextActivateCallback :: TextActivateCallback -> C_TextActivateCallback Source #
Wrap a TextActivateCallback
into a C_TextActivateCallback
.
backspace
type C_TextBackspaceCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type TextBackspaceCallback = IO () Source #
The backspace signal is a [keybinding signal][GtkSignalAction] which gets emitted when the user asks for it.
The default bindings for this signal are Backspace and Shift-Backspace.
afterTextBackspace :: (IsText a, MonadIO m) => a -> TextBackspaceCallback -> m SignalHandlerId Source #
Connect a signal handler for the backspace signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
text #backspace callback
genClosure_TextBackspace :: MonadIO m => TextBackspaceCallback -> m (GClosure C_TextBackspaceCallback) Source #
Wrap the callback into a GClosure
.
mk_TextBackspaceCallback :: C_TextBackspaceCallback -> IO (FunPtr C_TextBackspaceCallback) Source #
Generate a function pointer callable from C code, from a C_TextBackspaceCallback
.
noTextBackspaceCallback :: Maybe TextBackspaceCallback Source #
A convenience synonym for
.Nothing
:: Maybe
TextBackspaceCallback
onTextBackspace :: (IsText a, MonadIO m) => a -> TextBackspaceCallback -> m SignalHandlerId Source #
Connect a signal handler for the backspace signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
text #backspace callback
wrap_TextBackspaceCallback :: TextBackspaceCallback -> C_TextBackspaceCallback Source #
Wrap a TextBackspaceCallback
into a C_TextBackspaceCallback
.
copyClipboard
type C_TextCopyClipboardCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type TextCopyClipboardCallback = IO () Source #
The copyClipboard signal is a [keybinding signal][GtkSignalAction] which gets emitted to copy the selection to the clipboard.
The default bindings for this signal are Ctrl-c and Ctrl-Insert.
afterTextCopyClipboard :: (IsText a, MonadIO m) => a -> TextCopyClipboardCallback -> m SignalHandlerId Source #
Connect a signal handler for the copyClipboard signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
text #copyClipboard callback
genClosure_TextCopyClipboard :: MonadIO m => TextCopyClipboardCallback -> m (GClosure C_TextCopyClipboardCallback) Source #
Wrap the callback into a GClosure
.
mk_TextCopyClipboardCallback :: C_TextCopyClipboardCallback -> IO (FunPtr C_TextCopyClipboardCallback) Source #
Generate a function pointer callable from C code, from a C_TextCopyClipboardCallback
.
noTextCopyClipboardCallback :: Maybe TextCopyClipboardCallback Source #
A convenience synonym for
.Nothing
:: Maybe
TextCopyClipboardCallback
onTextCopyClipboard :: (IsText a, MonadIO m) => a -> TextCopyClipboardCallback -> m SignalHandlerId Source #
Connect a signal handler for the copyClipboard signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
text #copyClipboard callback
wrap_TextCopyClipboardCallback :: TextCopyClipboardCallback -> C_TextCopyClipboardCallback Source #
Wrap a TextCopyClipboardCallback
into a C_TextCopyClipboardCallback
.
cutClipboard
type C_TextCutClipboardCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type TextCutClipboardCallback = IO () Source #
The cutClipboard signal is a [keybinding signal][GtkSignalAction] which gets emitted to cut the selection to the clipboard.
The default bindings for this signal are Ctrl-x and Shift-Delete.
afterTextCutClipboard :: (IsText a, MonadIO m) => a -> TextCutClipboardCallback -> m SignalHandlerId Source #
Connect a signal handler for the cutClipboard signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
text #cutClipboard callback
genClosure_TextCutClipboard :: MonadIO m => TextCutClipboardCallback -> m (GClosure C_TextCutClipboardCallback) Source #
Wrap the callback into a GClosure
.
mk_TextCutClipboardCallback :: C_TextCutClipboardCallback -> IO (FunPtr C_TextCutClipboardCallback) Source #
Generate a function pointer callable from C code, from a C_TextCutClipboardCallback
.
noTextCutClipboardCallback :: Maybe TextCutClipboardCallback Source #
A convenience synonym for
.Nothing
:: Maybe
TextCutClipboardCallback
onTextCutClipboard :: (IsText a, MonadIO m) => a -> TextCutClipboardCallback -> m SignalHandlerId Source #
Connect a signal handler for the cutClipboard signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
text #cutClipboard callback
wrap_TextCutClipboardCallback :: TextCutClipboardCallback -> C_TextCutClipboardCallback Source #
Wrap a TextCutClipboardCallback
into a C_TextCutClipboardCallback
.
deleteFromCursor
type C_TextDeleteFromCursorCallback = Ptr () -> CUInt -> Int32 -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type TextDeleteFromCursorCallback Source #
= DeleteType |
|
-> Int32 |
|
-> IO () |
The deleteFromCursor signal is a [keybinding signal][GtkSignalAction] which gets emitted when the user initiates a text deletion.
If the type
is DeleteTypeChars
, GTK deletes the selection
if there is one, otherwise it deletes the requested number
of characters.
The default bindings for this signal are Delete for deleting a character and Ctrl-Delete for deleting a word.
afterTextDeleteFromCursor :: (IsText a, MonadIO m) => a -> TextDeleteFromCursorCallback -> m SignalHandlerId Source #
Connect a signal handler for the deleteFromCursor signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
text #deleteFromCursor callback
genClosure_TextDeleteFromCursor :: MonadIO m => TextDeleteFromCursorCallback -> m (GClosure C_TextDeleteFromCursorCallback) Source #
Wrap the callback into a GClosure
.
mk_TextDeleteFromCursorCallback :: C_TextDeleteFromCursorCallback -> IO (FunPtr C_TextDeleteFromCursorCallback) Source #
Generate a function pointer callable from C code, from a C_TextDeleteFromCursorCallback
.
noTextDeleteFromCursorCallback :: Maybe TextDeleteFromCursorCallback Source #
A convenience synonym for
.Nothing
:: Maybe
TextDeleteFromCursorCallback
onTextDeleteFromCursor :: (IsText a, MonadIO m) => a -> TextDeleteFromCursorCallback -> m SignalHandlerId Source #
Connect a signal handler for the deleteFromCursor signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
text #deleteFromCursor callback
wrap_TextDeleteFromCursorCallback :: TextDeleteFromCursorCallback -> C_TextDeleteFromCursorCallback Source #
Wrap a TextDeleteFromCursorCallback
into a C_TextDeleteFromCursorCallback
.
insertAtCursor
type C_TextInsertAtCursorCallback = Ptr () -> CString -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type TextInsertAtCursorCallback Source #
The insertAtCursor signal is a [keybinding signal][GtkSignalAction] which gets emitted when the user initiates the insertion of a fixed string at the cursor.
This signal has no default bindings.
afterTextInsertAtCursor :: (IsText a, MonadIO m) => a -> TextInsertAtCursorCallback -> m SignalHandlerId Source #
Connect a signal handler for the insertAtCursor signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
text #insertAtCursor callback
genClosure_TextInsertAtCursor :: MonadIO m => TextInsertAtCursorCallback -> m (GClosure C_TextInsertAtCursorCallback) Source #
Wrap the callback into a GClosure
.
mk_TextInsertAtCursorCallback :: C_TextInsertAtCursorCallback -> IO (FunPtr C_TextInsertAtCursorCallback) Source #
Generate a function pointer callable from C code, from a C_TextInsertAtCursorCallback
.
noTextInsertAtCursorCallback :: Maybe TextInsertAtCursorCallback Source #
A convenience synonym for
.Nothing
:: Maybe
TextInsertAtCursorCallback
onTextInsertAtCursor :: (IsText a, MonadIO m) => a -> TextInsertAtCursorCallback -> m SignalHandlerId Source #
Connect a signal handler for the insertAtCursor signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
text #insertAtCursor callback
wrap_TextInsertAtCursorCallback :: TextInsertAtCursorCallback -> C_TextInsertAtCursorCallback Source #
Wrap a TextInsertAtCursorCallback
into a C_TextInsertAtCursorCallback
.
insertEmoji
type C_TextInsertEmojiCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type TextInsertEmojiCallback = IO () Source #
The insertEmoji signal is a
[keybinding signal][GtkSignalAction]
which gets emitted to present the Emoji chooser for the self
.
The default bindings for this signal are Ctrl-. and Ctrl-;
afterTextInsertEmoji :: (IsText a, MonadIO m) => a -> TextInsertEmojiCallback -> m SignalHandlerId Source #
Connect a signal handler for the insertEmoji signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
text #insertEmoji callback
genClosure_TextInsertEmoji :: MonadIO m => TextInsertEmojiCallback -> m (GClosure C_TextInsertEmojiCallback) Source #
Wrap the callback into a GClosure
.
mk_TextInsertEmojiCallback :: C_TextInsertEmojiCallback -> IO (FunPtr C_TextInsertEmojiCallback) Source #
Generate a function pointer callable from C code, from a C_TextInsertEmojiCallback
.
noTextInsertEmojiCallback :: Maybe TextInsertEmojiCallback Source #
A convenience synonym for
.Nothing
:: Maybe
TextInsertEmojiCallback
onTextInsertEmoji :: (IsText a, MonadIO m) => a -> TextInsertEmojiCallback -> m SignalHandlerId Source #
Connect a signal handler for the insertEmoji signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
text #insertEmoji callback
wrap_TextInsertEmojiCallback :: TextInsertEmojiCallback -> C_TextInsertEmojiCallback Source #
Wrap a TextInsertEmojiCallback
into a C_TextInsertEmojiCallback
.
moveCursor
type C_TextMoveCursorCallback = Ptr () -> CUInt -> Int32 -> CInt -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type TextMoveCursorCallback Source #
= MovementStep |
|
-> Int32 |
|
-> Bool |
|
-> IO () |
The moveCursor signal is a
[keybinding signal][GtkSignalAction]
which gets emitted when the user initiates a cursor movement.
If the cursor is not visible in self
, this signal causes
the viewport to be moved instead.
Applications should not connect to it, but may emit it with
g_signal_emit_by_name()
if they need to control the cursor
programmatically.
The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifier does not. There are too many key combinations to list them all here.
- Arrow keys move by individual characters/lines
- Ctrl-arrow key combinations move by words/paragraphs
- Home/End keys move to the ends of the buffer
afterTextMoveCursor :: (IsText a, MonadIO m) => a -> TextMoveCursorCallback -> m SignalHandlerId Source #
Connect a signal handler for the moveCursor signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
text #moveCursor callback
genClosure_TextMoveCursor :: MonadIO m => TextMoveCursorCallback -> m (GClosure C_TextMoveCursorCallback) Source #
Wrap the callback into a GClosure
.
mk_TextMoveCursorCallback :: C_TextMoveCursorCallback -> IO (FunPtr C_TextMoveCursorCallback) Source #
Generate a function pointer callable from C code, from a C_TextMoveCursorCallback
.
noTextMoveCursorCallback :: Maybe TextMoveCursorCallback Source #
A convenience synonym for
.Nothing
:: Maybe
TextMoveCursorCallback
onTextMoveCursor :: (IsText a, MonadIO m) => a -> TextMoveCursorCallback -> m SignalHandlerId Source #
Connect a signal handler for the moveCursor signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
text #moveCursor callback
wrap_TextMoveCursorCallback :: TextMoveCursorCallback -> C_TextMoveCursorCallback Source #
Wrap a TextMoveCursorCallback
into a C_TextMoveCursorCallback
.
pasteClipboard
type C_TextPasteClipboardCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type TextPasteClipboardCallback = IO () Source #
The pasteClipboard signal is a [keybinding signal][GtkSignalAction] which gets emitted to paste the contents of the clipboard into the text view.
The default bindings for this signal are Ctrl-v and Shift-Insert.
afterTextPasteClipboard :: (IsText a, MonadIO m) => a -> TextPasteClipboardCallback -> m SignalHandlerId Source #
Connect a signal handler for the pasteClipboard signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
text #pasteClipboard callback
genClosure_TextPasteClipboard :: MonadIO m => TextPasteClipboardCallback -> m (GClosure C_TextPasteClipboardCallback) Source #
Wrap the callback into a GClosure
.
mk_TextPasteClipboardCallback :: C_TextPasteClipboardCallback -> IO (FunPtr C_TextPasteClipboardCallback) Source #
Generate a function pointer callable from C code, from a C_TextPasteClipboardCallback
.
noTextPasteClipboardCallback :: Maybe TextPasteClipboardCallback Source #
A convenience synonym for
.Nothing
:: Maybe
TextPasteClipboardCallback
onTextPasteClipboard :: (IsText a, MonadIO m) => a -> TextPasteClipboardCallback -> m SignalHandlerId Source #
Connect a signal handler for the pasteClipboard signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
text #pasteClipboard callback
wrap_TextPasteClipboardCallback :: TextPasteClipboardCallback -> C_TextPasteClipboardCallback Source #
Wrap a TextPasteClipboardCallback
into a C_TextPasteClipboardCallback
.
preeditChanged
type C_TextPreeditChangedCallback = Ptr () -> CString -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type TextPreeditChangedCallback Source #
If an input method is used, the typed text will not immediately be committed to the buffer. So if you are interested in the text, connect to this signal.
afterTextPreeditChanged :: (IsText a, MonadIO m) => a -> TextPreeditChangedCallback -> m SignalHandlerId Source #
Connect a signal handler for the preeditChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
text #preeditChanged callback
genClosure_TextPreeditChanged :: MonadIO m => TextPreeditChangedCallback -> m (GClosure C_TextPreeditChangedCallback) Source #
Wrap the callback into a GClosure
.
mk_TextPreeditChangedCallback :: C_TextPreeditChangedCallback -> IO (FunPtr C_TextPreeditChangedCallback) Source #
Generate a function pointer callable from C code, from a C_TextPreeditChangedCallback
.
noTextPreeditChangedCallback :: Maybe TextPreeditChangedCallback Source #
A convenience synonym for
.Nothing
:: Maybe
TextPreeditChangedCallback
onTextPreeditChanged :: (IsText a, MonadIO m) => a -> TextPreeditChangedCallback -> m SignalHandlerId Source #
Connect a signal handler for the preeditChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
text #preeditChanged callback
wrap_TextPreeditChangedCallback :: TextPreeditChangedCallback -> C_TextPreeditChangedCallback Source #
Wrap a TextPreeditChangedCallback
into a C_TextPreeditChangedCallback
.
toggleOverwrite
type C_TextToggleOverwriteCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type TextToggleOverwriteCallback = IO () Source #
The toggleOverwrite signal is a [keybinding signal][GtkSignalAction] which gets emitted to toggle the overwrite mode of the self.
The default bindings for this signal is Insert.
afterTextToggleOverwrite :: (IsText a, MonadIO m) => a -> TextToggleOverwriteCallback -> m SignalHandlerId Source #
Connect a signal handler for the toggleOverwrite signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
text #toggleOverwrite callback
genClosure_TextToggleOverwrite :: MonadIO m => TextToggleOverwriteCallback -> m (GClosure C_TextToggleOverwriteCallback) Source #
Wrap the callback into a GClosure
.
mk_TextToggleOverwriteCallback :: C_TextToggleOverwriteCallback -> IO (FunPtr C_TextToggleOverwriteCallback) Source #
Generate a function pointer callable from C code, from a C_TextToggleOverwriteCallback
.
noTextToggleOverwriteCallback :: Maybe TextToggleOverwriteCallback Source #
A convenience synonym for
.Nothing
:: Maybe
TextToggleOverwriteCallback
onTextToggleOverwrite :: (IsText a, MonadIO m) => a -> TextToggleOverwriteCallback -> m SignalHandlerId Source #
Connect a signal handler for the toggleOverwrite signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
text #toggleOverwrite callback