gi-vte-2.91.35: Vte bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Vte.Objects.Terminal

Contents

- Exported types
- Methods
  - copyClipboard
  - copyClipboardFormat
  - copyPrimary
  - dupTermpropString
  - dupTermpropStringById
  - dupTermpropUuid
  - dupTermpropUuidById
  - feed
  - feedChild
  - feedChildBinary
  - getAllowBold
  - getAllowHyperlink
  - getAudibleBell
  - getBoldIsBright
  - getCellHeightScale
  - getCellWidthScale
  - getCharHeight
  - getCharWidth
  - getCjkAmbiguousWidth
  - getColorBackgroundForDraw
  - getColumnCount
  - getContextMenu
  - getContextMenuModel
  - getCurrentDirectoryUri
  - getCurrentFileUri
  - getCursorBlinkMode
  - getCursorPosition
  - getCursorShape
  - getEnableA11y
  - getEnableBidi
  - getEnableFallbackScrolling
  - getEnableLegacyOsc777
  - getEnableShaping
  - getEnableSixel
  - getEncoding
  - getFont
  - getFontOptions
  - getFontScale
  - getGeometryHints
  - getHasSelection
  - getIconTitle
  - getInputEnabled
  - getMouseAutohide
  - getPty
  - getRewrapOnResize
  - getRowCount
  - getScrollOnInsert
  - getScrollOnKeystroke
  - getScrollOnOutput
  - getScrollUnitIsPixels
  - getScrollbackLines
  - getTermpropBool
  - getTermpropBoolById
  - getTermpropData
  - getTermpropDataById
  - getTermpropDouble
  - getTermpropDoubleById
  - getTermpropEnum
  - getTermpropEnumById
  - getTermpropFlags
  - getTermpropFlagsById
  - getTermpropInt
  - getTermpropIntById
  - getTermpropRgba
  - getTermpropRgbaById
  - getTermpropString
  - getTermpropStringById
  - getTermpropUint
  - getTermpropUintById
  - getTermpropValue
  - getTermpropValueById
  - getText
  - getTextBlinkMode
  - getTextFormat
  - getTextIncludeTrailingSpaces
  - getTextRange
  - getTextRangeFormat
  - getTextSelected
  - getTextSelectedFull
  - getWindowTitle
  - getWordCharExceptions
  - getXalign
  - getXfill
  - getYalign
  - getYfill
  - hyperlinkCheckEvent
  - matchAddGregex
  - matchAddRegex
  - matchCheck
  - matchCheckEvent
  - matchRemove
  - matchRemoveAll
  - matchSetCursor
  - matchSetCursorName
  - matchSetCursorType
  - new
  - pasteClipboard
  - pastePrimary
  - pasteText
  - ptyNewSync
  - refTermpropDataBytes
  - refTermpropDataBytesById
  - refTermpropImagePixbuf
  - refTermpropImagePixbufById
  - refTermpropImageSurface
  - refTermpropImageSurfaceById
  - refTermpropUri
  - refTermpropUriById
  - refTermpropVariant
  - refTermpropVariantById
  - reset
  - resetTermprop
  - resetTermpropById
  - searchFindNext
  - searchFindPrevious
  - searchGetGregex
  - searchGetRegex
  - searchGetWrapAround
  - searchSetGregex
  - searchSetRegex
  - searchSetWrapAround
  - selectAll
  - setAllowBold
  - setAllowHyperlink
  - setAudibleBell
  - setBackspaceBinding
  - setBoldIsBright
  - setCellHeightScale
  - setCellWidthScale
  - setCjkAmbiguousWidth
  - setClearBackground
  - setColorBackground
  - setColorBold
  - setColorCursor
  - setColorCursorForeground
  - setColorForeground
  - setColorHighlight
  - setColorHighlightForeground
  - setColors
  - setContextMenu
  - setContextMenuModel
  - setCursorBlinkMode
  - setCursorShape
  - setDefaultColors
  - setDeleteBinding
  - setEnableA11y
  - setEnableBidi
  - setEnableFallbackScrolling
  - setEnableLegacyOsc777
  - setEnableShaping
  - setEnableSixel
  - setEncoding
  - setFont
  - setFontOptions
  - setFontScale
  - setGeometryHintsForWindow
  - setInputEnabled
  - setMouseAutohide
  - setPty
  - setRewrapOnResize
  - setScrollOnInsert
  - setScrollOnKeystroke
  - setScrollOnOutput
  - setScrollUnitIsPixels
  - setScrollbackLines
  - setSize
  - setSuppressLegacySignals
  - setTextBlinkMode
  - setWordCharExceptions
  - setXalign
  - setXfill
  - setYalign
  - setYfill
  - spawnAsync
  - spawnSync
  - spawnWithFdsAsync
  - unselectAll
  - watchChild
  - writeContentsSync
- Properties
  - allowBold
  - allowHyperlink
  - audibleBell
  - backspaceBinding
  - boldIsBright
  - cellHeightScale
  - cellWidthScale
  - cjkAmbiguousWidth
  - contextMenu
  - contextMenuModel
  - currentDirectoryUri
  - currentFileUri
  - cursorBlinkMode
  - cursorShape
  - deleteBinding
  - enableA11y
  - enableBidi
  - enableFallbackScrolling
  - enableLegacyOsc777
  - enableShaping
  - enableSixel
  - encoding
  - fontDesc
  - fontOptions
  - fontScale
  - hyperlinkHoverUri
  - iconTitle
  - inputEnabled
  - pointerAutohide
  - pty
  - rewrapOnResize
  - scrollOnInsert
  - scrollOnKeystroke
  - scrollOnOutput
  - scrollUnitIsPixels
  - scrollbackLines
  - textBlinkMode
  - windowTitle
  - wordCharExceptions
  - xalign
  - xfill
  - yalign
  - yfill
- Signals
  - bell
  - charSizeChanged
  - childExited
  - commit
  - contentsChanged
  - copyClipboard
  - currentDirectoryUriChanged
  - currentFileUriChanged
  - cursorMoved
  - decreaseFontSize
  - deiconifyWindow
  - encodingChanged
  - eof
  - hyperlinkHoverUriChanged
  - iconTitleChanged
  - iconifyWindow
  - increaseFontSize
  - lowerWindow
  - maximizeWindow
  - moveWindow
  - pasteClipboard
  - raiseWindow
  - refreshWindow
  - resizeWindow
  - restoreWindow
  - selectionChanged
  - setupContextMenu
  - termpropChanged
  - termpropsChanged
  - textDeleted
  - textInserted
  - textModified
  - textScrolled
  - windowTitleChanged

Description

No description available in the introspection data.

Synopsis

- newtype Terminal = Terminal (ManagedPtr Terminal)
- class (GObject o, IsDescendantOf Terminal o) => IsTerminal o
- toTerminal :: (MonadIO m, IsTerminal o) => o -> m Terminal
- terminalCopyClipboard :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m ()
- terminalCopyClipboardFormat :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Format -> m ()
- terminalCopyPrimary :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m ()
- terminalDupTermpropString :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Maybe Text, CSize)
- terminalDupTermpropStringById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Maybe Text, CSize)
- terminalDupTermpropUuid :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Maybe Uuid)
- terminalDupTermpropUuidById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Maybe Uuid)
- terminalFeed :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe ByteString -> m ()
- terminalFeedChild :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe ByteString -> m ()
- terminalFeedChildBinary :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe ByteString -> m ()
- terminalGetAllowBold :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetAllowHyperlink :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetAudibleBell :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetBoldIsBright :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetCellHeightScale :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Double
- terminalGetCellWidthScale :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Double
- terminalGetCharHeight :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m CLong
- terminalGetCharWidth :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m CLong
- terminalGetCjkAmbiguousWidth :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Int32
- terminalGetColorBackgroundForDraw :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m RGBA
- terminalGetColumnCount :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m CLong
- terminalGetContextMenu :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m (Maybe Widget)
- terminalGetContextMenuModel :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m (Maybe MenuModel)
- terminalGetCurrentDirectoryUri :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m (Maybe Text)
- terminalGetCurrentFileUri :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m (Maybe Text)
- terminalGetCursorBlinkMode :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m CursorBlinkMode
- terminalGetCursorPosition :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m (CLong, CLong)
- terminalGetCursorShape :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m CursorShape
- terminalGetEnableA11y :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetEnableBidi :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetEnableFallbackScrolling :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetEnableLegacyOsc777 :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetEnableShaping :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetEnableSixel :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetEncoding :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m (Maybe Text)
- terminalGetFont :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m FontDescription
- terminalGetFontOptions :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m (Maybe FontOptions)
- terminalGetFontScale :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Double
- terminalGetGeometryHints :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> Int32 -> m Geometry
- terminalGetHasSelection :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetIconTitle :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m (Maybe Text)
- terminalGetInputEnabled :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetMouseAutohide :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetPty :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m (Maybe Pty)
- terminalGetRewrapOnResize :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetRowCount :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m CLong
- terminalGetScrollOnInsert :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetScrollOnKeystroke :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetScrollOnOutput :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetScrollUnitIsPixels :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetScrollbackLines :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m CLong
- terminalGetTermpropBool :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Bool, Bool)
- terminalGetTermpropBoolById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Bool, Bool)
- terminalGetTermpropData :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Maybe ByteString)
- terminalGetTermpropDataById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Maybe ByteString)
- terminalGetTermpropDouble :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Bool, Double)
- terminalGetTermpropDoubleById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Bool, Double)
- terminalGetTermpropEnum :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> GType -> m (Bool, Int64)
- terminalGetTermpropEnumById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> GType -> m (Bool, Int64)
- terminalGetTermpropFlags :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> GType -> Bool -> m (Bool, Word64)
- terminalGetTermpropFlagsById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> GType -> Bool -> m (Bool, Word64)
- terminalGetTermpropInt :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Bool, Int64)
- terminalGetTermpropIntById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Bool, Int64)
- terminalGetTermpropRgba :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Bool, RGBA)
- terminalGetTermpropRgbaById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Bool, RGBA)
- terminalGetTermpropString :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Maybe Text, CSize)
- terminalGetTermpropStringById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Maybe Text, CSize)
- terminalGetTermpropUint :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Bool, Word64)
- terminalGetTermpropUintById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Bool, Word64)
- terminalGetTermpropValue :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Bool, GValue)
- terminalGetTermpropValueById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Bool, GValue)
- terminalGetText :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe SelectionFunc -> m (Maybe Text, Maybe [CharAttributes])
- terminalGetTextBlinkMode :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m TextBlinkMode
- terminalGetTextFormat :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Format -> m (Maybe Text)
- terminalGetTextIncludeTrailingSpaces :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe SelectionFunc -> m (Text, Maybe [CharAttributes])
- terminalGetTextRange :: (HasCallStack, MonadIO m, IsTerminal a) => a -> CLong -> CLong -> CLong -> CLong -> Maybe SelectionFunc -> m (Maybe Text, Maybe [CharAttributes])
- terminalGetTextRangeFormat :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Format -> CLong -> CLong -> CLong -> CLong -> m (Maybe Text, CSize)
- terminalGetTextSelected :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Format -> m (Maybe Text)
- terminalGetTextSelectedFull :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Format -> m (Maybe Text, CSize)
- terminalGetWindowTitle :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m (Maybe Text)
- terminalGetWordCharExceptions :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m (Maybe Text)
- terminalGetXalign :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Align
- terminalGetXfill :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetYalign :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Align
- terminalGetYfill :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalHyperlinkCheckEvent :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Event -> m (Maybe Text)
- terminalMatchAddGregex :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Regex -> [RegexMatchFlags] -> m Int32
- terminalMatchAddRegex :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Regex -> Word32 -> m Int32
- terminalMatchCheck :: (HasCallStack, MonadIO m, IsTerminal a) => a -> CLong -> CLong -> m (Maybe Text, Int32)
- terminalMatchCheckEvent :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Event -> m (Maybe Text, Int32)
- terminalMatchRemove :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m ()
- terminalMatchRemoveAll :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m ()
- terminalMatchSetCursor :: (HasCallStack, MonadIO m, IsTerminal a, IsCursor b) => a -> Int32 -> Maybe b -> m ()
- terminalMatchSetCursorName :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> Text -> m ()
- terminalMatchSetCursorType :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> CursorType -> m ()
- terminalNew :: (HasCallStack, MonadIO m) => m Terminal
- terminalPasteClipboard :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m ()
- terminalPastePrimary :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m ()
- terminalPasteText :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m ()
- terminalPtyNewSync :: (HasCallStack, MonadIO m, IsTerminal a, IsCancellable b) => a -> [PtyFlags] -> Maybe b -> m Pty
- terminalRefTermpropDataBytes :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Maybe Bytes)
- terminalRefTermpropDataBytesById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Maybe Bytes)
- terminalRefTermpropImagePixbuf :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Maybe Pixbuf)
- terminalRefTermpropImagePixbufById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Maybe Pixbuf)
- terminalRefTermpropImageSurface :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Maybe Surface)
- terminalRefTermpropImageSurfaceById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Maybe Surface)
- terminalRefTermpropUri :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Maybe Uri)
- terminalRefTermpropUriById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Maybe Uri)
- terminalRefTermpropVariant :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m (Maybe GVariant)
- terminalRefTermpropVariantById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m (Maybe GVariant)
- terminalReset :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> Bool -> m ()
- terminalResetTermprop :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m ()
- terminalResetTermpropById :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m ()
- terminalSearchFindNext :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalSearchFindPrevious :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalSearchGetGregex :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Regex
- terminalSearchGetRegex :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Regex
- terminalSearchGetWrapAround :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalSearchSetGregex :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe Regex -> [RegexMatchFlags] -> m ()
- terminalSearchSetRegex :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe Regex -> Word32 -> m ()
- terminalSearchSetWrapAround :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSelectAll :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m ()
- terminalSetAllowBold :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetAllowHyperlink :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetAudibleBell :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetBackspaceBinding :: (HasCallStack, MonadIO m, IsTerminal a) => a -> EraseBinding -> m ()
- terminalSetBoldIsBright :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetCellHeightScale :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Double -> m ()
- terminalSetCellWidthScale :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Double -> m ()
- terminalSetCjkAmbiguousWidth :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m ()
- terminalSetClearBackground :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetColorBackground :: (HasCallStack, MonadIO m, IsTerminal a) => a -> RGBA -> m ()
- terminalSetColorBold :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe RGBA -> m ()
- terminalSetColorCursor :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe RGBA -> m ()
- terminalSetColorCursorForeground :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe RGBA -> m ()
- terminalSetColorForeground :: (HasCallStack, MonadIO m, IsTerminal a) => a -> RGBA -> m ()
- terminalSetColorHighlight :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe RGBA -> m ()
- terminalSetColorHighlightForeground :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe RGBA -> m ()
- terminalSetColors :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe RGBA -> Maybe RGBA -> Maybe [RGBA] -> m ()
- terminalSetContextMenu :: (HasCallStack, MonadIO m, IsTerminal a, IsWidget b) => a -> Maybe b -> m ()
- terminalSetContextMenuModel :: (HasCallStack, MonadIO m, IsTerminal a, IsMenuModel b) => a -> Maybe b -> m ()
- terminalSetCursorBlinkMode :: (HasCallStack, MonadIO m, IsTerminal a) => a -> CursorBlinkMode -> m ()
- terminalSetCursorShape :: (HasCallStack, MonadIO m, IsTerminal a) => a -> CursorShape -> m ()
- terminalSetDefaultColors :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m ()
- terminalSetDeleteBinding :: (HasCallStack, MonadIO m, IsTerminal a) => a -> EraseBinding -> m ()
- terminalSetEnableA11y :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetEnableBidi :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetEnableFallbackScrolling :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetEnableLegacyOsc777 :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetEnableShaping :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetEnableSixel :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetEncoding :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe Text -> m ()
- terminalSetFont :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe FontDescription -> m ()
- terminalSetFontOptions :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe FontOptions -> m ()
- terminalSetFontScale :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Double -> m ()
- terminalSetGeometryHintsForWindow :: (HasCallStack, MonadIO m, IsTerminal a, IsWindow b) => a -> b -> m ()
- terminalSetInputEnabled :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetMouseAutohide :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetPty :: (HasCallStack, MonadIO m, IsTerminal a, IsPty b) => a -> Maybe b -> m ()
- terminalSetRewrapOnResize :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetScrollOnInsert :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetScrollOnKeystroke :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetScrollOnOutput :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetScrollUnitIsPixels :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetScrollbackLines :: (HasCallStack, MonadIO m, IsTerminal a) => a -> CLong -> m ()
- terminalSetSize :: (HasCallStack, MonadIO m, IsTerminal a) => a -> CLong -> CLong -> m ()
- terminalSetSuppressLegacySignals :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m ()
- terminalSetTextBlinkMode :: (HasCallStack, MonadIO m, IsTerminal a) => a -> TextBlinkMode -> m ()
- terminalSetWordCharExceptions :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> m ()
- terminalSetXalign :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Align -> m ()
- terminalSetXfill :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetYalign :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Align -> m ()
- terminalSetYfill :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSpawnAsync :: (HasCallStack, MonadIO m, IsTerminal a, IsCancellable b) => a -> [PtyFlags] -> Maybe Text -> [[Char]] -> Maybe [[Char]] -> [SpawnFlags] -> Maybe SpawnChildSetupFunc -> Int32 -> Maybe b -> Maybe TerminalSpawnAsyncCallback -> m ()
- terminalSpawnSync :: (HasCallStack, MonadIO m, IsTerminal a, IsCancellable b) => a -> [PtyFlags] -> Maybe Text -> [[Char]] -> Maybe [[Char]] -> [SpawnFlags] -> Maybe SpawnChildSetupFunc -> Maybe b -> m Int32
- terminalSpawnWithFdsAsync :: (HasCallStack, MonadIO m, IsTerminal a, IsCancellable b) => a -> [PtyFlags] -> Maybe Text -> [[Char]] -> Maybe [[Char]] -> Maybe [Int32] -> Maybe [Int32] -> [SpawnFlags] -> Maybe SpawnChildSetupFunc -> Int32 -> Maybe b -> Maybe TerminalSpawnAsyncCallback -> m ()
- terminalUnselectAll :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m ()
- terminalWatchChild :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Int32 -> m ()
- terminalWriteContentsSync :: (HasCallStack, MonadIO m, IsTerminal a, IsOutputStream b, IsCancellable c) => a -> b -> WriteFlags -> Maybe c -> m ()
- constructTerminalAllowBold :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalAllowBold :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalAllowBold :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalAllowHyperlink :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalAllowHyperlink :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalAllowHyperlink :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalAudibleBell :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalAudibleBell :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalAudibleBell :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalBackspaceBinding :: (IsTerminal o, MonadIO m) => EraseBinding -> m (GValueConstruct o)
- getTerminalBackspaceBinding :: (MonadIO m, IsTerminal o) => o -> m EraseBinding
- setTerminalBackspaceBinding :: (MonadIO m, IsTerminal o) => o -> EraseBinding -> m ()
- constructTerminalBoldIsBright :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalBoldIsBright :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalBoldIsBright :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalCellHeightScale :: (IsTerminal o, MonadIO m) => Double -> m (GValueConstruct o)
- getTerminalCellHeightScale :: (MonadIO m, IsTerminal o) => o -> m Double
- setTerminalCellHeightScale :: (MonadIO m, IsTerminal o) => o -> Double -> m ()
- constructTerminalCellWidthScale :: (IsTerminal o, MonadIO m) => Double -> m (GValueConstruct o)
- getTerminalCellWidthScale :: (MonadIO m, IsTerminal o) => o -> m Double
- setTerminalCellWidthScale :: (MonadIO m, IsTerminal o) => o -> Double -> m ()
- constructTerminalCjkAmbiguousWidth :: (IsTerminal o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getTerminalCjkAmbiguousWidth :: (MonadIO m, IsTerminal o) => o -> m Int32
- setTerminalCjkAmbiguousWidth :: (MonadIO m, IsTerminal o) => o -> Int32 -> m ()
- clearTerminalContextMenu :: (MonadIO m, IsTerminal o) => o -> m ()
- constructTerminalContextMenu :: (IsTerminal o, MonadIO m, IsMenu a) => a -> m (GValueConstruct o)
- getTerminalContextMenu :: (MonadIO m, IsTerminal o) => o -> m (Maybe Menu)
- setTerminalContextMenu :: (MonadIO m, IsTerminal o, IsMenu a) => o -> a -> m ()
- clearTerminalContextMenuModel :: (MonadIO m, IsTerminal o) => o -> m ()
- constructTerminalContextMenuModel :: (IsTerminal o, MonadIO m, IsMenuModel a) => a -> m (GValueConstruct o)
- getTerminalContextMenuModel :: (MonadIO m, IsTerminal o) => o -> m (Maybe MenuModel)
- setTerminalContextMenuModel :: (MonadIO m, IsTerminal o, IsMenuModel a) => o -> a -> m ()
- getTerminalCurrentDirectoryUri :: (MonadIO m, IsTerminal o) => o -> m (Maybe Text)
- getTerminalCurrentFileUri :: (MonadIO m, IsTerminal o) => o -> m (Maybe Text)
- constructTerminalCursorBlinkMode :: (IsTerminal o, MonadIO m) => CursorBlinkMode -> m (GValueConstruct o)
- getTerminalCursorBlinkMode :: (MonadIO m, IsTerminal o) => o -> m CursorBlinkMode
- setTerminalCursorBlinkMode :: (MonadIO m, IsTerminal o) => o -> CursorBlinkMode -> m ()
- constructTerminalCursorShape :: (IsTerminal o, MonadIO m) => CursorShape -> m (GValueConstruct o)
- getTerminalCursorShape :: (MonadIO m, IsTerminal o) => o -> m CursorShape
- setTerminalCursorShape :: (MonadIO m, IsTerminal o) => o -> CursorShape -> m ()
- constructTerminalDeleteBinding :: (IsTerminal o, MonadIO m) => EraseBinding -> m (GValueConstruct o)
- getTerminalDeleteBinding :: (MonadIO m, IsTerminal o) => o -> m EraseBinding
- setTerminalDeleteBinding :: (MonadIO m, IsTerminal o) => o -> EraseBinding -> m ()
- constructTerminalEnableA11y :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalEnableA11y :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalEnableA11y :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalEnableBidi :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalEnableBidi :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalEnableBidi :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalEnableFallbackScrolling :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalEnableFallbackScrolling :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalEnableFallbackScrolling :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalEnableLegacyOsc777 :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalEnableLegacyOsc777 :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalEnableLegacyOsc777 :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalEnableShaping :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalEnableShaping :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalEnableShaping :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalEnableSixel :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalEnableSixel :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalEnableSixel :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- clearTerminalEncoding :: (MonadIO m, IsTerminal o) => o -> m ()
- constructTerminalEncoding :: (IsTerminal o, MonadIO m) => Text -> m (GValueConstruct o)
- getTerminalEncoding :: (MonadIO m, IsTerminal o) => o -> m (Maybe Text)
- setTerminalEncoding :: (MonadIO m, IsTerminal o) => o -> Text -> m ()
- clearTerminalFontDesc :: (MonadIO m, IsTerminal o) => o -> m ()
- constructTerminalFontDesc :: (IsTerminal o, MonadIO m) => FontDescription -> m (GValueConstruct o)
- getTerminalFontDesc :: (MonadIO m, IsTerminal o) => o -> m (Maybe FontDescription)
- setTerminalFontDesc :: (MonadIO m, IsTerminal o) => o -> FontDescription -> m ()
- clearTerminalFontOptions :: (MonadIO m, IsTerminal o) => o -> m ()
- constructTerminalFontOptions :: (IsTerminal o, MonadIO m) => FontOptions -> m (GValueConstruct o)
- getTerminalFontOptions :: (MonadIO m, IsTerminal o) => o -> m (Maybe FontOptions)
- setTerminalFontOptions :: (MonadIO m, IsTerminal o) => o -> FontOptions -> m ()
- constructTerminalFontScale :: (IsTerminal o, MonadIO m) => Double -> m (GValueConstruct o)
- getTerminalFontScale :: (MonadIO m, IsTerminal o) => o -> m Double
- setTerminalFontScale :: (MonadIO m, IsTerminal o) => o -> Double -> m ()
- getTerminalHyperlinkHoverUri :: (MonadIO m, IsTerminal o) => o -> m (Maybe Text)
- getTerminalIconTitle :: (MonadIO m, IsTerminal o) => o -> m (Maybe Text)
- constructTerminalInputEnabled :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalInputEnabled :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalInputEnabled :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalPointerAutohide :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalPointerAutohide :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalPointerAutohide :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- clearTerminalPty :: (MonadIO m, IsTerminal o) => o -> m ()
- constructTerminalPty :: (IsTerminal o, MonadIO m, IsPty a) => a -> m (GValueConstruct o)
- getTerminalPty :: (MonadIO m, IsTerminal o) => o -> m (Maybe Pty)
- setTerminalPty :: (MonadIO m, IsTerminal o, IsPty a) => o -> a -> m ()
- constructTerminalRewrapOnResize :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalRewrapOnResize :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalRewrapOnResize :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalScrollOnInsert :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalScrollOnInsert :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalScrollOnInsert :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalScrollOnKeystroke :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalScrollOnKeystroke :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalScrollOnKeystroke :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalScrollOnOutput :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalScrollOnOutput :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalScrollOnOutput :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalScrollUnitIsPixels :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalScrollUnitIsPixels :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalScrollUnitIsPixels :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalScrollbackLines :: (IsTerminal o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getTerminalScrollbackLines :: (MonadIO m, IsTerminal o) => o -> m Word32
- setTerminalScrollbackLines :: (MonadIO m, IsTerminal o) => o -> Word32 -> m ()
- constructTerminalTextBlinkMode :: (IsTerminal o, MonadIO m) => TextBlinkMode -> m (GValueConstruct o)
- getTerminalTextBlinkMode :: (MonadIO m, IsTerminal o) => o -> m TextBlinkMode
- setTerminalTextBlinkMode :: (MonadIO m, IsTerminal o) => o -> TextBlinkMode -> m ()
- getTerminalWindowTitle :: (MonadIO m, IsTerminal o) => o -> m (Maybe Text)
- getTerminalWordCharExceptions :: (MonadIO m, IsTerminal o) => o -> m (Maybe Text)
- constructTerminalXalign :: (IsTerminal o, MonadIO m) => Align -> m (GValueConstruct o)
- getTerminalXalign :: (MonadIO m, IsTerminal o) => o -> m Align
- setTerminalXalign :: (MonadIO m, IsTerminal o) => o -> Align -> m ()
- constructTerminalXfill :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalXfill :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalXfill :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- constructTerminalYalign :: (IsTerminal o, MonadIO m) => Align -> m (GValueConstruct o)
- getTerminalYalign :: (MonadIO m, IsTerminal o) => o -> m Align
- setTerminalYalign :: (MonadIO m, IsTerminal o) => o -> Align -> m ()
- constructTerminalYfill :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o)
- getTerminalYfill :: (MonadIO m, IsTerminal o) => o -> m Bool
- setTerminalYfill :: (MonadIO m, IsTerminal o) => o -> Bool -> m ()
- type TerminalBellCallback = IO ()
- afterTerminalBell :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalBellCallback) -> m SignalHandlerId
- onTerminalBell :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalBellCallback) -> m SignalHandlerId
- type TerminalCharSizeChangedCallback = Word32 -> Word32 -> IO ()
- afterTerminalCharSizeChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCharSizeChangedCallback) -> m SignalHandlerId
- onTerminalCharSizeChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCharSizeChangedCallback) -> m SignalHandlerId
- type TerminalChildExitedCallback = Int32 -> IO ()
- afterTerminalChildExited :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalChildExitedCallback) -> m SignalHandlerId
- onTerminalChildExited :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalChildExitedCallback) -> m SignalHandlerId
- type TerminalCommitCallback = Text -> Word32 -> IO ()
- afterTerminalCommit :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCommitCallback) -> m SignalHandlerId
- onTerminalCommit :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCommitCallback) -> m SignalHandlerId
- type TerminalContentsChangedCallback = IO ()
- afterTerminalContentsChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalContentsChangedCallback) -> m SignalHandlerId
- onTerminalContentsChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalContentsChangedCallback) -> m SignalHandlerId
- type TerminalCopyClipboardCallback = IO ()
- afterTerminalCopyClipboard :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCopyClipboardCallback) -> m SignalHandlerId
- onTerminalCopyClipboard :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCopyClipboardCallback) -> m SignalHandlerId
- type TerminalCurrentDirectoryUriChangedCallback = IO ()
- afterTerminalCurrentDirectoryUriChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCurrentDirectoryUriChangedCallback) -> m SignalHandlerId
- onTerminalCurrentDirectoryUriChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCurrentDirectoryUriChangedCallback) -> m SignalHandlerId
- type TerminalCurrentFileUriChangedCallback = IO ()
- afterTerminalCurrentFileUriChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCurrentFileUriChangedCallback) -> m SignalHandlerId
- onTerminalCurrentFileUriChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCurrentFileUriChangedCallback) -> m SignalHandlerId
- type TerminalCursorMovedCallback = IO ()
- afterTerminalCursorMoved :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCursorMovedCallback) -> m SignalHandlerId
- onTerminalCursorMoved :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCursorMovedCallback) -> m SignalHandlerId
- type TerminalDecreaseFontSizeCallback = IO ()
- afterTerminalDecreaseFontSize :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalDecreaseFontSizeCallback) -> m SignalHandlerId
- onTerminalDecreaseFontSize :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalDecreaseFontSizeCallback) -> m SignalHandlerId
- type TerminalDeiconifyWindowCallback = IO ()
- afterTerminalDeiconifyWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalDeiconifyWindowCallback) -> m SignalHandlerId
- onTerminalDeiconifyWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalDeiconifyWindowCallback) -> m SignalHandlerId
- type TerminalEncodingChangedCallback = IO ()
- afterTerminalEncodingChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalEncodingChangedCallback) -> m SignalHandlerId
- onTerminalEncodingChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalEncodingChangedCallback) -> m SignalHandlerId
- type TerminalEofCallback = IO ()
- afterTerminalEof :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalEofCallback) -> m SignalHandlerId
- onTerminalEof :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalEofCallback) -> m SignalHandlerId
- type TerminalHyperlinkHoverUriChangedCallback = Text -> Rectangle -> IO ()
- afterTerminalHyperlinkHoverUriChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalHyperlinkHoverUriChangedCallback) -> m SignalHandlerId
- onTerminalHyperlinkHoverUriChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalHyperlinkHoverUriChangedCallback) -> m SignalHandlerId
- type TerminalIconTitleChangedCallback = IO ()
- afterTerminalIconTitleChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalIconTitleChangedCallback) -> m SignalHandlerId
- onTerminalIconTitleChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalIconTitleChangedCallback) -> m SignalHandlerId
- type TerminalIconifyWindowCallback = IO ()
- afterTerminalIconifyWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalIconifyWindowCallback) -> m SignalHandlerId
- onTerminalIconifyWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalIconifyWindowCallback) -> m SignalHandlerId
- type TerminalIncreaseFontSizeCallback = IO ()
- afterTerminalIncreaseFontSize :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalIncreaseFontSizeCallback) -> m SignalHandlerId
- onTerminalIncreaseFontSize :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalIncreaseFontSizeCallback) -> m SignalHandlerId
- type TerminalLowerWindowCallback = IO ()
- afterTerminalLowerWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalLowerWindowCallback) -> m SignalHandlerId
- onTerminalLowerWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalLowerWindowCallback) -> m SignalHandlerId
- type TerminalMaximizeWindowCallback = IO ()
- afterTerminalMaximizeWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalMaximizeWindowCallback) -> m SignalHandlerId
- onTerminalMaximizeWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalMaximizeWindowCallback) -> m SignalHandlerId
- type TerminalMoveWindowCallback = Word32 -> Word32 -> IO ()
- afterTerminalMoveWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalMoveWindowCallback) -> m SignalHandlerId
- onTerminalMoveWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalMoveWindowCallback) -> m SignalHandlerId
- type TerminalPasteClipboardCallback = IO ()
- afterTerminalPasteClipboard :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalPasteClipboardCallback) -> m SignalHandlerId
- onTerminalPasteClipboard :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalPasteClipboardCallback) -> m SignalHandlerId
- type TerminalRaiseWindowCallback = IO ()
- afterTerminalRaiseWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalRaiseWindowCallback) -> m SignalHandlerId
- onTerminalRaiseWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalRaiseWindowCallback) -> m SignalHandlerId
- type TerminalRefreshWindowCallback = IO ()
- afterTerminalRefreshWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalRefreshWindowCallback) -> m SignalHandlerId
- onTerminalRefreshWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalRefreshWindowCallback) -> m SignalHandlerId
- type TerminalResizeWindowCallback = Word32 -> Word32 -> IO ()
- afterTerminalResizeWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalResizeWindowCallback) -> m SignalHandlerId
- onTerminalResizeWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalResizeWindowCallback) -> m SignalHandlerId
- type TerminalRestoreWindowCallback = IO ()
- afterTerminalRestoreWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalRestoreWindowCallback) -> m SignalHandlerId
- onTerminalRestoreWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalRestoreWindowCallback) -> m SignalHandlerId
- type TerminalSelectionChangedCallback = IO ()
- afterTerminalSelectionChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalSelectionChangedCallback) -> m SignalHandlerId
- onTerminalSelectionChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalSelectionChangedCallback) -> m SignalHandlerId
- type TerminalSetupContextMenuCallback = Maybe EventContext -> IO ()
- afterTerminalSetupContextMenu :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalSetupContextMenuCallback) -> m SignalHandlerId
- onTerminalSetupContextMenu :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalSetupContextMenuCallback) -> m SignalHandlerId
- type TerminalTermpropChangedCallback = Text -> IO ()
- afterTerminalTermpropChanged :: (IsTerminal a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => TerminalTermpropChangedCallback) -> m SignalHandlerId
- onTerminalTermpropChanged :: (IsTerminal a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => TerminalTermpropChangedCallback) -> m SignalHandlerId
- type TerminalTermpropsChangedCallback = [Int32] -> IO Bool
- afterTerminalTermpropsChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTermpropsChangedCallback) -> m SignalHandlerId
- onTerminalTermpropsChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTermpropsChangedCallback) -> m SignalHandlerId
- type TerminalTextDeletedCallback = IO ()
- afterTerminalTextDeleted :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextDeletedCallback) -> m SignalHandlerId
- onTerminalTextDeleted :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextDeletedCallback) -> m SignalHandlerId
- type TerminalTextInsertedCallback = IO ()
- afterTerminalTextInserted :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextInsertedCallback) -> m SignalHandlerId
- onTerminalTextInserted :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextInsertedCallback) -> m SignalHandlerId
- type TerminalTextModifiedCallback = IO ()
- afterTerminalTextModified :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextModifiedCallback) -> m SignalHandlerId
- onTerminalTextModified :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextModifiedCallback) -> m SignalHandlerId
- type TerminalTextScrolledCallback = Int32 -> IO ()
- afterTerminalTextScrolled :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextScrolledCallback) -> m SignalHandlerId
- onTerminalTextScrolled :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextScrolledCallback) -> m SignalHandlerId
- type TerminalWindowTitleChangedCallback = IO ()
- afterTerminalWindowTitleChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalWindowTitleChangedCallback) -> m SignalHandlerId
- onTerminalWindowTitleChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalWindowTitleChangedCallback) -> m SignalHandlerId

# Exported types

newtype Terminal Source #

Memory-managed wrapper type.

Constructors

Terminal (ManagedPtr Terminal) |

#### Instances

Instances details

Eq Terminal Source # |
Instance details Defined in GI.Vte.Objects.Terminal Methods (==) :: Terminal -> Terminal -> Bool Source # (/=) :: Terminal -> Terminal -> Bool Source #
GObject Terminal Source # |
Instance details Defined in GI.Vte.Objects.Terminal
ManagedPtrNewtype Terminal Source # |
Instance details Defined in GI.Vte.Objects.Terminal Methods toManagedPtr :: Terminal -> ManagedPtr Terminal Source #
TypedObject Terminal Source # |
Instance details Defined in GI.Vte.Objects.Terminal Methods glibType :: IO GType Source #
HasParentTypes Terminal Source # |
Instance details Defined in GI.Vte.Objects.Terminal
IsGValue (Maybe Terminal) Source # | Convert `Terminal` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Vte.Objects.Terminal Methods gvalueGType_ :: IO GType Source # gvalueSet_ :: Ptr GValue -> Maybe Terminal -> IO () Source # gvalueGet_ :: Ptr GValue -> IO (Maybe Terminal) Source #
type ParentTypes Terminal Source # |
Instance details Defined in GI.Vte.Objects.Terminal type ParentTypes Terminal = '[Widget, Object, ImplementorIface, Buildable, Scrollable]

class (GObject o, IsDescendantOf Terminal o) => IsTerminal o Source #

Type class for types which can be safely cast to `Terminal`, for instance with `toTerminal`.

#### Instances

Instances details

(GObject o, IsDescendantOf Terminal o) => IsTerminal o Source # |
Instance details Defined in GI.Vte.Objects.Terminal

toTerminal :: (MonadIO m, IsTerminal o) => o -> m Terminal Source #

Cast to `Terminal`, 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

Expand

#### Methods

activate, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addTickCallback, bindProperty, bindPropertyFull, canActivateAccel, childFocus, childNotify, classPath, computeExpand, constructChild, copyClipboard, copyClipboardFormat, copyPrimary, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, dupTermpropString, dupTermpropStringById, dupTermpropUuid, dupTermpropUuidById, ensureStyle, errorBell, event, feed, feedChild, feedChildBinary, forceFloating, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, hyperlinkCheckEvent, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, map, matchAddGregex, matchAddRegex, matchCheck, matchCheckEvent, matchRemove, matchRemoveAll, matchSetCursor, matchSetCursorName, matchSetCursorType, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, pasteClipboard, pastePrimary, pasteText, path, ptyNewSync, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, refTermpropDataBytes, refTermpropDataBytesById, refTermpropImagePixbuf, refTermpropImagePixbufById, refTermpropImageSurface, refTermpropImageSurfaceById, refTermpropUri, refTermpropUriById, refTermpropVariant, refTermpropVariantById, regionIntersect, registerWindow, removeAccelerator, removeMnemonicLabel, removeTickCallback, renderIcon, renderIconPixbuf, reparent, reset, resetRcStyles, resetStyle, resetTermprop, resetTermpropById, runDispose, searchFindNext, searchFindPrevious, searchGetGregex, searchGetRegex, searchGetWrapAround, searchSetGregex, searchSetRegex, searchSetWrapAround, selectAll, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, spawnAsync, spawnSync, spawnWithFdsAsync, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unselectAll, unsetStateFlags, watchChild, watchClosure, writeContentsSync.

#### Getters

getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAllowBold, getAllowHyperlink, getAncestor, getAppPaintable, getAudibleBell, getBoldIsBright, getBorder, getCanDefault, getCanFocus, getCellHeightScale, getCellWidthScale, getCharHeight, getCharWidth, getChildRequisition, getChildVisible, getCjkAmbiguousWidth, getClip, getClipboard, getColorBackgroundForDraw, getColumnCount, getCompositeName, getContextMenu, getContextMenuModel, getCurrentDirectoryUri, getCurrentFileUri, getCursorBlinkMode, getCursorPosition, getCursorShape, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEnableA11y, getEnableBidi, getEnableFallbackScrolling, getEnableLegacyOsc777, getEnableShaping, getEnableSixel, getEncoding, getEvents, getFocusOnClick, getFont, getFontMap, getFontOptions, getFontScale, getFrameClock, getGeometryHints, getHadjustment, getHalign, getHasSelection, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getHscrollPolicy, getIconTitle, getInputEnabled, getInternalChild, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getModifierMask, getModifierStyle, getMouseAutohide, getName, getNoShowAll, getOpacity, getPangoContext, getParent, getParentWindow, getPath, getPointer, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getProperty, getPty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getRewrapOnResize, getRootWindow, getRowCount, getScaleFactor, getScreen, getScrollOnInsert, getScrollOnKeystroke, getScrollOnOutput, getScrollUnitIsPixels, getScrollbackLines, getSensitive, getSettings, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTermpropBool, getTermpropBoolById, getTermpropData, getTermpropDataById, getTermpropDouble, getTermpropDoubleById, getTermpropEnum, getTermpropEnumById, getTermpropFlags, getTermpropFlagsById, getTermpropInt, getTermpropIntById, getTermpropRgba, getTermpropRgbaById, getTermpropString, getTermpropStringById, getTermpropUint, getTermpropUintById, getTermpropValue, getTermpropValueById, getText, getTextBlinkMode, getTextFormat, getTextIncludeTrailingSpaces, getTextRange, getTextRangeFormat, getTextSelected, getTextSelectedFull, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getVadjustment, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getVscrollPolicy, getWindow, getWindowTitle, getWordCharExceptions, getXalign, getXfill, getYalign, getYfill.

#### Setters

setAccelPath, setAllocation, setAllowBold, setAllowHyperlink, setAppPaintable, setAudibleBell, setBackspaceBinding, setBoldIsBright, setBuildableProperty, setCanDefault, setCanFocus, setCellHeightScale, setCellWidthScale, setChildVisible, setCjkAmbiguousWidth, setClearBackground, setClip, setColorBackground, setColorBold, setColorCursor, setColorCursorForeground, setColorForeground, setColorHighlight, setColorHighlightForeground, setColors, setCompositeName, setContextMenu, setContextMenuModel, setCursorBlinkMode, setCursorShape, setData, setDataFull, setDefaultColors, setDeleteBinding, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setEnableA11y, setEnableBidi, setEnableFallbackScrolling, setEnableLegacyOsc777, setEnableShaping, setEnableSixel, setEncoding, setEvents, setFocusOnClick, setFont, setFontMap, setFontOptions, setFontScale, setGeometryHintsForWindow, setHadjustment, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setHscrollPolicy, setInputEnabled, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setMouseAutohide, setName, setNoShowAll, setOpacity, setParent, setParentWindow, setProperty, setPty, setRealized, setReceivesDefault, setRedrawOnAllocate, setRewrapOnResize, setScrollOnInsert, setScrollOnKeystroke, setScrollOnOutput, setScrollUnitIsPixels, setScrollbackLines, setSensitive, setSize, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setSuppressLegacySignals, setTextBlinkMode, setTooltipMarkup, setTooltipText, setTooltipWindow, setVadjustment, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setVscrollPolicy, setWindow, setWordCharExceptions, setXalign, setXfill, setYalign, setYfill.

## copyClipboard

terminalCopyClipboard Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m () |

Deprecated: (Since version 0.50)Use `terminalCopyClipboardFormat` with `FormatText`instead.

Places the selected text in the terminal in the `GDK_SELECTION_CLIPBOARD` selection.

## copyClipboardFormat

terminalCopyClipboardFormat Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Format | `format`: a `Format`
-> m () |

Places the selected text in the terminal in the `GDK_SELECTION_CLIPBOARD` selection in the form specified by `format`.

For all formats, the selection data (see `SelectionData`) will include the text targets (see `targetListAddTextTargets` and `gtk_selection_data_targets_includes_text()`). For `FormatHtml`, the selection will also include the "text/html" target, which when requested, returns the HTML data in UTF-16 with a U+FEFF BYTE ORDER MARK character at the start.

Since: 0.50

## copyPrimary

terminalCopyPrimary Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m () |

Places the selected text in the terminal in the `GDK_SELECTION_PRIMARY` selection.

## dupTermpropString

terminalDupTermpropString Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Maybe Text, CSize) | Returns: the property's value, or `Nothing`

Returns the value of a `PropertyTypeString` termprop, or `Nothing` if `prop` is unset, or `prop` is not a registered property.

Since: 0.78

## dupTermpropStringById

terminalDupTermpropStringById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Maybe Text, CSize) | Returns: the property's value, or `Nothing`

Like `terminalDupTermpropString` except that it takes the termprop by ID. See that function for more information.

Since: 0.78

## dupTermpropUuid

terminalDupTermpropUuid Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Maybe Uuid) | Returns: the property's value as a `Uuid`, or `Nothing`

Returns the value of a `PropertyTypeUuid` termprop as a `Uuid`, or `Nothing` if `prop` is unset, or `prop` is not a registered property.

Since: 0.78

## dupTermpropUuidById

terminalDupTermpropUuidById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Maybe Uuid) | Returns: the property's value as a `Uuid`, or `Nothing`

Like `terminalDupTermpropUuid` except that it takes the termprop by ID. See that function for more information.

Since: 0.78

## feed

terminalFeed Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe ByteString | `data`: a string in the terminal's current encoding
-> m () |

Interprets `data` as if it were data received from a child process.

## feedChild

terminalFeedChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe ByteString | `text`: data to send to the child
-> m () |

Sends a block of UTF-8 text to the child as if it were entered by the user at the keyboard.

## feedChildBinary

terminalFeedChildBinary Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe ByteString | `data`: data to send to the child
-> m () |

Deprecated: (Since version 0.60)Don't send binary data. Use `terminalFeedChild` instead to sendUTF-8 text

Sends a block of binary data to the child.

## getAllowBold

terminalGetAllowBold Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` if bolding is enabled, `False` if not

Deprecated: (Since version 0.60)There's probably no reason for this feature to exist.

Checks whether or not the terminal will attempt to draw bold text, by using a bold font variant.

## getAllowHyperlink

terminalGetAllowHyperlink Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` if hyperlinks are enabled, `False` if not

Checks whether or not hyperlinks (OSC 8 escape sequence) are allowed.

Since: 0.50

## getAudibleBell

terminalGetAudibleBell Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` if audible bell is enabled, `False` if not

Checks whether or not the terminal will beep when the child outputs the "bl" sequence.

## getBoldIsBright

terminalGetBoldIsBright Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` if bold also enables bright, `False` if not

Checks whether the SGR 1 attribute also switches to the bright counterpart of the first 8 palette colors, in addition to making them bold (legacy behavior) or if SGR 1 only enables bold and leaves the color intact.

Since: 0.52

## getCellHeightScale

terminalGetCellHeightScale Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Double | Returns: the terminal's cell height scale

No description available in the introspection data.

Since: 0.52

## getCellWidthScale

terminalGetCellWidthScale Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Double | Returns: the terminal's cell width scale

No description available in the introspection data.

Since: 0.52

## getCharHeight

terminalGetCharHeight Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m CLong | Returns: the height of a character cell Note that this method should rather be called vte_terminal_get_cell_height, because the return value takes cell-height-scale into account.

No description available in the introspection data.

## getCharWidth

terminalGetCharWidth Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m CLong | Returns: the width of a character cell Note that this method should rather be called vte_terminal_get_cell_width, because the return value takes cell-width-scale into account.

No description available in the introspection data.

## getCjkAmbiguousWidth

terminalGetCjkAmbiguousWidth Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Int32 | Returns: 1 if ambiguous-width characters are narrow, or 2 if they are wide

Returns whether ambiguous-width characters are narrow or wide. (Note that when using a non-UTF-8 encoding set via `terminalSetEncoding`, the width of ambiguous-width characters is fixed and determined by the encoding itself.)

## getColorBackgroundForDraw

terminalGetColorBackgroundForDraw Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m RGBA |

Returns the background colour, as used by `terminal` when drawing the background, which may be different from the color set by `terminalSetColorBackground`.

Note: you must only call this function while handling the GtkWidgetdraw signal.

This function is rarely useful. One use for it is if you disable drawing the background (see `terminalSetClearBackground`) and then need to draw the background yourself.

Since: 0.54

## getColumnCount

terminalGetColumnCount Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m CLong | Returns: the number of columns

No description available in the introspection data.

## getContextMenu

terminalGetContextMenu Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m (Maybe Widget) | Returns: the context menu, or `Nothing`

No description available in the introspection data.

Since: 0.76

## getContextMenuModel

terminalGetContextMenuModel Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m (Maybe MenuModel) | Returns: the context menu model, or `Nothing`

No description available in the introspection data.

Since: 0.76

## getCurrentDirectoryUri

terminalGetCurrentDirectoryUri Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m (Maybe Text) | Returns: the URI of the current directory of the process running in the terminal, or `Nothing`

Deprecated: (Since version 0.78)Use the `VTE_TERMPROP_CURRENT_FILE_URI_STRING` termprop.

No description available in the introspection data.

## getCurrentFileUri

terminalGetCurrentFileUri Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m (Maybe Text) | Returns: the URI of the current file the process running in the terminal is operating on, or `Nothing` if not set

Deprecated: (Since version 0.78)Use the `VTE_TERMPROP_CURRENT_FILE_URI_STRING` termprop.

No description available in the introspection data.

## getCursorBlinkMode

terminalGetCursorBlinkMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m CursorBlinkMode | Returns: cursor blink mode.

Returns the currently set cursor blink mode.

## getCursorPosition

terminalGetCursorPosition Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m (CLong, CLong) |

Reads the location of the insertion cursor and returns it. The row coordinate is absolute.

This method is unaware of BiDi. The returned column is logical column.

## getCursorShape

terminalGetCursorShape Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m CursorShape | Returns: cursor shape.

Returns the currently set cursor shape.

## getEnableA11y

terminalGetEnableA11y Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` if a11y is enabled, `False` if not

Checks whether the terminal communicates with a11y backends

Since: 0.78

## getEnableBidi

terminalGetEnableBidi Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` if BiDi is enabled, `False` if not

Checks whether the terminal performs bidirectional text rendering.

Since: 0.58

## getEnableFallbackScrolling

terminalGetEnableFallbackScrolling Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` if fallback scrolling is enabled

No description available in the introspection data.

Since: 0.64

## getEnableLegacyOsc777

terminalGetEnableLegacyOsc777 Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` iff legacy OSC 777 is enabled

No description available in the introspection data.

Since: 0.78

## getEnableShaping

terminalGetEnableShaping Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` if Arabic shaping is enabled, `False` if not

Checks whether the terminal shapes Arabic text.

Since: 0.58

## getEnableSixel

terminalGetEnableSixel Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `False`

No description available in the introspection data.

Since: 0.62

## getEncoding

terminalGetEncoding Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m (Maybe Text) | Returns: the current encoding for the terminal

Deprecated: (Since version 0.54)Support for non-UTF-8 is deprecated.

Determines the name of the encoding in which the terminal expects data to be encoded, or `Nothing` if UTF-8 is in use.

## getFont

terminalGetFont Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m FontDescription | Returns: a `FontDescription` describing the font the terminal uses to render text at the default font scale of 1.0.

Queries the terminal for information about the fonts which will be used to draw text in the terminal. The actual font takes the font scale into account, this is not reflected in the return value, the unscaled font is returned.

## getFontOptions

terminalGetFontOptions Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m (Maybe FontOptions) | Returns: the terminal's font options, or `Nothing`

No description available in the introspection data.

Since: 0.74

## getFontScale

terminalGetFontScale Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Double | Returns: the terminal's font scale

No description available in the introspection data.

## getGeometryHints

terminalGetGeometryHints Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `minRows`: the minimum number of rows to request
-> Int32 | `minColumns`: the minimum number of columns to request
-> m Geometry |

Deprecated: (Since version 0.52)

Fills in some `hints` from `terminal`'s geometry. The hints filled are those covered by the `WindowHintsResizeInc`, `WindowHintsMinSize` and `WindowHintsBaseSize` flags.

See `windowSetGeometryHints` for more information.

`terminal` must be realized (see `widgetGetRealized`).

## getHasSelection

terminalGetHasSelection Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` if part of the text in the terminal is selected.

Checks if the terminal currently contains selected text. Note that this is different from determining if the terminal is the owner of any `Clipboard` items.

## getIconTitle

terminalGetIconTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m (Maybe Text) | Returns: `Nothing`

Deprecated: (Since version 0.54)

No description available in the introspection data.

## getInputEnabled

terminalGetInputEnabled Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool |

Returns whether the terminal allow user input.

## getMouseAutohide

terminalGetMouseAutohide Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` if autohiding is enabled, `False` if not

Determines the value of the terminal's mouse autohide setting. When autohiding is enabled, the mouse cursor will be hidden when the user presses a key and shown when the user moves the mouse. This setting can be changed using `terminalSetMouseAutohide`.

## getPty

terminalGetPty Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m (Maybe Pty) | Returns: a `Pty`, or `Nothing`

Returns the `Pty` of `terminal`.

## getRewrapOnResize

terminalGetRewrapOnResize Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` if rewrapping is enabled, `False` if not

Deprecated: (Since version 0.58)

Checks whether or not the terminal will rewrap its contents upon resize.

## getRowCount

terminalGetRowCount Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m CLong | Returns: the number of rows

No description available in the introspection data.

## getScrollOnInsert

terminalGetScrollOnInsert Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child.

No description available in the introspection data.

Since: 0.76

## getScrollOnKeystroke

terminalGetScrollOnKeystroke Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: whether or not the terminal will forcibly scroll to the bottom of the viewable history when the user presses a key. Modifier keys do not trigger this behavior.

No description available in the introspection data.

Since: 0.52

## getScrollOnOutput

terminalGetScrollOnOutput Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child.

No description available in the introspection data.

Since: 0.52

## getScrollUnitIsPixels

terminalGetScrollUnitIsPixels Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` if the scroll unit is pixels; or `False` if the unit is lines

No description available in the introspection data.

Since: 0.66

## getScrollbackLines

terminalGetScrollbackLines Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m CLong | Returns: length of the scrollback buffer used by the terminal. A negative value means "infinite scrollback".

No description available in the introspection data.

Since: 0.52

## getTermpropBool

terminalGetTermpropBool Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Bool, Bool) | Returns: `True` iff the termprop is set

For a `PropertyTypeBool` termprop, sets `value` to `prop`'s value, or to `False` if `prop` is unset, or `prop` is not a registered property.

Since: 0.78

## getTermpropBoolById

terminalGetTermpropBoolById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Bool, Bool) | Returns: `True` iff the termprop is set

Like `terminalGetTermpropBool` except that it takes the termprop by ID. See that function for more information.

Since: 0.78

## getTermpropData

terminalGetTermpropData Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Maybe ByteString) | Returns: the property's value, or `Nothing`

Returns the value of a `PropertyTypeData` termprop, or `Nothing` if `prop` is unset, or `prop` is not a registered property.

Since: 0.78

## getTermpropDataById

terminalGetTermpropDataById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Maybe ByteString) | Returns: the property's value, or `Nothing`

Like `terminalGetTermpropData` except that it takes the termprop by ID. See that function for more information.

Since: 0.78

## getTermpropDouble

terminalGetTermpropDouble Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Bool, Double) | Returns: `True` iff the termprop is set

For a `PropertyTypeDouble` termprop, sets `value` to `prop`'s value, which is finite; or to 0.0 if `prop` is unset, or `prop` is not a registered property.

Since: 0.78

## getTermpropDoubleById

terminalGetTermpropDoubleById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Bool, Double) | Returns: `True` iff the termprop is set

Like `terminalGetTermpropDouble` except that it takes the termprop by ID. See that function for more information.

Since: 0.78

## getTermpropEnum

terminalGetTermpropEnum Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a property name of a `PropertyTypeString` property
-> GType | `gtype`: a `GType` of an enum type
-> m (Bool, Int64) | Returns: `True` iff the property was set and could be parsed a a value of the enumeration type

See `vte_properties_get_property_enum()` for more information.

Since: 0.82

## getTermpropEnumById

terminalGetTermpropEnumById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a property ID of a `PropertyTypeString` property
-> GType | `gtype`: a `GType` of an enum type
-> m (Bool, Int64) | Returns: `True` iff the property was set and could be parsed a a value of enumeration type `type`

Like `terminalGetTermpropEnum` except that it takes the property by ID. See that function for more information.

Since: 0.82

## getTermpropFlags

terminalGetTermpropFlags Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text |
-> GType | `gtype`: a `GType` of a flags type
-> Bool | `ignoreUnknownFlags`: whether to ignore unknown flags
-> m (Bool, Word64) | Returns: `True` iff the property was set and could be parsed a a value of the flags type

See `vte_properties_get_property_flags()` for more information.

Since: 0.82

## getTermpropFlagsById

terminalGetTermpropFlagsById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 |
-> GType | `gtype`: a `GType` of a flags type
-> Bool | `ignoreUnknownFlags`: whether to ignore unknown flags
-> m (Bool, Word64) | Returns: `True` iff the property was set and could be parsed a a value of flags type `type`

Like `terminalGetTermpropFlags` except that it takes the property by ID. See that function for more information.

Since: 0.82

## getTermpropInt

terminalGetTermpropInt Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Bool, Int64) | Returns: `True` iff the termprop is set

For a `PropertyTypeInt` termprop, sets `value` to `prop`'s value, or to 0 if `prop` is unset, or if `prop` is not a registered property.

If only a subset or range of values are acceptable for the given property, the caller must validate the returned value and treat any out-of-bounds value as if the termprop had no value; in particular it *must not* clamp the values to the expected range.

Since: 0.78

## getTermpropIntById

terminalGetTermpropIntById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Bool, Int64) | Returns: `True` iff the termprop is set

Like `terminalGetTermpropInt` except that it takes the termprop by ID. See that function for more information.

Since: 0.78

## getTermpropRgba

terminalGetTermpropRgba Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Bool, RGBA) | Returns: `True` iff the termprop is set

Stores the value of a `PropertyTypeRgb` or `PropertyTypeRgba` termprop in `color` and returns `True` if the termprop is set, or stores rgb(0,0,0) or rgba(0,0,0,1) in `color` and returns `False` if the termprop is unset.

Since: 0.78

## getTermpropRgbaById

terminalGetTermpropRgbaById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Bool, RGBA) | Returns: `True` iff the termprop is set

Like `terminalGetTermpropRgba` except that it takes the termprop by ID. See that function for more information.

Since: 0.78

## getTermpropString

terminalGetTermpropString Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Maybe Text, CSize) | Returns: the property's value, or `Nothing`

Returns the value of a `PropertyTypeString` termprop, or `Nothing` if `prop` is unset, or `prop` is not a registered property.

Since: 0.78

## getTermpropStringById

terminalGetTermpropStringById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Maybe Text, CSize) | Returns: the property's value, or `Nothing`

Like `terminalGetTermpropString` except that it takes the termprop by ID. See that function for more information.

Since: 0.78

## getTermpropUint

terminalGetTermpropUint Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Bool, Word64) | Returns: `True` iff the termprop is set

For a `PropertyTypeUint` termprop, sets `value` to `prop`'s value, or to 0 if `prop` is unset, or `prop` is not a registered property.

If only a subset or range of values are acceptable for the given property, the caller must validate the returned value and treat any out-of-bounds value as if the termprop had no value; in particular it *must not* clamp the values to the expected range.

Since: 0.78

## getTermpropUintById

terminalGetTermpropUintById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Bool, Word64) | Returns: `True` iff the termprop is set

Like `terminalGetTermpropUint` except that it takes the termprop by ID. See that function for more information.

Since: 0.78

## getTermpropValue

terminalGetTermpropValue Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Bool, GValue) | Returns: `True` iff the property has a value, with `gvalue` containig the property's value.

Returns `True` with the value of `prop` stored in `value` (if not `Nothing`) if, the termprop has a value, or `False` if `prop` is unset, or `prop` is not a registered property; in that case `value` will not be set.

The value type returned depends on the termprop type: * A `PropertyTypeValueless` termprop stores no value, and returns `False` from this function. * A `PropertyTypeBool` termprop stores a `G_TYPE_BOOLEAN` value. * A `PropertyTypeInt` termprop stores a `G_TYPE_INT64` value. * A `PropertyTypeUint` termprop stores a `G_TYPE_UINT64` value. * A `PropertyTypeDouble` termprop stores a `G_TYPE_DOUBLE` value. * A `PropertyTypeRgb` termprop stores a boxed `RGBA` value with alpha 1.0 on gtk3, and nothing on gtk4. * A `PropertyTypeRgba` termprop stores a boxed `RGBA` value on gtk3, and nothing on gtk4. * A `PropertyTypeString` termprop stores a `G_TYPE_STRING` value. * A `PropertyTypeData` termprop stores a boxed `Bytes` value. * A `PropertyTypeUuid` termprop stores a boxed `Uuid` value. * A `PropertyTypeUri` termprop stores a boxed `Uri` value. * A `PropertyTypeImage` termprop stores a boxed `Surface` value on gtk3, and a boxed `GdkTexture` on gtk4

Since: 0.78

## getTermpropValueById

terminalGetTermpropValueById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Bool, GValue) | Returns: `True` iff the property has a value, with `gvalue` containig the property's value.

Like `terminalGetTermpropValue` except that it takes the termprop by ID. See that function for more information.

Since: 0.78

## getText

terminalGetText Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe SelectionFunc | `isSelected`: a `SelectionFunc` callback. Deprecated: 0.44: Always pass `Nothing` here.
-> m (Maybe Text, Maybe [CharAttributes]) | Returns: a newly allocated text string, or `Nothing`.

Deprecated: (Since version 0.76)Use `terminalGetTextFormat` instead

Extracts a view of the visible part of the terminal.

This method is unaware of BiDi. The columns returned in `attributes` are logical columns.

Note: since 0.68, passing a non-`Nothing` `attributes` parameter is deprecated. Starting with 0.72, passing a non-`Nothing` `attributes` parameter will make this function itself return `Nothing`. Since 0.72, passing a non-`Nothing` `isSelected` parameter will make this function itself return `Nothing`.

## getTextBlinkMode

terminalGetTextBlinkMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m TextBlinkMode | Returns: the blinking setting

Checks whether or not the terminal will allow blinking text.

Since: 0.52

## getTextFormat

terminalGetTextFormat Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Format | `format`: the `Format` to use
-> m (Maybe Text) | Returns: a newly allocated text string, or `Nothing`.

Returns text from the visible part of the terminal in the specified format.

This method is unaware of BiDi. The columns returned in `attributes` are logical columns.

Since: 0.76

## getTextIncludeTrailingSpaces

terminalGetTextIncludeTrailingSpaces Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe SelectionFunc | `isSelected`: a `SelectionFunc` callback. Deprecated: 0.44: Always pass `Nothing` here.
-> m (Text, Maybe [CharAttributes]) | Returns: a newly allocated text string, or `Nothing`.

Deprecated: (Since version 0.56)Use `terminalGetTextFormat` instead.

Extracts a view of the visible part of the terminal.

This method is unaware of BiDi. The columns returned in `attributes` are logical columns.

Note: since 0.68, passing a non-`Nothing` `array` parameter is deprecated. Starting with 0.72, passing a non-`Nothing` `array` parameter will make this function itself return `Nothing`. Since 0.72, passing a non-`Nothing` `isSelected` parameter will make this function itself return `Nothing`.

## getTextRange

terminalGetTextRange Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> CLong | `startRow`: first row to search for data
-> CLong | `startCol`: first column to search for data
-> CLong | `endRow`: last row to search for data
-> CLong | `endCol`: last column to search for data
-> Maybe SelectionFunc | `isSelected`: a `SelectionFunc` callback. Deprecated: 0.44: Always pass `Nothing` here
-> m (Maybe Text, Maybe [CharAttributes]) | Returns: a newly allocated text string, or `Nothing`.

Deprecated: (Since version 0.76)Use `terminalGetTextRangeFormat` instead

Extracts a view of the visible part of the terminal. The entire scrollback buffer is scanned, so it is possible to read the entire contents of the buffer using this function.

This method is unaware of BiDi. The columns passed in `startCol` and `endRow`, and returned in `attributes` are logical columns.

Since 0.68, passing a non-`Nothing` `array` parameter is deprecated. Since 0.72, passing a non-`Nothing` `array` parameter will make this function itself return `Nothing`. Since 0.72, passing a non-`Nothing` `isSelected` function will make this function itself return `Nothing`.

## getTextRangeFormat

terminalGetTextRangeFormat Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Format | `format`: the `Format` to use
-> CLong | `startRow`: the first row of the range
-> CLong | `startCol`: the first column of the range
-> CLong | `endRow`: the last row of the range
-> CLong | `endCol`: the last column of the range
-> m (Maybe Text, CSize) | Returns: a newly allocated string, or `Nothing`.

Returns the specified range of text in the specified format.

Since: 0.72

## getTextSelected

terminalGetTextSelected Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Format | `format`: the `Format` to use
-> m (Maybe Text) | Returns: a newly allocated string containing the selected text, or `Nothing` if there is no selection or the format is not supported

Gets the currently selected text in the format specified by `format`. Since 0.72, this function also supports `FormatHtml` format.

Since: 0.70

## getTextSelectedFull

terminalGetTextSelectedFull Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Format | `format`: the `Format` to use
-> m (Maybe Text, CSize) | Returns: a newly allocated string containing the selected text, or `Nothing` if there is no selection or the format is not supported

Gets the currently selected text in the format specified by `format`.

Since: 0.72

## getWindowTitle

terminalGetWindowTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m (Maybe Text) | Returns: the window title, or `Nothing`

Deprecated: (Since version 0.78)Use the `TERMPROP_XTERM_TITLE` termprop.

No description available in the introspection data.

## getWordCharExceptions

terminalGetWordCharExceptions Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m (Maybe Text) | Returns: a string, or `Nothing`

Returns the set of characters which will be considered parts of a word when doing word-wise selection, in addition to the default which only considers alphanumeric characters part of a word.

If `Nothing`, a built-in set is used.

Since: 0.40

## getXalign

terminalGetXalign Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Align | Returns: the horizontal alignment of `terminal` within its allocation

No description available in the introspection data.

Since: 0.76

## getXfill

terminalGetXfill Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: the horizontal fillment of `terminal` within its allocation

No description available in the introspection data.

Since: 0.76

## getYalign

terminalGetYalign Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Align | Returns: the vertical alignment of `terminal` within its allocation

No description available in the introspection data.

Since: 0.76

## getYfill

terminalGetYfill Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: the vertical fillment of `terminal` within its allocation

No description available in the introspection data.

Since: 0.76

## hyperlinkCheckEvent

terminalHyperlinkCheckEvent Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Event | `event`: a `Event`
-> m (Maybe Text) | Returns: a newly allocated string containing the target of the hyperlink, or `Nothing`

Returns a nonempty string: the target of the explicit hyperlink (printed using the OSC 8 escape sequence) at the position of the event, or `Nothing`.

Proper use of the escape sequence should result in URI-encoded URIs with a proper scheme like "http://", "https://", "file://", "mailto:" etc. This is, however, not enforced by VTE. The caller must tolerate the returned string potentially not being a valid URI.

Since: 0.50

## matchAddGregex

terminalMatchAddGregex Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Regex | `gregex`: a `Regex`
-> [RegexMatchFlags] | `gflags`: the `RegexMatchFlags` to use when matching the regex
-> m Int32 | Returns: -1

Deprecated: (Since version 0.46)Use `terminalMatchAddRegex` instead.

This function does nothing since version 0.60.

## matchAddRegex

terminalMatchAddRegex Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Regex | `regex`: a `Regex`
-> Word32 | `flags`: PCRE2 match flags, or 0
-> m Int32 | Returns: an integer associated with this expression

Adds the regular expression `regex` to the list of matching expressions. When the user moves the mouse cursor over a section of displayed text which matches this expression, the text will be highlighted.

Note that `regex` should have been created using the <literal>PCRE2_MULTILINE</literal> flag.

Since: 0.46

## matchCheck

terminalMatchCheck Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> CLong | `column`: the text column
-> CLong | `row`: the text row
-> m (Maybe Text, Int32) | Returns: a newly allocated string which matches one of the previously set regular expressions

Deprecated: (Since version 0.46)Use `terminalMatchCheckEvent` instead.

Checks if the text in and around the specified position matches any of the regular expressions previously set using `vte_terminal_match_add()`. If a match exists, the text string is returned and if `tag` is not `Nothing`, the number associated with the matched regular expression will be stored in `tag`.

If more than one regular expression has been set with `vte_terminal_match_add()`, then expressions are checked in the order in which they were added.

## matchCheckEvent

terminalMatchCheckEvent Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Event | `event`: a `Event`
-> m (Maybe Text, Int32) | Returns: a newly allocated string which matches one of the previously set regular expressions, or `Nothing` if there is no match

Checks if the text in and around the position of the event matches any of the regular expressions previously set using `vte_terminal_match_add()`. If a match exists, the text string is returned and if `tag` is not `Nothing`, the number associated with the matched regular expression will be stored in `tag`.

If more than one regular expression has been set with `vte_terminal_match_add()`, then expressions are checked in the order in which they were added.

## matchRemove

terminalMatchRemove Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `tag`: the tag of the regex to remove
-> m () |

Removes the regular expression which is associated with the given `tag` from the list of expressions which the terminal will highlight when the user moves the mouse cursor over matching text.

## matchRemoveAll

terminalMatchRemoveAll Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m () |

Clears the list of regular expressions the terminal uses to highlight text when the user moves the mouse cursor.

## matchSetCursor

terminalMatchSetCursor Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a, IsCursor b) |
=> a | `terminal`: a `Terminal`
-> Int32 | `tag`: the tag of the regex which should use the specified cursor
-> Maybe b | `cursor`: the `Cursor` which the terminal should use when the pattern is highlighted, or `Nothing` to use the standard cursor
-> m () |

Deprecated: (Since version 0.40)Use `terminalMatchSetCursorName` instead.

Sets which cursor the terminal will use if the pointer is over the pattern specified by `tag`. The terminal keeps a reference to `cursor`.

## matchSetCursorName

terminalMatchSetCursorName Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `tag`: the tag of the regex which should use the specified cursor
-> Text | `cursorName`: the name of the cursor
-> m () |

Sets which cursor the terminal will use if the pointer is over the pattern specified by `tag`.

## matchSetCursorType

terminalMatchSetCursorType Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `tag`: the tag of the regex which should use the specified cursor
-> CursorType | `cursorType`: a `CursorType`
-> m () |

Deprecated: (Since version 0.54)Use `terminalMatchSetCursorName` instead.

Sets which cursor the terminal will use if the pointer is over the pattern specified by `tag`.

## new

terminalNew Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> m Terminal | Returns: a new `Terminal` object

Creates a new terminal widget.

## pasteClipboard

terminalPasteClipboard Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m () |

Sends the contents of the `GDK_SELECTION_CLIPBOARD` selection to the terminal's child. It's called on paste menu item, or when user presses Shift+Insert.

## pastePrimary

terminalPastePrimary Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m () |

Sends the contents of the `GDK_SELECTION_PRIMARY` selection to the terminal's child. The terminal will call also paste the `GDK_SELECTION_PRIMARY` selection when the user clicks with the the second mouse button.

## pasteText

terminalPasteText Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `text`: a string to paste
-> m () |

Sends `text` to the terminal's child as if retrived from the clipboard, this differs from `terminalFeedChild` in that it may process `text` before passing it to the child (e.g. apply bracketed mode)

Since: 0.68

## ptyNewSync

terminalPtyNewSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a, IsCancellable b) |
=> a | `terminal`: a `Terminal`
-> [PtyFlags] | `flags`: flags from `PtyFlags`
-> Maybe b | `cancellable`: a `Cancellable`, or `Nothing`
-> m Pty | Returns: a new `Pty` (Can throw `GError`)

Creates a new `Pty`, sets the emulation property from `Terminal`:`emulation`, and sets the size using `terminal`'s size.

See `vte_pty_new()` for more information.

## refTermpropDataBytes

terminalRefTermpropDataBytes Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Maybe Bytes) | Returns: the property's value as a `Bytes`, or `Nothing`

Returns the value of a `PropertyTypeData` termprop as a `Bytes`, or `Nothing` if `prop` is unset, or `prop` is not a registered property.

Since: 0.78

## refTermpropDataBytesById

terminalRefTermpropDataBytesById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Maybe Bytes) | Returns: the property's value as a `Bytes`, or `Nothing`

Like `terminalRefTermpropDataBytes` except that it takes the termprop by ID. See that function for more information.

Since: 0.78

## refTermpropImagePixbuf

terminalRefTermpropImagePixbuf Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Maybe Pixbuf) | Returns: the property's value as a `Pixbuf`, or `Nothing`

Returns the value of a `PropertyTypeImage` termprop as a `Pixbuf`, or `Nothing` if `prop` is unset, or `prop` is not a registered property.

Since: 0.80

## refTermpropImagePixbufById

terminalRefTermpropImagePixbufById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Maybe Pixbuf) | Returns: the property's value as a `Pixbuf`, or `Nothing`

Like `terminalRefTermpropImagePixbuf` except that it takes the termprop by ID. See that function for more information.

Since: 0.80

## refTermpropImageSurface

terminalRefTermpropImageSurface Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Maybe Surface) | Returns: the property's value as a `Surface`, or `Nothing`

Returns the value of a `PropertyTypeImage` termprop as a `Surface`, or `Nothing` if `prop` is unset, or `prop` is not a registered property.

The surface will be a `SurfaceTypeImage` with format `FormatArgb32` or `FormatRgb24`.

Note that the returned surface is owned by `terminal` and its contents must not be modified.

Since: 0.80

## refTermpropImageSurfaceById

terminalRefTermpropImageSurfaceById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Maybe Surface) | Returns: the property's value as a `Surface`, or `Nothing`

Like `terminalRefTermpropImageSurface` except that it takes the termprop by ID. See that function for more information.

Since: 0.80

## refTermpropUri

terminalRefTermpropUri Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Maybe Uri) | Returns: the property's value as a `Uri`, or `Nothing`

Returns the value of a `PropertyTypeUri` termprop as a `Uri`, or `Nothing` if `prop` is unset, or `prop` is not a registered property.

Since: 0.78

## refTermpropUriById

terminalRefTermpropUriById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Maybe Uri) | Returns: the property's value as a `Uri`, or `Nothing`

Like `terminalRefTermpropUri` except that it takes the termprop by ID. See that function for more information.

Since: 0.78

## refTermpropVariant

terminalRefTermpropVariant Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m (Maybe GVariant) | Returns: a floating `GVariant`, or `Nothing`

Returns the value of `prop` as a `GVariant`, or `Nothing` if `prop` unset, or `prop` is not a registered property.

The `VariantType` of the returned `GVariant` depends on the termprop type: * A `PropertyTypeValueless` termprop returns a `G_VARIANT_TYPE_UNIT` variant. * A `PropertyTypeBool` termprop returns a `G_VARIANT_TYPE_BOOLEAN` variant. * A `PropertyTypeInt` termprop returns a `G_VARIANT_TYPE_INT64` variant. * A `PropertyTypeUint` termprop returns a `G_VARIANT_TYPE_UINT64` variant. * A `PropertyTypeDouble` termprop returns a `G_VARIANT_TYPE_DOUBLE` variant. * A `PropertyTypeRgb` or `PropertyTypeRgba` termprop returns a "(ddddv)" tuple containing the red, green, blue, and alpha (1.0 for `PropertyTypeRgb`) components of the color and a variant of unspecified contents * A `PropertyTypeString` termprop returns a `G_VARIANT_TYPE_STRING` variant. * A `PropertyTypeData` termprop returns a "ay" variant (which is *not* a bytestring!). * A `PropertyTypeUuid` termprop returns a `G_VARIANT_TYPE_STRING` variant containing a string representation of the UUID in simple form. * A `PropertyTypeUri` termprop returns a `G_VARIANT_TYPE_STRING` variant containing a string representation of the URI * A `PropertyTypeImage` termprop returns `Nothing` since an image has no variant representation.

Since: 0.78

## refTermpropVariantById

terminalRefTermpropVariantById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m (Maybe GVariant) | Returns: a floating `GVariant`, or `Nothing`

Like `terminalRefTermpropVariant` except that it takes the termprop by ID. See that function for more information.

Since: 0.78

## reset

terminalReset Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `clearTabstops`: whether to reset tabstops
-> Bool | `clearHistory`: whether to empty the terminal's scrollback buffer
-> m () |

Resets as much of the terminal's internal state as possible, discarding any unprocessed input data, resetting character attributes, cursor state, national character set state, status line, terminal modes (insert/delete), selection state, and encoding.

## resetTermprop

terminalResetTermprop Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `prop`: a termprop name
-> m () |

Resets the termprop `prop` to its default value.

Since: 0.84

## resetTermpropById

terminalResetTermpropById Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `prop`: a termprop ID
-> m () |

Like `terminalResetTermprop` except that it takes the termprop by ID. See that function for more information.

Since: 0.84

## searchFindNext

terminalSearchFindNext Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` if a match was found

Searches the next string matching the search regex set with `terminalSearchSetRegex`.

## searchFindPrevious

terminalSearchFindPrevious Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: `True` if a match was found

Searches the previous string matching the search regex set with `terminalSearchSetRegex`.

## searchGetGregex

terminalSearchGetGregex Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Regex | Returns: `Nothing`

Deprecated: (Since version 0.46)use `terminalSearchGetRegex` instead.

No description available in the introspection data.

## searchGetRegex

terminalSearchGetRegex Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Regex | Returns: the search `Regex` regex set in `terminal`, or `Nothing`

No description available in the introspection data.

Since: 0.46

## searchGetWrapAround

terminalSearchGetWrapAround Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m Bool | Returns: whether searching will wrap around

No description available in the introspection data.

## searchSetGregex

terminalSearchSetGregex Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe Regex | `gregex`: a `Regex`, or `Nothing`
-> [RegexMatchFlags] | `gflags`: flags from `RegexMatchFlags`
-> m () |

Deprecated: (Since version 0.46)use `terminalSearchSetRegex` instead.

This function does nothing since version 0.60.

## searchSetRegex

terminalSearchSetRegex Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe Regex | `regex`: a `Regex`, or `Nothing`
-> Word32 | `flags`: PCRE2 match flags, or 0
-> m () |

Sets the regex to search for. Unsets the search regex when passed `Nothing`.

Note that `regex` should have been created using the <literal>PCRE2_MULTILINE</literal> flag.

Since: 0.46

## searchSetWrapAround

terminalSearchSetWrapAround Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `wrapAround`: whether search should wrap
-> m () |

Sets whether search should wrap around to the beginning of the terminal content when reaching its end.

## selectAll

terminalSelectAll Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m () |

Selects all text within the terminal (not including the scrollback buffer).

## setAllowBold

terminalSetAllowBold Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `allowBold`: `True` if the terminal should attempt to draw bold text
-> m () |

Deprecated: (Since version 0.60)There's probably no reason for this feature to exist.

Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant.

## setAllowHyperlink

terminalSetAllowHyperlink Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `allowHyperlink`: `True` if the terminal should allow hyperlinks
-> m () |

Controls whether or not hyperlinks (OSC 8 escape sequence) are allowed.

Since: 0.50

## setAudibleBell

terminalSetAudibleBell Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `isAudible`: `True` if the terminal should beep
-> m () |

Controls whether or not the terminal will beep when the child outputs the "bl" sequence.

## setBackspaceBinding

terminalSetBackspaceBinding Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> EraseBinding | `binding`: a `EraseBinding` for the backspace key
-> m () |

Modifies the terminal's backspace key binding, which controls what string or control sequence the terminal sends to its child when the user presses the backspace key.

## setBoldIsBright

terminalSetBoldIsBright Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `boldIsBright`: `True` if bold should also enable bright
-> m () |

Sets whether the SGR 1 attribute also switches to the bright counterpart of the first 8 palette colors, in addition to making them bold (legacy behavior) or if SGR 1 only enables bold and leaves the color intact.

Since: 0.52

## setCellHeightScale

terminalSetCellHeightScale Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Double | `scale`: the cell height scale
-> m () |

Sets the terminal's cell height scale to `scale`.

This can be used to increase the line spacing. (The font's height is not affected.) Valid values go from 1.0 (default) to 2.0 ("double spacing").

Since: 0.52

## setCellWidthScale

terminalSetCellWidthScale Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Double | `scale`: the cell width scale
-> m () |

Sets the terminal's cell width scale to `scale`.

This can be used to increase the letter spacing. (The font's width is not affected.) Valid values go from 1.0 (default) to 2.0.

Since: 0.52

## setCjkAmbiguousWidth

terminalSetCjkAmbiguousWidth Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `width`: either 1 (narrow) or 2 (wide)
-> m () |

This setting controls whether ambiguous-width characters are narrow or wide. (Note that when using a non-UTF-8 encoding set via `terminalSetEncoding`, the width of ambiguous-width characters is fixed and determined by the encoding itself.)

## setClearBackground

terminalSetClearBackground Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `setting`: whether to clear the background
-> m () |

Sets whether to paint the background with the background colour. The default is `True`.

This function is rarely useful. One use for it is to add a background image to the terminal.

Since: 0.52

## setColorBackground

terminalSetColorBackground Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> RGBA | `background`: the new background color
-> m () |

Sets the background color for text which does not have a specific background color assigned. Only has effect when no background image is set and when the terminal is not transparent.

## setColorBold

terminalSetColorBold Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe RGBA | `bold`: the new bold color or `Nothing`
-> m () |

Sets the color used to draw bold text in the default foreground color. If `bold` is `Nothing` then the default color is used.

## setColorCursor

terminalSetColorCursor Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe RGBA | `cursorBackground`: the new color to use for the text cursor, or `Nothing`
-> m () |

Sets the background color for text which is under the cursor. If `Nothing`, text under the cursor will be drawn with foreground and background colors reversed.

## setColorCursorForeground

terminalSetColorCursorForeground Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe RGBA | `cursorForeground`: the new color to use for the text cursor, or `Nothing`
-> m () |

Sets the foreground color for text which is under the cursor. If `Nothing`, text under the cursor will be drawn with foreground and background colors reversed.

Since: 0.44

## setColorForeground

terminalSetColorForeground Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> RGBA | `foreground`: the new foreground color
-> m () |

Sets the foreground color used to draw normal text.

## setColorHighlight

terminalSetColorHighlight Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe RGBA | `highlightBackground`: the new color to use for highlighted text, or `Nothing`
-> m () |

Sets the background color for text which is highlighted. If `Nothing`, it is unset. If neither highlight background nor highlight foreground are set, highlighted text (which is usually highlighted because it is selected) will be drawn with foreground and background colors reversed.

## setColorHighlightForeground

terminalSetColorHighlightForeground Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe RGBA | `highlightForeground`: the new color to use for highlighted text, or `Nothing`
-> m () |

Sets the foreground color for text which is highlighted. If `Nothing`, it is unset. If neither highlight background nor highlight foreground are set, highlighted text (which is usually highlighted because it is selected) will be drawn with foreground and background colors reversed.

## setColors

terminalSetColors Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe RGBA | `foreground`: the new foreground color, or `Nothing`
-> Maybe RGBA | `background`: the new background color, or `Nothing`
-> Maybe [RGBA] | `palette`: the color palette
-> m () |

`palette` specifies the new values for the 256 palette colors: 8 standard colors, their 8 bright counterparts, 6x6x6 color cube, and 24 grayscale colors. Omitted entries will default to a hardcoded value.

`paletteSize` must be 0, 8, 16, 232 or 256.

If `foreground` is `Nothing` and `paletteSize` is greater than 0, the new foreground color is taken from `palette`[7]. If `background` is `Nothing` and `paletteSize` is greater than 0, the new background color is taken from `palette`[0].

## setContextMenu

terminalSetContextMenu Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a, IsWidget b) |
=> a | `terminal`: a `Terminal`
-> Maybe b | `menu`: a menu
-> m () |

Sets `menu` as the context menu in `terminal`. Use `Nothing` to unset the current menu.

Note that a menu model set with `terminalSetContextMenuModel` takes precedence over a menu set using this function.

Since: 0.76

## setContextMenuModel

terminalSetContextMenuModel Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a, IsMenuModel b) |
=> a | `terminal`: a `Terminal`
-> Maybe b | `model`: a `MenuModel`
-> m () |

Sets `model` as the context menu model in `terminal`. Use `Nothing` to unset the current menu model.

Since: 0.76

## setCursorBlinkMode

terminalSetCursorBlinkMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> CursorBlinkMode | `mode`: the `CursorBlinkMode` to use
-> m () |

Sets whether or not the cursor will blink. Using `CursorBlinkModeSystem` will use the `Settings`::`gtk-cursor-blink` setting.

## setCursorShape

terminalSetCursorShape Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> CursorShape | `shape`: the `CursorShape` to use
-> m () |

Sets the shape of the cursor drawn.

## setDefaultColors

terminalSetDefaultColors Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m () |

Reset the terminal palette to reasonable compiled-in default color.

## setDeleteBinding

terminalSetDeleteBinding Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> EraseBinding | `binding`: a `EraseBinding` for the delete key
-> m () |

Modifies the terminal's delete key binding, which controls what string or control sequence the terminal sends to its child when the user presses the delete key.

## setEnableA11y

terminalSetEnableA11y Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `enableA11y`: `True` to enable a11y support
-> m () |

Controls whether or not the terminal will communicate with a11y backends.

Since: 0.78

## setEnableBidi

terminalSetEnableBidi Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `enableBidi`: `True` to enable BiDi support
-> m () |

Controls whether or not the terminal will perform bidirectional text rendering.

Since: 0.58

## setEnableFallbackScrolling

terminalSetEnableFallbackScrolling Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `enable`: whether to enable fallback scrolling
-> m () |

Controls whether the terminal uses scroll events to scroll the history if the event was not otherwise consumed by it.

This function is rarely useful, except when the terminal is added to a `ScrolledWindow`, to perform kinetic scrolling (while vte itself does not, yet, implement kinetic scrolling by itself).

Since: 0.64

## setEnableLegacyOsc777

terminalSetEnableLegacyOsc777 Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `enable`: whether to enable legacy OSC 777
-> m () |

Sets whether legacy OSC 777 sequences are translated to their corresponding termprops.

Since: 0.78

## setEnableShaping

terminalSetEnableShaping Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `enableShaping`: `True` to enable Arabic shaping
-> m () |

Controls whether or not the terminal will shape Arabic text.

Since: 0.58

## setEnableSixel

terminalSetEnableSixel Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `enabled`: whether to enable SIXEL images
-> m () |

Set whether to enable SIXEL images.

Since: 0.62

## setEncoding

terminalSetEncoding Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe Text | `codeset`: target charset, or `Nothing` to use UTF-8
-> m () | (Can throw `GError`)

Deprecated: (Since version 0.54)Support for non-UTF-8 is deprecated.

Changes the encoding the terminal will expect data from the child to be encoded with. For certain terminal types, applications executing in the terminal can change the encoding. If `codeset` is `Nothing`, it uses "UTF-8".

Note: Support for non-UTF-8 is deprecated and may get removed altogether. Instead of this function, you should use a wrapper like luit(1) when spawning the child process.

## setFont

terminalSetFont Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe FontDescription | `fontDesc`: a `FontDescription` for the desired font, or `Nothing`
-> m () |

Sets the font used for rendering all text displayed by the terminal, overriding any fonts set using `widgetModifyFont`. The terminal will immediately attempt to load the desired font, retrieve its metrics, and attempt to resize itself to keep the same number of rows and columns. The font scale is applied to the specified font.

## setFontOptions

terminalSetFontOptions Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Maybe FontOptions | `fontOptions`: the font options, or `Nothing`
-> m () |

Sets the terminal's font options to `options`.

Note that on GTK4, the terminal by default uses font options with `HintMetricsOn` set; to override that, use this function to set a `FontOptions` that has `HintMetricsOff` set.

Since: 0.74

## setFontScale

terminalSetFontScale Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Double | `scale`: the font scale
-> m () |

Sets the terminal's font scale to `scale`.

## setGeometryHintsForWindow

terminalSetGeometryHintsForWindow Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a, IsWindow b) |
=> a | `terminal`: a `Terminal`
-> b | `window`: a `Window`
-> m () |

Deprecated: (Since version 0.52)

Sets `terminal` as `window`'s geometry widget. See `windowSetGeometryHints` for more information.

`terminal` must be realized (see `widgetGetRealized`).

## setInputEnabled

terminalSetInputEnabled Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `enabled`: whether to enable user input
-> m () |

Enables or disables user input. When user input is disabled, the terminal's child will not receive any key press, or mouse button press or motion events sent to it.

## setMouseAutohide

terminalSetMouseAutohide Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `setting`: whether the mouse pointer should autohide
-> m () |

Changes the value of the terminal's mouse autohide setting. When autohiding is enabled, the mouse cursor will be hidden when the user presses a key and shown when the user moves the mouse. This setting can be read using `terminalGetMouseAutohide`.

## setPty

terminalSetPty Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a, IsPty b) |
=> a | `terminal`: a `Terminal`
-> Maybe b | `pty`: a `Pty`, or `Nothing`
-> m () |

Sets `pty` as the PTY to use in `terminal`. Use `Nothing` to unset the PTY.

## setRewrapOnResize

terminalSetRewrapOnResize Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `rewrap`: `True` if the terminal should rewrap on resize
-> m () |

Deprecated: (Since version 0.58)

Controls whether or not the terminal will rewrap its contents, including the scrollback history, whenever the terminal's width changes.

## setScrollOnInsert

terminalSetScrollOnInsert Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `scroll`: whether the terminal should scroll on insert
-> m () |

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when text is inserted, e.g. by a paste.

Since: 0.76

## setScrollOnKeystroke

terminalSetScrollOnKeystroke Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `scroll`: whether the terminal should scroll on keystrokes
-> m () |

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the user presses a key. Modifier keys do not trigger this behavior.

Since: 0.52

## setScrollOnOutput

terminalSetScrollOnOutput Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `scroll`: whether the terminal should scroll on output
-> m () |

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child.

Since: 0.52

## setScrollUnitIsPixels

terminalSetScrollUnitIsPixels Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `enable`: whether to use pixels as scroll unit
-> m () |

Controls whether the terminal's scroll unit is lines or pixels.

This function is rarely useful, except when the terminal is added to a `ScrolledWindow`.

Since: 0.66

## setScrollbackLines

terminalSetScrollbackLines Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> CLong | `lines`: the length of the history buffer
-> m () |

Sets the length of the scrollback buffer used by the terminal. The size of the scrollback buffer will be set to the larger of this value and the number of visible rows the widget can display, so 0 can safely be used to disable scrollback.

A negative value means "infinite scrollback".

Using a large scrollback buffer (roughly 1M+ lines) may lead to performance degradation or exhaustion of system resources, and is therefore not recommended.

Note that this setting only affects the normal screen buffer. No scrollback is allowed on the alternate screen buffer.

## setSize

terminalSetSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> CLong | `columns`: the desired number of columns
-> CLong | `rows`: the desired number of rows
-> m () |

Attempts to change the terminal's size in terms of rows and columns. If the attempt succeeds, the widget will resize itself to the proper size.

## setSuppressLegacySignals

terminalSetSuppressLegacySignals Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m () |

Suppress emissions of signals and property notifications that are deprecated.

Since: 0.78

## setTextBlinkMode

terminalSetTextBlinkMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> TextBlinkMode | `textBlinkMode`: the `TextBlinkMode` to use
-> m () |

Controls whether or not the terminal will allow blinking text.

Since: 0.52

## setWordCharExceptions

terminalSetWordCharExceptions Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Text | `exceptions`: a string of ASCII punctuation characters, or `Nothing`
-> m () |

With this function you can provide a set of characters which will be considered parts of a word when doing word-wise selection, in addition to the default which only considers alphanumeric characters part of a word.

The characters in `exceptions` must be non-alphanumeric, each character must occur only once, and if `exceptions` contains the character U+002D HYPHEN-MINUS, it must be at the start of the string.

Use `Nothing` to reset the set of exception characters to the default.

Since: 0.40

## setXalign

terminalSetXalign Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Align | `align`: alignment value from `Align`
-> m () |

Sets the horizontal alignment of `terminal` within its allocation.

Note: `VTE_ALIGN_START_FILL` is not supported, and will be treated like `AlignStart`.

Since: 0.76

## setXfill

terminalSetXfill Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `fill`: fillment value from `VteFill`
-> m () |

Sets the horizontal fillment of `terminal` within its allocation.

Note: `VTE_FILL_START_FILL` is not supported, and will be treated like `VTE_FILL_START`.

Since: 0.76

## setYalign

terminalSetYalign Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Align | `align`: alignment value from `Align`
-> m () |

Sets the vertical alignment of `terminal` within its allocation.

Since: 0.76

## setYfill

terminalSetYfill Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Bool | `fill`: fillment value from `VteFill`
-> m () |

Sets the vertical fillment of `terminal` within its allocation. Note that yfill is only supported with yalign set to `AlignStart`, and is ignored for all other yalign values.

Since: 0.76

## spawnAsync

terminalSpawnAsync Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a, IsCancellable b) |
=> a | `terminal`: a `Terminal`
-> [PtyFlags] | `ptyFlags`: flags from `PtyFlags`
-> Maybe Text | `workingDirectory`: the name of a directory the command should start in, or `Nothing` to use the current working directory
-> [[Char]] | `argv`: child's argument vector
-> Maybe [[Char]] | `envv`: a list of environment variables to be added to the environment before starting the process, or `Nothing`
-> [SpawnFlags] | `spawnFlags`: flags from `SpawnFlags`
-> Maybe SpawnChildSetupFunc | `childSetup`: an extra child setup function to run in the child just before `exec()`, or `Nothing`
-> Int32 | `timeout`: a timeout value in ms, -1 for the default timeout, or G_MAXINT to wait indefinitely
-> Maybe b | `cancellable`: a `Cancellable`, or `Nothing`
-> Maybe TerminalSpawnAsyncCallback | `callback`: a `TerminalSpawnAsyncCallback`, or `Nothing`
-> m () |

A convenience function that wraps creating the `Pty` and spawning the child process on it. Like `terminalSpawnWithFdsAsync`, except that this function does not allow passing file descriptors to the child process. See `terminalSpawnWithFdsAsync` for more information.

Since: 0.48

## spawnSync

terminalSpawnSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a, IsCancellable b) |
=> a | `terminal`: a `Terminal`
-> [PtyFlags] | `ptyFlags`: flags from `PtyFlags`
-> Maybe Text | `workingDirectory`: the name of a directory the command should start in, or `Nothing` to use the current working directory
-> [[Char]] | `argv`: child's argument vector
-> Maybe [[Char]] | `envv`: a list of environment variables to be added to the environment before starting the process, or `Nothing`
-> [SpawnFlags] | `spawnFlags`: flags from `SpawnFlags`
-> Maybe SpawnChildSetupFunc | `childSetup`: an extra child setup function to run in the child just before `exec()`, or `Nothing`
-> Maybe b | `cancellable`: a `Cancellable`, or `Nothing`
-> m Int32 | (Can throw `GError`)

Deprecated: (Since version 0.48)Use `terminalSpawnAsync` instead.

Starts the specified command under a newly-allocated controlling pseudo-terminal. The `argv` and `envv` lists should be `Nothing`-terminated. The "TERM" environment variable is automatically set to a default value, but can be overridden from `envv`. `ptyFlags` controls logging the session to the specified system log files.

Note that `SpawnFlagsDoNotReapChild` will always be added to `spawnFlags`.

Note also that `SpawnFlagsStdoutToDevNull`, `SpawnFlagsStderrToDevNull`, and `SpawnFlagsChildInheritsStdin` are not supported in `spawnFlags`, since stdin, stdout and stderr of the child process will always be connected to the PTY.

Note that all open file descriptors will be closed in the child. If you want to keep some file descriptor open for use in the child process, you need to use a child setup function that unsets the FD_CLOEXEC flag on that file descriptor.

See `vte_pty_new()`, `spawnAsync` and `terminalWatchChild` for more information.

Beginning with 0.52, sets PWD to `workingDirectory` in order to preserve symlink components. The caller should also make sure that symlinks were preserved while constructing the value of `workingDirectory`, e.g. by using `terminalGetCurrentDirectoryUri`, `getCurrentDir` or `get_current_dir_name()`.

## spawnWithFdsAsync

terminalSpawnWithFdsAsync Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a, IsCancellable b) |
=> a | `terminal`: a `Terminal`
-> [PtyFlags] | `ptyFlags`: flags from `PtyFlags`
-> Maybe Text | `workingDirectory`: the name of a directory the command should start in, or `Nothing` to use the current working directory
-> [[Char]] | `argv`: child's argument vector
-> Maybe [[Char]] | `envv`: a list of environment variables to be added to the environment before starting the process, or `Nothing`
-> Maybe [Int32] | `fds`: an array of file descriptors, or `Nothing`
-> Maybe [Int32] | `mapFds`: an array of integers, or `Nothing`
-> [SpawnFlags] | `spawnFlags`: flags from `SpawnFlags`
-> Maybe SpawnChildSetupFunc | `childSetup`: an extra child setup function to run in the child just before `exec()`, or `Nothing`
-> Int32 | `timeout`: a timeout value in ms, -1 for the default timeout, or G_MAXINT to wait indefinitely
-> Maybe b | `cancellable`: a `Cancellable`, or `Nothing`
-> Maybe TerminalSpawnAsyncCallback | `callback`: a `TerminalSpawnAsyncCallback`, or `Nothing`
-> m () |

A convenience function that wraps creating the `Pty` and spawning the child process on it. See `ptyNewSync`, `ptySpawnWithFdsAsync`, and `ptySpawnFinish` for more information.

When the operation is finished successfully, `callback` will be called with the child `GPid`, and a `Nothing` `GError`. The child PID will already be watched via `terminalWatchChild`.

When the operation fails, `callback` will be called with a -1 `GPid`, and a non-`Nothing` `GError` containing the error information.

Note that `SpawnFlagsStdoutToDevNull`, `SpawnFlagsStderrToDevNull`, and `SpawnFlagsChildInheritsStdin` are not supported in `spawnFlags`, since stdin, stdout and stderr of the child process will always be connected to the PTY.

If `fds` is not `Nothing`, the child process will map the file descriptors from `fds` according to `mapFds`; `nMapFds` must be less or equal to `nFds`. This function will take ownership of the file descriptors in `fds`; you must not use or close them after this call.

Note that all open file descriptors apart from those mapped as above will be closed in the child. (If you want to keep some other file descriptor open for use in the child process, you need to use a child setup function that unsets the FD_CLOEXEC flag on that file descriptor manually.)

Beginning with 0.60, and on linux only, and unless `SPAWN_NO_SYSTEMD_SCOPE` is passed in `spawnFlags`, the newly created child process will be moved to its own systemd user scope; and if `SPAWN_REQUIRE_SYSTEMD_SCOPE` is passed, and creation of the systemd user scope fails, the whole spawn will fail. You can override the options used for the systemd user scope by providing a systemd override file for 'vte-spawn-.scope' unit. See man:systemd.unit(5) for further information.

Note that if `terminal` has been destroyed before the operation is called, `callback` will be called with a `Nothing` `terminal`; you must not do anything in the callback besides freeing any resources associated with `userData`, but taking care not to access the now-destroyed `Terminal`. Note that in this case, if spawning was successful, the child process will be aborted automatically.

Beginning with 0.52, sets PWD to `workingDirectory` in order to preserve symlink components. The caller should also make sure that symlinks were preserved while constructing the value of `workingDirectory`, e.g. by using `terminalGetCurrentDirectoryUri`, `getCurrentDir` or `get_current_dir_name()`.

Since: 0.62

## unselectAll

terminalUnselectAll Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> m () |

Clears the current selection.

## watchChild

terminalWatchChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) |
=> a | `terminal`: a `Terminal`
-> Int32 | `childPid`: a `GPid`
-> m () |

Watches `childPid`. When the process exists, the Terminal::childExited signal will be called with the child's exit status.

Prior to calling this function, a `Pty` must have been set in `terminal` using `terminalSetPty`. When the child exits, the terminal's `Pty` will be set to `Nothing`.

Note: `g_child_watch_add()` or `childWatchAdd` must not have been called for `childPid`, nor a `Source` for it been created with `childWatchSourceNew`.

Note: when using the `spawnAsync` family of functions, the `SpawnFlagsDoNotReapChild` flag MUST have been passed.

## writeContentsSync

terminalWriteContentsSync Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a, IsOutputStream b, IsCancellable c) |
=> a | `terminal`: a `Terminal`
-> b | `stream`: a `OutputStream` to write to
-> WriteFlags | `flags`: a set of `WriteFlags`
-> Maybe c | `cancellable`: a `Cancellable` object, or `Nothing`
-> m () | (Can throw `GError`)

Write contents of the current contents of `terminal` (including any scrollback history) to `stream` according to `flags`.

If `cancellable` is not `Nothing`, then the operation can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error `IOErrorEnumCancelled` will be returned in `error`.

This is a synchronous operation and will make the widget (and input processing) during the write operation, which may take a long time depending on scrollback history and `stream` availability for writing.

# Properties

## allowBold

Controls whether or not the terminal will attempt to draw bold text, by using a bold font variant.

constructTerminalAllowBold :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalAllowBold :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

Get the value of the “`allow-bold`” property. When overloading is enabled, this is equivalent to

    get terminal #allowBold

setTerminalAllowBold :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

Set the value of the “`allow-bold`” property. When overloading is enabled, this is equivalent to

    set terminal [ #allowBold := value ]

## allowHyperlink

Controls whether or not hyperlinks (OSC 8 escape sequence) are recognized and displayed.

Since: 0.50

constructTerminalAllowHyperlink :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalAllowHyperlink :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

Get the value of the “`allow-hyperlink`” property. When overloading is enabled, this is equivalent to

    get terminal #allowHyperlink

setTerminalAllowHyperlink :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

Set the value of the “`allow-hyperlink`” property. When overloading is enabled, this is equivalent to

    set terminal [ #allowHyperlink := value ]

## audibleBell

Controls whether or not the terminal will beep when the child outputs the "bl" sequence.

constructTerminalAudibleBell :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalAudibleBell :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

Get the value of the “`audible-bell`” property. When overloading is enabled, this is equivalent to

    get terminal #audibleBell

setTerminalAudibleBell :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

Set the value of the “`audible-bell`” property. When overloading is enabled, this is equivalent to

    set terminal [ #audibleBell := value ]

## backspaceBinding

Controls what string or control sequence the terminal sends to its child when the user presses the backspace key.

constructTerminalBackspaceBinding :: (IsTerminal o, MonadIO m) => EraseBinding -> m (GValueConstruct o) Source #

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

getTerminalBackspaceBinding :: (MonadIO m, IsTerminal o) => o -> m EraseBinding Source #

Get the value of the “`backspace-binding`” property. When overloading is enabled, this is equivalent to

    get terminal #backspaceBinding

setTerminalBackspaceBinding :: (MonadIO m, IsTerminal o) => o -> EraseBinding -> m () Source #

Set the value of the “`backspace-binding`” property. When overloading is enabled, this is equivalent to

    set terminal [ #backspaceBinding := value ]

## boldIsBright

Whether the SGR 1 attribute also switches to the bright counterpart of the first 8 palette colors, in addition to making them bold (legacy behavior) or if SGR 1 only enables bold and leaves the color intact.

Since: 0.52

constructTerminalBoldIsBright :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalBoldIsBright :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

Get the value of the “`bold-is-bright`” property. When overloading is enabled, this is equivalent to

    get terminal #boldIsBright

setTerminalBoldIsBright :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

Set the value of the “`bold-is-bright`” property. When overloading is enabled, this is equivalent to

    set terminal [ #boldIsBright := value ]

## cellHeightScale

Scale factor for the cell height, to increase line spacing. (The font's height is not affected.)

Since: 0.52

constructTerminalCellHeightScale :: (IsTerminal o, MonadIO m) => Double -> m (GValueConstruct o) Source #

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

getTerminalCellHeightScale :: (MonadIO m, IsTerminal o) => o -> m Double Source #

Get the value of the “`cell-height-scale`” property. When overloading is enabled, this is equivalent to

    get terminal #cellHeightScale

setTerminalCellHeightScale :: (MonadIO m, IsTerminal o) => o -> Double -> m () Source #

Set the value of the “`cell-height-scale`” property. When overloading is enabled, this is equivalent to

    set terminal [ #cellHeightScale := value ]

## cellWidthScale

Scale factor for the cell width, to increase letter spacing. (The font's width is not affected.)

Since: 0.52

constructTerminalCellWidthScale :: (IsTerminal o, MonadIO m) => Double -> m (GValueConstruct o) Source #

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

getTerminalCellWidthScale :: (MonadIO m, IsTerminal o) => o -> m Double Source #

Get the value of the “`cell-width-scale`” property. When overloading is enabled, this is equivalent to

    get terminal #cellWidthScale

setTerminalCellWidthScale :: (MonadIO m, IsTerminal o) => o -> Double -> m () Source #

Set the value of the “`cell-width-scale`” property. When overloading is enabled, this is equivalent to

    set terminal [ #cellWidthScale := value ]

## cjkAmbiguousWidth

This setting controls whether ambiguous-width characters are narrow or wide. (Note that when using a non-UTF-8 encoding set via `terminalSetEncoding`, the width of ambiguous-width characters is fixed and determined by the encoding itself.)

This setting only takes effect the next time the terminal is reset, either via escape sequence or with `terminalReset`.

constructTerminalCjkAmbiguousWidth :: (IsTerminal o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getTerminalCjkAmbiguousWidth :: (MonadIO m, IsTerminal o) => o -> m Int32 Source #

Get the value of the “`cjk-ambiguous-width`” property. When overloading is enabled, this is equivalent to

    get terminal #cjkAmbiguousWidth

setTerminalCjkAmbiguousWidth :: (MonadIO m, IsTerminal o) => o -> Int32 -> m () Source #

Set the value of the “`cjk-ambiguous-width`” property. When overloading is enabled, this is equivalent to

    set terminal [ #cjkAmbiguousWidth := value ]

## contextMenu

The menu used for context menus. Note that context menu model set with the `Terminal`::`context-menu-model` property or `terminalSetContextMenuModel` takes precedence over this.

Since: 0.76

clearTerminalContextMenu :: (MonadIO m, IsTerminal o) => o -> m () Source #

Set the value of the “`context-menu`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #contextMenu

constructTerminalContextMenu :: (IsTerminal o, MonadIO m, IsMenu a) => a -> m (GValueConstruct o) Source #

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

getTerminalContextMenu :: (MonadIO m, IsTerminal o) => o -> m (Maybe Menu) Source #

Get the value of the “`context-menu`” property. When overloading is enabled, this is equivalent to

    get terminal #contextMenu

setTerminalContextMenu :: (MonadIO m, IsTerminal o, IsMenu a) => o -> a -> m () Source #

Set the value of the “`context-menu`” property. When overloading is enabled, this is equivalent to

    set terminal [ #contextMenu := value ]

## contextMenuModel

The menu model used for context menus. If non-`Nothing`, the context menu is generated from this model, and overrides a context menu set with the `Terminal`::`context-menu` property or `terminalSetContextMenu`.

Since: 0.76

clearTerminalContextMenuModel :: (MonadIO m, IsTerminal o) => o -> m () Source #

Set the value of the “`context-menu-model`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #contextMenuModel

constructTerminalContextMenuModel :: (IsTerminal o, MonadIO m, IsMenuModel a) => a -> m (GValueConstruct o) Source #

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

getTerminalContextMenuModel :: (MonadIO m, IsTerminal o) => o -> m (Maybe MenuModel) Source #

Get the value of the “`context-menu-model`” property. When overloading is enabled, this is equivalent to

    get terminal #contextMenuModel

setTerminalContextMenuModel :: (MonadIO m, IsTerminal o, IsMenuModel a) => o -> a -> m () Source #

Set the value of the “`context-menu-model`” property. When overloading is enabled, this is equivalent to

    set terminal [ #contextMenuModel := value ]

## currentDirectoryUri

The current directory URI, or `Nothing` if unset.

getTerminalCurrentDirectoryUri :: (MonadIO m, IsTerminal o) => o -> m (Maybe Text) Source #

Get the value of the “`current-directory-uri`” property. When overloading is enabled, this is equivalent to

    get terminal #currentDirectoryUri

## currentFileUri

The current file URI, or `Nothing` if unset.

getTerminalCurrentFileUri :: (MonadIO m, IsTerminal o) => o -> m (Maybe Text) Source #

Get the value of the “`current-file-uri`” property. When overloading is enabled, this is equivalent to

    get terminal #currentFileUri

## cursorBlinkMode

Sets whether or not the cursor will blink. Using `CursorBlinkModeSystem` will use the Settings:gtkCursorBlink setting.

constructTerminalCursorBlinkMode :: (IsTerminal o, MonadIO m) => CursorBlinkMode -> m (GValueConstruct o) Source #

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

getTerminalCursorBlinkMode :: (MonadIO m, IsTerminal o) => o -> m CursorBlinkMode Source #

Get the value of the “`cursor-blink-mode`” property. When overloading is enabled, this is equivalent to

    get terminal #cursorBlinkMode

setTerminalCursorBlinkMode :: (MonadIO m, IsTerminal o) => o -> CursorBlinkMode -> m () Source #

Set the value of the “`cursor-blink-mode`” property. When overloading is enabled, this is equivalent to

    set terminal [ #cursorBlinkMode := value ]

## cursorShape

Controls the shape of the cursor.

constructTerminalCursorShape :: (IsTerminal o, MonadIO m) => CursorShape -> m (GValueConstruct o) Source #

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

getTerminalCursorShape :: (MonadIO m, IsTerminal o) => o -> m CursorShape Source #

Get the value of the “`cursor-shape`” property. When overloading is enabled, this is equivalent to

    get terminal #cursorShape

setTerminalCursorShape :: (MonadIO m, IsTerminal o) => o -> CursorShape -> m () Source #

Set the value of the “`cursor-shape`” property. When overloading is enabled, this is equivalent to

    set terminal [ #cursorShape := value ]

## deleteBinding

Controls what string or control sequence the terminal sends to its child when the user presses the delete key.

constructTerminalDeleteBinding :: (IsTerminal o, MonadIO m) => EraseBinding -> m (GValueConstruct o) Source #

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

getTerminalDeleteBinding :: (MonadIO m, IsTerminal o) => o -> m EraseBinding Source #

Get the value of the “`delete-binding`” property. When overloading is enabled, this is equivalent to

    get terminal #deleteBinding

setTerminalDeleteBinding :: (MonadIO m, IsTerminal o) => o -> EraseBinding -> m () Source #

Set the value of the “`delete-binding`” property. When overloading is enabled, this is equivalent to

    set terminal [ #deleteBinding := value ]

## enableA11y

Controls whether or not a11y is enabled for the widget.

Since: 0.78

constructTerminalEnableA11y :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalEnableA11y :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

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

    get terminal #enableA11y

setTerminalEnableA11y :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

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

    set terminal [ #enableA11y := value ]

## enableBidi

Controls whether or not the terminal will perform bidirectional text rendering.

Since: 0.58

constructTerminalEnableBidi :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalEnableBidi :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

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

    get terminal #enableBidi

setTerminalEnableBidi :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

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

    set terminal [ #enableBidi := value ]

## enableFallbackScrolling

No description available in the introspection data.

constructTerminalEnableFallbackScrolling :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalEnableFallbackScrolling :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

Get the value of the “`enable-fallback-scrolling`” property. When overloading is enabled, this is equivalent to

    get terminal #enableFallbackScrolling

setTerminalEnableFallbackScrolling :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

Set the value of the “`enable-fallback-scrolling`” property. When overloading is enabled, this is equivalent to

    set terminal [ #enableFallbackScrolling := value ]

## enableLegacyOsc777

Whether legacy OSC 777 sequences are translated to their corresponding termprops.

Since: 0.78

constructTerminalEnableLegacyOsc777 :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalEnableLegacyOsc777 :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

Get the value of the “`enable-legacy-osc777`” property. When overloading is enabled, this is equivalent to

    get terminal #enableLegacyOsc777

setTerminalEnableLegacyOsc777 :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

Set the value of the “`enable-legacy-osc777`” property. When overloading is enabled, this is equivalent to

    set terminal [ #enableLegacyOsc777 := value ]

## enableShaping

Controls whether or not the terminal will shape Arabic text.

Since: 0.58

constructTerminalEnableShaping :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalEnableShaping :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

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

    get terminal #enableShaping

setTerminalEnableShaping :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

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

    set terminal [ #enableShaping := value ]

## enableSixel

Controls whether SIXEL image support is enabled.

Since: 0.62

constructTerminalEnableSixel :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalEnableSixel :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

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

    get terminal #enableSixel

setTerminalEnableSixel :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

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

    set terminal [ #enableSixel := value ]

## encoding

Controls the encoding the terminal will expect data from the child to be encoded with. For certain terminal types, applications executing in the terminal can change the encoding. The default is defined by the application's locale settings.

clearTerminalEncoding :: (MonadIO m, IsTerminal o) => o -> m () Source #

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

    clear #encoding

constructTerminalEncoding :: (IsTerminal o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getTerminalEncoding :: (MonadIO m, IsTerminal o) => o -> m (Maybe Text) Source #

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

    get terminal #encoding

setTerminalEncoding :: (MonadIO m, IsTerminal o) => o -> Text -> m () Source #

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

    set terminal [ #encoding := value ]

## fontDesc

Specifies the font used for rendering all text displayed by the terminal, overriding any fonts set using `widgetModifyFont`. The terminal will immediately attempt to load the desired font, retrieve its metrics, and attempt to resize itself to keep the same number of rows and columns.

clearTerminalFontDesc :: (MonadIO m, IsTerminal o) => o -> m () Source #

Set the value of the “`font-desc`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #fontDesc

constructTerminalFontDesc :: (IsTerminal o, MonadIO m) => FontDescription -> m (GValueConstruct o) Source #

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

getTerminalFontDesc :: (MonadIO m, IsTerminal o) => o -> m (Maybe FontDescription) Source #

Get the value of the “`font-desc`” property. When overloading is enabled, this is equivalent to

    get terminal #fontDesc

setTerminalFontDesc :: (MonadIO m, IsTerminal o) => o -> FontDescription -> m () Source #

Set the value of the “`font-desc`” property. When overloading is enabled, this is equivalent to

    set terminal [ #fontDesc := value ]

## fontOptions

The terminal's font options, or `Nothing` to use the default font options.

Note that on GTK4, the terminal by default uses font options with `HintMetricsOn` set; to override that, use this function to set a `FontOptions` that has `HintMetricsOff` set.

Since: 0.74

clearTerminalFontOptions :: (MonadIO m, IsTerminal o) => o -> m () Source #

Set the value of the “`font-options`” property to `Nothing`. When overloading is enabled, this is equivalent to

    clear #fontOptions

constructTerminalFontOptions :: (IsTerminal o, MonadIO m) => FontOptions -> m (GValueConstruct o) Source #

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

getTerminalFontOptions :: (MonadIO m, IsTerminal o) => o -> m (Maybe FontOptions) Source #

Get the value of the “`font-options`” property. When overloading is enabled, this is equivalent to

    get terminal #fontOptions

setTerminalFontOptions :: (MonadIO m, IsTerminal o) => o -> FontOptions -> m () Source #

Set the value of the “`font-options`” property. When overloading is enabled, this is equivalent to

    set terminal [ #fontOptions := value ]

## fontScale

The terminal's font scale.

constructTerminalFontScale :: (IsTerminal o, MonadIO m) => Double -> m (GValueConstruct o) Source #

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

getTerminalFontScale :: (MonadIO m, IsTerminal o) => o -> m Double Source #

Get the value of the “`font-scale`” property. When overloading is enabled, this is equivalent to

    get terminal #fontScale

setTerminalFontScale :: (MonadIO m, IsTerminal o) => o -> Double -> m () Source #

Set the value of the “`font-scale`” property. When overloading is enabled, this is equivalent to

    set terminal [ #fontScale := value ]

## hyperlinkHoverUri

The currently hovered hyperlink URI, or `Nothing` if unset.

Since: 0.50

getTerminalHyperlinkHoverUri :: (MonadIO m, IsTerminal o) => o -> m (Maybe Text) Source #

Get the value of the “`hyperlink-hover-uri`” property. When overloading is enabled, this is equivalent to

    get terminal #hyperlinkHoverUri

## iconTitle

No description available in the introspection data.

getTerminalIconTitle :: (MonadIO m, IsTerminal o) => o -> m (Maybe Text) Source #

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

    get terminal #iconTitle

## inputEnabled

Controls whether the terminal allows user input. When user input is disabled, key press and mouse button press and motion events are not sent to the terminal's child.

constructTerminalInputEnabled :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalInputEnabled :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

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

    get terminal #inputEnabled

setTerminalInputEnabled :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

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

    set terminal [ #inputEnabled := value ]

## pointerAutohide

Controls the value of the terminal's mouse autohide setting. When autohiding is enabled, the mouse cursor will be hidden when the user presses a key and shown when the user moves the mouse.

constructTerminalPointerAutohide :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalPointerAutohide :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

Get the value of the “`pointer-autohide`” property. When overloading is enabled, this is equivalent to

    get terminal #pointerAutohide

setTerminalPointerAutohide :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

Set the value of the “`pointer-autohide`” property. When overloading is enabled, this is equivalent to

    set terminal [ #pointerAutohide := value ]

## pty

The PTY object for the terminal.

clearTerminalPty :: (MonadIO m, IsTerminal o) => o -> m () Source #

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

    clear #pty

constructTerminalPty :: (IsTerminal o, MonadIO m, IsPty a) => a -> m (GValueConstruct o) Source #

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

getTerminalPty :: (MonadIO m, IsTerminal o) => o -> m (Maybe Pty) Source #

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

    get terminal #pty

setTerminalPty :: (MonadIO m, IsTerminal o, IsPty a) => o -> a -> m () Source #

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

    set terminal [ #pty := value ]

## rewrapOnResize

Controls whether or not the terminal will rewrap its contents, including the scrollback buffer, whenever the terminal's width changes.

constructTerminalRewrapOnResize :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalRewrapOnResize :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

Get the value of the “`rewrap-on-resize`” property. When overloading is enabled, this is equivalent to

    get terminal #rewrapOnResize

setTerminalRewrapOnResize :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

Set the value of the “`rewrap-on-resize`” property. When overloading is enabled, this is equivalent to

    set terminal [ #rewrapOnResize := value ]

## scrollOnInsert

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the text is inserted (e.g. by a paste).

Since: 0.76

constructTerminalScrollOnInsert :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalScrollOnInsert :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

Get the value of the “`scroll-on-insert`” property. When overloading is enabled, this is equivalent to

    get terminal #scrollOnInsert

setTerminalScrollOnInsert :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

Set the value of the “`scroll-on-insert`” property. When overloading is enabled, this is equivalent to

    set terminal [ #scrollOnInsert := value ]

## scrollOnKeystroke

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the user presses a key. Modifier keys do not trigger this behavior.

constructTerminalScrollOnKeystroke :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalScrollOnKeystroke :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

Get the value of the “`scroll-on-keystroke`” property. When overloading is enabled, this is equivalent to

    get terminal #scrollOnKeystroke

setTerminalScrollOnKeystroke :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

Set the value of the “`scroll-on-keystroke`” property. When overloading is enabled, this is equivalent to

    set terminal [ #scrollOnKeystroke := value ]

## scrollOnOutput

Controls whether or not the terminal will forcibly scroll to the bottom of the viewable history when the new data is received from the child.

constructTerminalScrollOnOutput :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalScrollOnOutput :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

Get the value of the “`scroll-on-output`” property. When overloading is enabled, this is equivalent to

    get terminal #scrollOnOutput

setTerminalScrollOnOutput :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

Set the value of the “`scroll-on-output`” property. When overloading is enabled, this is equivalent to

    set terminal [ #scrollOnOutput := value ]

## scrollUnitIsPixels

Controls whether the terminal's GtkAdjustment values unit is lines or pixels. This can be enabled when the terminal is the child of a GtkScrolledWindow to fix some bugs with its kinetic scrolling.

Since: 0.66

constructTerminalScrollUnitIsPixels :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalScrollUnitIsPixels :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

Get the value of the “`scroll-unit-is-pixels`” property. When overloading is enabled, this is equivalent to

    get terminal #scrollUnitIsPixels

setTerminalScrollUnitIsPixels :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

Set the value of the “`scroll-unit-is-pixels`” property. When overloading is enabled, this is equivalent to

    set terminal [ #scrollUnitIsPixels := value ]

## scrollbackLines

The length of the scrollback buffer used by the terminal. The size of the scrollback buffer will be set to the larger of this value and the number of visible rows the widget can display, so 0 can safely be used to disable scrollback. Note that this setting only affects the normal screen buffer. For terminal types which have an alternate screen buffer, no scrollback is allowed on the alternate screen buffer.

Note that any value greater or equal to `G_MAXINT` is interpreted as unlimited scrollback, i.e. like `-1` when passed to `terminalSetScrollbackLines`, and the value of this property for unlimited scrollback is `G_MAXUINT`.

constructTerminalScrollbackLines :: (IsTerminal o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

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

getTerminalScrollbackLines :: (MonadIO m, IsTerminal o) => o -> m Word32 Source #

Get the value of the “`scrollback-lines`” property. When overloading is enabled, this is equivalent to

    get terminal #scrollbackLines

setTerminalScrollbackLines :: (MonadIO m, IsTerminal o) => o -> Word32 -> m () Source #

Set the value of the “`scrollback-lines`” property. When overloading is enabled, this is equivalent to

    set terminal [ #scrollbackLines := value ]

## textBlinkMode

Controls whether or not the terminal will allow blinking text.

Since: 0.52

constructTerminalTextBlinkMode :: (IsTerminal o, MonadIO m) => TextBlinkMode -> m (GValueConstruct o) Source #

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

getTerminalTextBlinkMode :: (MonadIO m, IsTerminal o) => o -> m TextBlinkMode Source #

Get the value of the “`text-blink-mode`” property. When overloading is enabled, this is equivalent to

    get terminal #textBlinkMode

setTerminalTextBlinkMode :: (MonadIO m, IsTerminal o) => o -> TextBlinkMode -> m () Source #

Set the value of the “`text-blink-mode`” property. When overloading is enabled, this is equivalent to

    set terminal [ #textBlinkMode := value ]

## windowTitle

The terminal's title.

getTerminalWindowTitle :: (MonadIO m, IsTerminal o) => o -> m (Maybe Text) Source #

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

    get terminal #windowTitle

## wordCharExceptions

The set of characters which will be considered parts of a word when doing word-wise selection, in addition to the default which only considers alphanumeric characters part of a word.

If `Nothing`, a built-in set is used.

Since: 0.40

getTerminalWordCharExceptions :: (MonadIO m, IsTerminal o) => o -> m (Maybe Text) Source #

Get the value of the “`word-char-exceptions`” property. When overloading is enabled, this is equivalent to

    get terminal #wordCharExceptions

## xalign

The horizontal alignment of `terminal` within its allocation.

Since: 0.76

constructTerminalXalign :: (IsTerminal o, MonadIO m) => Align -> m (GValueConstruct o) Source #

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

getTerminalXalign :: (MonadIO m, IsTerminal o) => o -> m Align Source #

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

    get terminal #xalign

setTerminalXalign :: (MonadIO m, IsTerminal o) => o -> Align -> m () Source #

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

    set terminal [ #xalign := value ]

## xfill

The horizontal fillment of `terminal` within its allocation.

Since: 0.76

constructTerminalXfill :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalXfill :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

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

    get terminal #xfill

setTerminalXfill :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

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

    set terminal [ #xfill := value ]

## yalign

The vertical alignment of `terminal` within its allocation

Since: 0.76

constructTerminalYalign :: (IsTerminal o, MonadIO m) => Align -> m (GValueConstruct o) Source #

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

getTerminalYalign :: (MonadIO m, IsTerminal o) => o -> m Align Source #

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

    get terminal #yalign

setTerminalYalign :: (MonadIO m, IsTerminal o) => o -> Align -> m () Source #

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

    set terminal [ #yalign := value ]

## yfill

The vertical fillment of `terminal` within its allocation. Note that Terminal:yfill=`True` is only supported with Terminal:yalign=`AlignStart`, and is ignored for all other yalign values.

Since: 0.76

constructTerminalYfill :: (IsTerminal o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getTerminalYfill :: (MonadIO m, IsTerminal o) => o -> m Bool Source #

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

    get terminal #yfill

setTerminalYfill :: (MonadIO m, IsTerminal o) => o -> Bool -> m () Source #

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

    set terminal [ #yfill := value ]

# Signals

## bell

type TerminalBellCallback = IO () Source #

This signal is emitted when the a child sends a bell request to the terminal.

afterTerminalBell :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalBellCallback) -> m SignalHandlerId Source #

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

    after terminal #bell 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.

onTerminalBell :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalBellCallback) -> m SignalHandlerId Source #

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

    on terminal #bell callback

## charSizeChanged

type TerminalCharSizeChangedCallback Source #

Arguments

= Word32 | `width`: the new character cell width
-> Word32 | `height`: the new character cell height
-> IO () |

Emitted whenever the cell size changes, e.g. due to a change in font, font-scale or cell-width/height-scale.

Note that this signal should rather be called "cell-size-changed".

afterTerminalCharSizeChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCharSizeChangedCallback) -> m SignalHandlerId Source #

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

    after terminal #charSizeChanged 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.

onTerminalCharSizeChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCharSizeChangedCallback) -> m SignalHandlerId Source #

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

    on terminal #charSizeChanged callback

## childExited

type TerminalChildExitedCallback Source #

Arguments

= Int32 | `status`: the child's exit status
-> IO () |

This signal is emitted when the terminal detects that a child watched using `terminalWatchChild` has exited.

afterTerminalChildExited :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalChildExitedCallback) -> m SignalHandlerId Source #

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

    after terminal #childExited 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.

onTerminalChildExited :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalChildExitedCallback) -> m SignalHandlerId Source #

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

    on terminal #childExited callback

## commit

type TerminalCommitCallback Source #

Arguments

= Text | `text`: a string of text
-> Word32 | `size`: the length of that string of text
-> IO () |

Emitted whenever the terminal receives input from the user and prepares to send it to the child process.

afterTerminalCommit :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCommitCallback) -> m SignalHandlerId Source #

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

    after terminal #commit 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.

onTerminalCommit :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCommitCallback) -> m SignalHandlerId Source #

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

    on terminal #commit callback

## contentsChanged

type TerminalContentsChangedCallback = IO () Source #

Emitted whenever the visible appearance of the terminal has changed. Used primarily by `VteTerminalAccessible`.

afterTerminalContentsChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalContentsChangedCallback) -> m SignalHandlerId Source #

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

    after terminal #contentsChanged 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.

onTerminalContentsChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalContentsChangedCallback) -> m SignalHandlerId Source #

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

    on terminal #contentsChanged callback

## copyClipboard

type TerminalCopyClipboardCallback = IO () Source #

Emitted whenever `terminalCopyClipboard` is called.

afterTerminalCopyClipboard :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCopyClipboardCallback) -> 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 terminal #copyClipboard 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.

onTerminalCopyClipboard :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCopyClipboardCallback) -> 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 terminal #copyClipboard callback

## currentDirectoryUriChanged

type TerminalCurrentDirectoryUriChangedCallback = IO () Source #

Deprecated: (Since version 0.78)Use the `Terminal`:`termprop-changed` signalfor the `TERMPROP_CURRENT_DIRECTORY_URI` termprop.

Emitted when the current directory URI is modified.

afterTerminalCurrentDirectoryUriChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCurrentDirectoryUriChangedCallback) -> m SignalHandlerId Source #

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

    after terminal #currentDirectoryUriChanged 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.

onTerminalCurrentDirectoryUriChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCurrentDirectoryUriChangedCallback) -> m SignalHandlerId Source #

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

    on terminal #currentDirectoryUriChanged callback

## currentFileUriChanged

type TerminalCurrentFileUriChangedCallback = IO () Source #

Deprecated: (Since version 0.78)Use the `Terminal`:`termprop-changed` signalfor the `TERMPROP_CURRENT_FILE_URI` termprop.

Emitted when the current file URI is modified.

afterTerminalCurrentFileUriChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCurrentFileUriChangedCallback) -> m SignalHandlerId Source #

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

    after terminal #currentFileUriChanged 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.

onTerminalCurrentFileUriChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCurrentFileUriChangedCallback) -> m SignalHandlerId Source #

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

    on terminal #currentFileUriChanged callback

## cursorMoved

type TerminalCursorMovedCallback = IO () Source #

Emitted whenever the cursor moves to a new character cell. Used primarily by `VteTerminalAccessible`.

afterTerminalCursorMoved :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCursorMovedCallback) -> m SignalHandlerId Source #

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

    after terminal #cursorMoved 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.

onTerminalCursorMoved :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalCursorMovedCallback) -> m SignalHandlerId Source #

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

    on terminal #cursorMoved callback

## decreaseFontSize

type TerminalDecreaseFontSizeCallback = IO () Source #

Emitted when the user hits the '-' key while holding the Control key.

afterTerminalDecreaseFontSize :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalDecreaseFontSizeCallback) -> m SignalHandlerId Source #

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

    after terminal #decreaseFontSize 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.

onTerminalDecreaseFontSize :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalDecreaseFontSizeCallback) -> m SignalHandlerId Source #

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

    on terminal #decreaseFontSize callback

## deiconifyWindow

type TerminalDeiconifyWindowCallback = IO () Source #

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalDeiconifyWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalDeiconifyWindowCallback) -> m SignalHandlerId Source #

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

    after terminal #deiconifyWindow 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.

onTerminalDeiconifyWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalDeiconifyWindowCallback) -> m SignalHandlerId Source #

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

    on terminal #deiconifyWindow callback

## encodingChanged

type TerminalEncodingChangedCallback = IO () Source #

Emitted whenever the terminal's current encoding has changed.

Note: support for non-UTF-8 is deprecated.

afterTerminalEncodingChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalEncodingChangedCallback) -> m SignalHandlerId Source #

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

    after terminal #encodingChanged 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.

onTerminalEncodingChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalEncodingChangedCallback) -> m SignalHandlerId Source #

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

    on terminal #encodingChanged callback

## eof

type TerminalEofCallback = IO () Source #

Emitted when the terminal receives an end-of-file from a child which is running in the terminal. This signal is frequently (but not always) emitted with a Terminal::childExited signal.

afterTerminalEof :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalEofCallback) -> m SignalHandlerId Source #

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

    after terminal #eof 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.

onTerminalEof :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalEofCallback) -> m SignalHandlerId Source #

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

    on terminal #eof callback

## hyperlinkHoverUriChanged

type TerminalHyperlinkHoverUriChangedCallback = Text -> Rectangle -> IO () Source #

Emitted when the hovered hyperlink changes.

`uri` and `bbox` are owned by VTE, must not be modified, and might change after the signal handlers returns.

The signal is not re-emitted when the bounding box changes for the same hyperlink. This might change in a future VTE version without notice.

Since: 0.50

afterTerminalHyperlinkHoverUriChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalHyperlinkHoverUriChangedCallback) -> m SignalHandlerId Source #

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

    after terminal #hyperlinkHoverUriChanged 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.

onTerminalHyperlinkHoverUriChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalHyperlinkHoverUriChangedCallback) -> m SignalHandlerId Source #

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

    on terminal #hyperlinkHoverUriChanged callback

## iconTitleChanged

type TerminalIconTitleChangedCallback = IO () Source #

Deprecated: (Since version 0.54)This signal is never emitted.

No description available in the introspection data.

afterTerminalIconTitleChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalIconTitleChangedCallback) -> m SignalHandlerId Source #

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

    after terminal #iconTitleChanged 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.

onTerminalIconTitleChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalIconTitleChangedCallback) -> m SignalHandlerId Source #

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

    on terminal #iconTitleChanged callback

## iconifyWindow

type TerminalIconifyWindowCallback = IO () Source #

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalIconifyWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalIconifyWindowCallback) -> m SignalHandlerId Source #

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

    after terminal #iconifyWindow 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.

onTerminalIconifyWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalIconifyWindowCallback) -> m SignalHandlerId Source #

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

    on terminal #iconifyWindow callback

## increaseFontSize

type TerminalIncreaseFontSizeCallback = IO () Source #

Emitted when the user hits the '+' key while holding the Control key.

afterTerminalIncreaseFontSize :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalIncreaseFontSizeCallback) -> m SignalHandlerId Source #

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

    after terminal #increaseFontSize 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.

onTerminalIncreaseFontSize :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalIncreaseFontSizeCallback) -> m SignalHandlerId Source #

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

    on terminal #increaseFontSize callback

## lowerWindow

type TerminalLowerWindowCallback = IO () Source #

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalLowerWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalLowerWindowCallback) -> m SignalHandlerId Source #

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

    after terminal #lowerWindow 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.

onTerminalLowerWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalLowerWindowCallback) -> m SignalHandlerId Source #

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

    on terminal #lowerWindow callback

## maximizeWindow

type TerminalMaximizeWindowCallback = IO () Source #

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalMaximizeWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalMaximizeWindowCallback) -> m SignalHandlerId Source #

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

    after terminal #maximizeWindow 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.

onTerminalMaximizeWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalMaximizeWindowCallback) -> m SignalHandlerId Source #

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

    on terminal #maximizeWindow callback

## moveWindow

type TerminalMoveWindowCallback Source #

Arguments

= Word32 | `x`: the terminal's desired location, X coordinate
-> Word32 | `y`: the terminal's desired location, Y coordinate
-> IO () |

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalMoveWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalMoveWindowCallback) -> m SignalHandlerId Source #

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

    after terminal #moveWindow 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.

onTerminalMoveWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalMoveWindowCallback) -> m SignalHandlerId Source #

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

    on terminal #moveWindow callback

## pasteClipboard

type TerminalPasteClipboardCallback = IO () Source #

Emitted whenever `terminalPasteClipboard` is called.

afterTerminalPasteClipboard :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalPasteClipboardCallback) -> 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 terminal #pasteClipboard 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.

onTerminalPasteClipboard :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalPasteClipboardCallback) -> 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 terminal #pasteClipboard callback

## raiseWindow

type TerminalRaiseWindowCallback = IO () Source #

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalRaiseWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalRaiseWindowCallback) -> m SignalHandlerId Source #

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

    after terminal #raiseWindow 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.

onTerminalRaiseWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalRaiseWindowCallback) -> m SignalHandlerId Source #

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

    on terminal #raiseWindow callback

## refreshWindow

type TerminalRefreshWindowCallback = IO () Source #

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalRefreshWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalRefreshWindowCallback) -> m SignalHandlerId Source #

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

    after terminal #refreshWindow 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.

onTerminalRefreshWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalRefreshWindowCallback) -> m SignalHandlerId Source #

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

    on terminal #refreshWindow callback

## resizeWindow

type TerminalResizeWindowCallback Source #

Arguments

= Word32 | `width`: the desired number of columns
-> Word32 | `height`: the desired number of rows
-> IO () |

Emitted at the child application's request.

afterTerminalResizeWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalResizeWindowCallback) -> m SignalHandlerId Source #

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

    after terminal #resizeWindow 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.

onTerminalResizeWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalResizeWindowCallback) -> m SignalHandlerId Source #

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

    on terminal #resizeWindow callback

## restoreWindow

type TerminalRestoreWindowCallback = IO () Source #

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalRestoreWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalRestoreWindowCallback) -> m SignalHandlerId Source #

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

    after terminal #restoreWindow 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.

onTerminalRestoreWindow :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalRestoreWindowCallback) -> m SignalHandlerId Source #

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

    on terminal #restoreWindow callback

## selectionChanged

type TerminalSelectionChangedCallback = IO () Source #

Emitted whenever the contents of terminal's selection changes.

afterTerminalSelectionChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalSelectionChangedCallback) -> m SignalHandlerId Source #

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

    after terminal #selectionChanged 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.

onTerminalSelectionChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalSelectionChangedCallback) -> m SignalHandlerId Source #

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

    on terminal #selectionChanged callback

## setupContextMenu

type TerminalSetupContextMenuCallback Source #

Arguments

= Maybe EventContext | `context`: the context
-> IO () |

Emitted with non-`Nothing` context before `terminal` shows a context menu. The handler may set either a menu model using `terminalSetContextMenuModel`, or a menu using `terminalSetContextMenu`, which will then be used as context menu, or keep a previously set context menu or context menu model, but update the menu and/or its `Action`:`s` visibility and sensitivity. If neither a menu model nor a menu are set, a context menu will not be shown.

Note that `context` is only valid during the signal emission; you may not retain it to call methods on it afterwards.

Also emitted with `Nothing` context after the context menu has been dismissed.

afterTerminalSetupContextMenu :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalSetupContextMenuCallback) -> m SignalHandlerId Source #

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

    after terminal #setupContextMenu 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.

onTerminalSetupContextMenu :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalSetupContextMenuCallback) -> m SignalHandlerId Source #

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

    on terminal #setupContextMenu callback

## termpropChanged

type TerminalTermpropChangedCallback Source #

Arguments

= Text | `name`: the name of the changed property
-> IO () |

The "termprop-changed" signal is emitted when a termprop has changed or been reset.

The handler may use the vte_terminal_get_termprop_*() functions (and their by-ID variants), to retrieve the value of any termprop (not just `name`); but it must *not* call *any* other API on `terminal`, including API of its parent classes.

This signal supports detailed connections, so e.g. subscribing to "termprop-changedname" only runs the callback when the termprop "name" has changed.

Since: 0.78

afterTerminalTermpropChanged :: (IsTerminal a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => TerminalTermpropChangedCallback) -> m SignalHandlerId Source #

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

    after terminal #termpropChanged callback

This signal admits a optional parameter `detail`. If it's not `Nothing`, we will connect to “`termprop-changed::detail`” instead.

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.

onTerminalTermpropChanged :: (IsTerminal a, MonadIO m) => a -> Maybe Text -> ((?self :: a) => TerminalTermpropChangedCallback) -> m SignalHandlerId Source #

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

    on terminal #termpropChanged callback

This signal admits a optional parameter `detail`. If it's not `Nothing`, we will connect to “`termprop-changed::detail`” instead.

## termpropsChanged

type TerminalTermpropsChangedCallback Source #

Arguments

= [Int32] | `props`: an array of termprop IDs
-> IO Bool | Returns: `True` to stop further handlers being invoked for this signal, or `False` to continue signal emission

Emitted when termprops have changed. `props` is an array containing the IDs of the terminal properties that may have changed since the last emission of this signal, in an undefined order. Note that emission of this signal is delayed from the receipt of the OSC sequences, and a termprop may have been changed more than once inbetween signal emissions, but only the value set last is retrievable.

The default handler for this signal emits the "termprop-changed" signal for each changed property. Returning `True` from a handler running before the default will prevent this.

The handler may use the vte_terminal_get_termprop_*() functions (and their by-ID variants), to retrieve the value of any termprop, as well as call `terminalResetTermprop` (and its by-ID variant) to reset any termprop, or emit the VteTerminaltermpropChanged signal; but it must *not* call *any* other API on `terminal`, including API of its parent classes.

Since: 0.78

afterTerminalTermpropsChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTermpropsChangedCallback) -> m SignalHandlerId Source #

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

    after terminal #termpropsChanged 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.

onTerminalTermpropsChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTermpropsChangedCallback) -> m SignalHandlerId Source #

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

    on terminal #termpropsChanged callback

## textDeleted

type TerminalTextDeletedCallback = IO () Source #

Deprecated: (Since version 0.66)This signal is never emitted.

No description available in the introspection data.

afterTerminalTextDeleted :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextDeletedCallback) -> m SignalHandlerId Source #

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

    after terminal #textDeleted 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.

onTerminalTextDeleted :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextDeletedCallback) -> m SignalHandlerId Source #

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

    on terminal #textDeleted callback

## textInserted

type TerminalTextInsertedCallback = IO () Source #

Deprecated: (Since version 0.66)This signal is never emitted.

No description available in the introspection data.

afterTerminalTextInserted :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextInsertedCallback) -> m SignalHandlerId Source #

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

    after terminal #textInserted 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.

onTerminalTextInserted :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextInsertedCallback) -> m SignalHandlerId Source #

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

    on terminal #textInserted callback

## textModified

type TerminalTextModifiedCallback = IO () Source #

Deprecated: (Since version 0.66)This signal is never emitted.

No description available in the introspection data.

afterTerminalTextModified :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextModifiedCallback) -> m SignalHandlerId Source #

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

    after terminal #textModified 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.

onTerminalTextModified :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextModifiedCallback) -> m SignalHandlerId Source #

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

    on terminal #textModified callback

## textScrolled

type TerminalTextScrolledCallback = Int32 -> IO () Source #

Deprecated: (Since version 0.66)This signal is never emitted.

No description available in the introspection data.

afterTerminalTextScrolled :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextScrolledCallback) -> m SignalHandlerId Source #

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

    after terminal #textScrolled 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.

onTerminalTextScrolled :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalTextScrolledCallback) -> m SignalHandlerId Source #

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

    on terminal #textScrolled callback

## windowTitleChanged

type TerminalWindowTitleChangedCallback = IO () Source #

Deprecated: (Since version 0.78)Use the `Terminal`:`termprop-changed` signalfor the `TERMPROP_XTERM_TITLE` termprop.

Emitted when the Terminal:windowTitle property is modified.

afterTerminalWindowTitleChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalWindowTitleChangedCallback) -> m SignalHandlerId Source #

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

    after terminal #windowTitleChanged 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.

onTerminalWindowTitleChanged :: (IsTerminal a, MonadIO m) => a -> ((?self :: a) => TerminalWindowTitleChangedCallback) -> m SignalHandlerId Source #

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

    on terminal #windowTitleChanged callback