gi-vte-2.91.27: Vte bindings

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

GI.Vte.Objects.Terminal

Contents

- Exported types
- Methods
  - Overloaded methods
  - copyClipboard
  - copyClipboardFormat
  - copyPrimary
  - feed
  - feedChild
  - feedChildBinary
  - getAllowBold
  - getAllowHyperlink
  - getAudibleBell
  - getBoldIsBright
  - getCellHeightScale
  - getCellWidthScale
  - getCharHeight
  - getCharWidth
  - getCjkAmbiguousWidth
  - getColorBackgroundForDraw
  - getColumnCount
  - getCurrentDirectoryUri
  - getCurrentFileUri
  - getCursorBlinkMode
  - getCursorPosition
  - getCursorShape
  - getEnableBidi
  - getEnableShaping
  - getEnableSixel
  - getEncoding
  - getFont
  - getFontScale
  - getGeometryHints
  - getHasSelection
  - getIconTitle
  - getInputEnabled
  - getMouseAutohide
  - getPty
  - getRewrapOnResize
  - getRowCount
  - getScrollOnKeystroke
  - getScrollOnOutput
  - getScrollbackLines
  - getText
  - getTextBlinkMode
  - getTextIncludeTrailingSpaces
  - getTextRange
  - getWindowTitle
  - getWordCharExceptions
  - hyperlinkCheckEvent
  - matchAddGregex
  - matchAddRegex
  - matchCheck
  - matchCheckEvent
  - matchRemove
  - matchRemoveAll
  - matchSetCursor
  - matchSetCursorName
  - matchSetCursorType
  - new
  - pasteClipboard
  - pastePrimary
  - ptyNewSync
  - reset
  - 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
  - setCursorBlinkMode
  - setCursorShape
  - setDefaultColors
  - setDeleteBinding
  - setEnableBidi
  - setEnableShaping
  - setEnableSixel
  - setEncoding
  - setFont
  - setFontScale
  - setGeometryHintsForWindow
  - setInputEnabled
  - setMouseAutohide
  - setPty
  - setRewrapOnResize
  - setScrollOnKeystroke
  - setScrollOnOutput
  - setScrollbackLines
  - setSize
  - setTextBlinkMode
  - setWordCharExceptions
  - spawnAsync
  - spawnSync
  - unselectAll
  - watchChild
  - writeContentsSync
- Properties
  - allowBold
  - allowHyperlink
  - audibleBell
  - backspaceBinding
  - boldIsBright
  - cellHeightScale
  - cellWidthScale
  - cjkAmbiguousWidth
  - currentDirectoryUri
  - currentFileUri
  - cursorBlinkMode
  - cursorShape
  - deleteBinding
  - enableBidi
  - enableShaping
  - enableSixel
  - encoding
  - fontDesc
  - fontScale
  - hyperlinkHoverUri
  - iconTitle
  - inputEnabled
  - pointerAutohide
  - pty
  - rewrapOnResize
  - scrollOnKeystroke
  - scrollOnOutput
  - scrollbackLines
  - textBlinkMode
  - windowTitle
  - wordCharExceptions
- 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
  - 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 ()
- 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
- 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
- terminalGetEnableBidi :: (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
- 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 Pty
- terminalGetRewrapOnResize :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetRowCount :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m CLong
- terminalGetScrollOnKeystroke :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetScrollOnOutput :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m Bool
- terminalGetScrollbackLines :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m CLong
- terminalGetText :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe SelectionFunc -> m (Text, [CharAttributes])
- terminalGetTextBlinkMode :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m TextBlinkMode
- terminalGetTextIncludeTrailingSpaces :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Maybe SelectionFunc -> m (Text, [CharAttributes])
- terminalGetTextRange :: (HasCallStack, MonadIO m, IsTerminal a) => a -> CLong -> CLong -> CLong -> CLong -> Maybe SelectionFunc -> m (Text, [CharAttributes])
- terminalGetWindowTitle :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m (Maybe Text)
- terminalGetWordCharExceptions :: (HasCallStack, MonadIO m, IsTerminal a) => a -> m (Maybe Text)
- 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 ()
- terminalPtyNewSync :: (HasCallStack, MonadIO m, IsTerminal a, IsCancellable b) => a -> [PtyFlags] -> Maybe b -> m Pty
- terminalReset :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> Bool -> 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 ()
- 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 ()
- terminalSetEnableBidi :: (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 ()
- 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 ()
- terminalSetScrollOnKeystroke :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Bool -> m ()
- terminalSetScrollOnOutput :: (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 ()
- terminalSetTextBlinkMode :: (HasCallStack, MonadIO m, IsTerminal a) => a -> TextBlinkMode -> m ()
- terminalSetWordCharExceptions :: (HasCallStack, MonadIO m, IsTerminal a) => a -> Text -> 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
- 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 ()
- 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 ()
- 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 ()
- 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 ()
- 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 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 ()
- 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 ()
- 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)
- type C_TerminalBellCallback = Ptr () -> Ptr () -> IO ()
- type TerminalBellCallback = IO ()
- afterTerminalBell :: (IsTerminal a, MonadIO m) => a -> TerminalBellCallback -> m SignalHandlerId
- genClosure_TerminalBell :: MonadIO m => TerminalBellCallback -> m (GClosure C_TerminalBellCallback)
- mk_TerminalBellCallback :: C_TerminalBellCallback -> IO (FunPtr C_TerminalBellCallback)
- noTerminalBellCallback :: Maybe TerminalBellCallback
- onTerminalBell :: (IsTerminal a, MonadIO m) => a -> TerminalBellCallback -> m SignalHandlerId
- wrap_TerminalBellCallback :: TerminalBellCallback -> C_TerminalBellCallback
- type C_TerminalCharSizeChangedCallback = Ptr () -> Word32 -> Word32 -> Ptr () -> IO ()
- type TerminalCharSizeChangedCallback = Word32 -> Word32 -> IO ()
- afterTerminalCharSizeChanged :: (IsTerminal a, MonadIO m) => a -> TerminalCharSizeChangedCallback -> m SignalHandlerId
- genClosure_TerminalCharSizeChanged :: MonadIO m => TerminalCharSizeChangedCallback -> m (GClosure C_TerminalCharSizeChangedCallback)
- mk_TerminalCharSizeChangedCallback :: C_TerminalCharSizeChangedCallback -> IO (FunPtr C_TerminalCharSizeChangedCallback)
- noTerminalCharSizeChangedCallback :: Maybe TerminalCharSizeChangedCallback
- onTerminalCharSizeChanged :: (IsTerminal a, MonadIO m) => a -> TerminalCharSizeChangedCallback -> m SignalHandlerId
- wrap_TerminalCharSizeChangedCallback :: TerminalCharSizeChangedCallback -> C_TerminalCharSizeChangedCallback
- type C_TerminalChildExitedCallback = Ptr () -> Int32 -> Ptr () -> IO ()
- type TerminalChildExitedCallback = Int32 -> IO ()
- afterTerminalChildExited :: (IsTerminal a, MonadIO m) => a -> TerminalChildExitedCallback -> m SignalHandlerId
- genClosure_TerminalChildExited :: MonadIO m => TerminalChildExitedCallback -> m (GClosure C_TerminalChildExitedCallback)
- mk_TerminalChildExitedCallback :: C_TerminalChildExitedCallback -> IO (FunPtr C_TerminalChildExitedCallback)
- noTerminalChildExitedCallback :: Maybe TerminalChildExitedCallback
- onTerminalChildExited :: (IsTerminal a, MonadIO m) => a -> TerminalChildExitedCallback -> m SignalHandlerId
- wrap_TerminalChildExitedCallback :: TerminalChildExitedCallback -> C_TerminalChildExitedCallback
- type C_TerminalCommitCallback = Ptr () -> CString -> Word32 -> Ptr () -> IO ()
- type TerminalCommitCallback = Text -> Word32 -> IO ()
- afterTerminalCommit :: (IsTerminal a, MonadIO m) => a -> TerminalCommitCallback -> m SignalHandlerId
- genClosure_TerminalCommit :: MonadIO m => TerminalCommitCallback -> m (GClosure C_TerminalCommitCallback)
- mk_TerminalCommitCallback :: C_TerminalCommitCallback -> IO (FunPtr C_TerminalCommitCallback)
- noTerminalCommitCallback :: Maybe TerminalCommitCallback
- onTerminalCommit :: (IsTerminal a, MonadIO m) => a -> TerminalCommitCallback -> m SignalHandlerId
- wrap_TerminalCommitCallback :: TerminalCommitCallback -> C_TerminalCommitCallback
- type C_TerminalContentsChangedCallback = Ptr () -> Ptr () -> IO ()
- type TerminalContentsChangedCallback = IO ()
- afterTerminalContentsChanged :: (IsTerminal a, MonadIO m) => a -> TerminalContentsChangedCallback -> m SignalHandlerId
- genClosure_TerminalContentsChanged :: MonadIO m => TerminalContentsChangedCallback -> m (GClosure C_TerminalContentsChangedCallback)
- mk_TerminalContentsChangedCallback :: C_TerminalContentsChangedCallback -> IO (FunPtr C_TerminalContentsChangedCallback)
- noTerminalContentsChangedCallback :: Maybe TerminalContentsChangedCallback
- onTerminalContentsChanged :: (IsTerminal a, MonadIO m) => a -> TerminalContentsChangedCallback -> m SignalHandlerId
- wrap_TerminalContentsChangedCallback :: TerminalContentsChangedCallback -> C_TerminalContentsChangedCallback
- type C_TerminalCopyClipboardCallback = Ptr () -> Ptr () -> IO ()
- type TerminalCopyClipboardCallback = IO ()
- afterTerminalCopyClipboard :: (IsTerminal a, MonadIO m) => a -> TerminalCopyClipboardCallback -> m SignalHandlerId
- genClosure_TerminalCopyClipboard :: MonadIO m => TerminalCopyClipboardCallback -> m (GClosure C_TerminalCopyClipboardCallback)
- mk_TerminalCopyClipboardCallback :: C_TerminalCopyClipboardCallback -> IO (FunPtr C_TerminalCopyClipboardCallback)
- noTerminalCopyClipboardCallback :: Maybe TerminalCopyClipboardCallback
- onTerminalCopyClipboard :: (IsTerminal a, MonadIO m) => a -> TerminalCopyClipboardCallback -> m SignalHandlerId
- wrap_TerminalCopyClipboardCallback :: TerminalCopyClipboardCallback -> C_TerminalCopyClipboardCallback
- type C_TerminalCurrentDirectoryUriChangedCallback = Ptr () -> Ptr () -> IO ()
- type TerminalCurrentDirectoryUriChangedCallback = IO ()
- afterTerminalCurrentDirectoryUriChanged :: (IsTerminal a, MonadIO m) => a -> TerminalCurrentDirectoryUriChangedCallback -> m SignalHandlerId
- genClosure_TerminalCurrentDirectoryUriChanged :: MonadIO m => TerminalCurrentDirectoryUriChangedCallback -> m (GClosure C_TerminalCurrentDirectoryUriChangedCallback)
- mk_TerminalCurrentDirectoryUriChangedCallback :: C_TerminalCurrentDirectoryUriChangedCallback -> IO (FunPtr C_TerminalCurrentDirectoryUriChangedCallback)
- noTerminalCurrentDirectoryUriChangedCallback :: Maybe TerminalCurrentDirectoryUriChangedCallback
- onTerminalCurrentDirectoryUriChanged :: (IsTerminal a, MonadIO m) => a -> TerminalCurrentDirectoryUriChangedCallback -> m SignalHandlerId
- wrap_TerminalCurrentDirectoryUriChangedCallback :: TerminalCurrentDirectoryUriChangedCallback -> C_TerminalCurrentDirectoryUriChangedCallback
- type C_TerminalCurrentFileUriChangedCallback = Ptr () -> Ptr () -> IO ()
- type TerminalCurrentFileUriChangedCallback = IO ()
- afterTerminalCurrentFileUriChanged :: (IsTerminal a, MonadIO m) => a -> TerminalCurrentFileUriChangedCallback -> m SignalHandlerId
- genClosure_TerminalCurrentFileUriChanged :: MonadIO m => TerminalCurrentFileUriChangedCallback -> m (GClosure C_TerminalCurrentFileUriChangedCallback)
- mk_TerminalCurrentFileUriChangedCallback :: C_TerminalCurrentFileUriChangedCallback -> IO (FunPtr C_TerminalCurrentFileUriChangedCallback)
- noTerminalCurrentFileUriChangedCallback :: Maybe TerminalCurrentFileUriChangedCallback
- onTerminalCurrentFileUriChanged :: (IsTerminal a, MonadIO m) => a -> TerminalCurrentFileUriChangedCallback -> m SignalHandlerId
- wrap_TerminalCurrentFileUriChangedCallback :: TerminalCurrentFileUriChangedCallback -> C_TerminalCurrentFileUriChangedCallback
- type C_TerminalCursorMovedCallback = Ptr () -> Ptr () -> IO ()
- type TerminalCursorMovedCallback = IO ()
- afterTerminalCursorMoved :: (IsTerminal a, MonadIO m) => a -> TerminalCursorMovedCallback -> m SignalHandlerId
- genClosure_TerminalCursorMoved :: MonadIO m => TerminalCursorMovedCallback -> m (GClosure C_TerminalCursorMovedCallback)
- mk_TerminalCursorMovedCallback :: C_TerminalCursorMovedCallback -> IO (FunPtr C_TerminalCursorMovedCallback)
- noTerminalCursorMovedCallback :: Maybe TerminalCursorMovedCallback
- onTerminalCursorMoved :: (IsTerminal a, MonadIO m) => a -> TerminalCursorMovedCallback -> m SignalHandlerId
- wrap_TerminalCursorMovedCallback :: TerminalCursorMovedCallback -> C_TerminalCursorMovedCallback
- type C_TerminalDecreaseFontSizeCallback = Ptr () -> Ptr () -> IO ()
- type TerminalDecreaseFontSizeCallback = IO ()
- afterTerminalDecreaseFontSize :: (IsTerminal a, MonadIO m) => a -> TerminalDecreaseFontSizeCallback -> m SignalHandlerId
- genClosure_TerminalDecreaseFontSize :: MonadIO m => TerminalDecreaseFontSizeCallback -> m (GClosure C_TerminalDecreaseFontSizeCallback)
- mk_TerminalDecreaseFontSizeCallback :: C_TerminalDecreaseFontSizeCallback -> IO (FunPtr C_TerminalDecreaseFontSizeCallback)
- noTerminalDecreaseFontSizeCallback :: Maybe TerminalDecreaseFontSizeCallback
- onTerminalDecreaseFontSize :: (IsTerminal a, MonadIO m) => a -> TerminalDecreaseFontSizeCallback -> m SignalHandlerId
- wrap_TerminalDecreaseFontSizeCallback :: TerminalDecreaseFontSizeCallback -> C_TerminalDecreaseFontSizeCallback
- type C_TerminalDeiconifyWindowCallback = Ptr () -> Ptr () -> IO ()
- type TerminalDeiconifyWindowCallback = IO ()
- afterTerminalDeiconifyWindow :: (IsTerminal a, MonadIO m) => a -> TerminalDeiconifyWindowCallback -> m SignalHandlerId
- genClosure_TerminalDeiconifyWindow :: MonadIO m => TerminalDeiconifyWindowCallback -> m (GClosure C_TerminalDeiconifyWindowCallback)
- mk_TerminalDeiconifyWindowCallback :: C_TerminalDeiconifyWindowCallback -> IO (FunPtr C_TerminalDeiconifyWindowCallback)
- noTerminalDeiconifyWindowCallback :: Maybe TerminalDeiconifyWindowCallback
- onTerminalDeiconifyWindow :: (IsTerminal a, MonadIO m) => a -> TerminalDeiconifyWindowCallback -> m SignalHandlerId
- wrap_TerminalDeiconifyWindowCallback :: TerminalDeiconifyWindowCallback -> C_TerminalDeiconifyWindowCallback
- type C_TerminalEncodingChangedCallback = Ptr () -> Ptr () -> IO ()
- type TerminalEncodingChangedCallback = IO ()
- afterTerminalEncodingChanged :: (IsTerminal a, MonadIO m) => a -> TerminalEncodingChangedCallback -> m SignalHandlerId
- genClosure_TerminalEncodingChanged :: MonadIO m => TerminalEncodingChangedCallback -> m (GClosure C_TerminalEncodingChangedCallback)
- mk_TerminalEncodingChangedCallback :: C_TerminalEncodingChangedCallback -> IO (FunPtr C_TerminalEncodingChangedCallback)
- noTerminalEncodingChangedCallback :: Maybe TerminalEncodingChangedCallback
- onTerminalEncodingChanged :: (IsTerminal a, MonadIO m) => a -> TerminalEncodingChangedCallback -> m SignalHandlerId
- wrap_TerminalEncodingChangedCallback :: TerminalEncodingChangedCallback -> C_TerminalEncodingChangedCallback
- type C_TerminalEofCallback = Ptr () -> Ptr () -> IO ()
- type TerminalEofCallback = IO ()
- afterTerminalEof :: (IsTerminal a, MonadIO m) => a -> TerminalEofCallback -> m SignalHandlerId
- genClosure_TerminalEof :: MonadIO m => TerminalEofCallback -> m (GClosure C_TerminalEofCallback)
- mk_TerminalEofCallback :: C_TerminalEofCallback -> IO (FunPtr C_TerminalEofCallback)
- noTerminalEofCallback :: Maybe TerminalEofCallback
- onTerminalEof :: (IsTerminal a, MonadIO m) => a -> TerminalEofCallback -> m SignalHandlerId
- wrap_TerminalEofCallback :: TerminalEofCallback -> C_TerminalEofCallback
- type C_TerminalHyperlinkHoverUriChangedCallback = Ptr () -> CString -> Ptr Rectangle -> Ptr () -> IO ()
- type TerminalHyperlinkHoverUriChangedCallback = Text -> Rectangle -> IO ()
- afterTerminalHyperlinkHoverUriChanged :: (IsTerminal a, MonadIO m) => a -> TerminalHyperlinkHoverUriChangedCallback -> m SignalHandlerId
- genClosure_TerminalHyperlinkHoverUriChanged :: MonadIO m => TerminalHyperlinkHoverUriChangedCallback -> m (GClosure C_TerminalHyperlinkHoverUriChangedCallback)
- mk_TerminalHyperlinkHoverUriChangedCallback :: C_TerminalHyperlinkHoverUriChangedCallback -> IO (FunPtr C_TerminalHyperlinkHoverUriChangedCallback)
- noTerminalHyperlinkHoverUriChangedCallback :: Maybe TerminalHyperlinkHoverUriChangedCallback
- onTerminalHyperlinkHoverUriChanged :: (IsTerminal a, MonadIO m) => a -> TerminalHyperlinkHoverUriChangedCallback -> m SignalHandlerId
- wrap_TerminalHyperlinkHoverUriChangedCallback :: TerminalHyperlinkHoverUriChangedCallback -> C_TerminalHyperlinkHoverUriChangedCallback
- type C_TerminalIconTitleChangedCallback = Ptr () -> Ptr () -> IO ()
- type TerminalIconTitleChangedCallback = IO ()
- afterTerminalIconTitleChanged :: (IsTerminal a, MonadIO m) => a -> TerminalIconTitleChangedCallback -> m SignalHandlerId
- genClosure_TerminalIconTitleChanged :: MonadIO m => TerminalIconTitleChangedCallback -> m (GClosure C_TerminalIconTitleChangedCallback)
- mk_TerminalIconTitleChangedCallback :: C_TerminalIconTitleChangedCallback -> IO (FunPtr C_TerminalIconTitleChangedCallback)
- noTerminalIconTitleChangedCallback :: Maybe TerminalIconTitleChangedCallback
- onTerminalIconTitleChanged :: (IsTerminal a, MonadIO m) => a -> TerminalIconTitleChangedCallback -> m SignalHandlerId
- wrap_TerminalIconTitleChangedCallback :: TerminalIconTitleChangedCallback -> C_TerminalIconTitleChangedCallback
- type C_TerminalIconifyWindowCallback = Ptr () -> Ptr () -> IO ()
- type TerminalIconifyWindowCallback = IO ()
- afterTerminalIconifyWindow :: (IsTerminal a, MonadIO m) => a -> TerminalIconifyWindowCallback -> m SignalHandlerId
- genClosure_TerminalIconifyWindow :: MonadIO m => TerminalIconifyWindowCallback -> m (GClosure C_TerminalIconifyWindowCallback)
- mk_TerminalIconifyWindowCallback :: C_TerminalIconifyWindowCallback -> IO (FunPtr C_TerminalIconifyWindowCallback)
- noTerminalIconifyWindowCallback :: Maybe TerminalIconifyWindowCallback
- onTerminalIconifyWindow :: (IsTerminal a, MonadIO m) => a -> TerminalIconifyWindowCallback -> m SignalHandlerId
- wrap_TerminalIconifyWindowCallback :: TerminalIconifyWindowCallback -> C_TerminalIconifyWindowCallback
- type C_TerminalIncreaseFontSizeCallback = Ptr () -> Ptr () -> IO ()
- type TerminalIncreaseFontSizeCallback = IO ()
- afterTerminalIncreaseFontSize :: (IsTerminal a, MonadIO m) => a -> TerminalIncreaseFontSizeCallback -> m SignalHandlerId
- genClosure_TerminalIncreaseFontSize :: MonadIO m => TerminalIncreaseFontSizeCallback -> m (GClosure C_TerminalIncreaseFontSizeCallback)
- mk_TerminalIncreaseFontSizeCallback :: C_TerminalIncreaseFontSizeCallback -> IO (FunPtr C_TerminalIncreaseFontSizeCallback)
- noTerminalIncreaseFontSizeCallback :: Maybe TerminalIncreaseFontSizeCallback
- onTerminalIncreaseFontSize :: (IsTerminal a, MonadIO m) => a -> TerminalIncreaseFontSizeCallback -> m SignalHandlerId
- wrap_TerminalIncreaseFontSizeCallback :: TerminalIncreaseFontSizeCallback -> C_TerminalIncreaseFontSizeCallback
- type C_TerminalLowerWindowCallback = Ptr () -> Ptr () -> IO ()
- type TerminalLowerWindowCallback = IO ()
- afterTerminalLowerWindow :: (IsTerminal a, MonadIO m) => a -> TerminalLowerWindowCallback -> m SignalHandlerId
- genClosure_TerminalLowerWindow :: MonadIO m => TerminalLowerWindowCallback -> m (GClosure C_TerminalLowerWindowCallback)
- mk_TerminalLowerWindowCallback :: C_TerminalLowerWindowCallback -> IO (FunPtr C_TerminalLowerWindowCallback)
- noTerminalLowerWindowCallback :: Maybe TerminalLowerWindowCallback
- onTerminalLowerWindow :: (IsTerminal a, MonadIO m) => a -> TerminalLowerWindowCallback -> m SignalHandlerId
- wrap_TerminalLowerWindowCallback :: TerminalLowerWindowCallback -> C_TerminalLowerWindowCallback
- type C_TerminalMaximizeWindowCallback = Ptr () -> Ptr () -> IO ()
- type TerminalMaximizeWindowCallback = IO ()
- afterTerminalMaximizeWindow :: (IsTerminal a, MonadIO m) => a -> TerminalMaximizeWindowCallback -> m SignalHandlerId
- genClosure_TerminalMaximizeWindow :: MonadIO m => TerminalMaximizeWindowCallback -> m (GClosure C_TerminalMaximizeWindowCallback)
- mk_TerminalMaximizeWindowCallback :: C_TerminalMaximizeWindowCallback -> IO (FunPtr C_TerminalMaximizeWindowCallback)
- noTerminalMaximizeWindowCallback :: Maybe TerminalMaximizeWindowCallback
- onTerminalMaximizeWindow :: (IsTerminal a, MonadIO m) => a -> TerminalMaximizeWindowCallback -> m SignalHandlerId
- wrap_TerminalMaximizeWindowCallback :: TerminalMaximizeWindowCallback -> C_TerminalMaximizeWindowCallback
- type C_TerminalMoveWindowCallback = Ptr () -> Word32 -> Word32 -> Ptr () -> IO ()
- type TerminalMoveWindowCallback = Word32 -> Word32 -> IO ()
- afterTerminalMoveWindow :: (IsTerminal a, MonadIO m) => a -> TerminalMoveWindowCallback -> m SignalHandlerId
- genClosure_TerminalMoveWindow :: MonadIO m => TerminalMoveWindowCallback -> m (GClosure C_TerminalMoveWindowCallback)
- mk_TerminalMoveWindowCallback :: C_TerminalMoveWindowCallback -> IO (FunPtr C_TerminalMoveWindowCallback)
- noTerminalMoveWindowCallback :: Maybe TerminalMoveWindowCallback
- onTerminalMoveWindow :: (IsTerminal a, MonadIO m) => a -> TerminalMoveWindowCallback -> m SignalHandlerId
- wrap_TerminalMoveWindowCallback :: TerminalMoveWindowCallback -> C_TerminalMoveWindowCallback
- type C_TerminalPasteClipboardCallback = Ptr () -> Ptr () -> IO ()
- type TerminalPasteClipboardCallback = IO ()
- afterTerminalPasteClipboard :: (IsTerminal a, MonadIO m) => a -> TerminalPasteClipboardCallback -> m SignalHandlerId
- genClosure_TerminalPasteClipboard :: MonadIO m => TerminalPasteClipboardCallback -> m (GClosure C_TerminalPasteClipboardCallback)
- mk_TerminalPasteClipboardCallback :: C_TerminalPasteClipboardCallback -> IO (FunPtr C_TerminalPasteClipboardCallback)
- noTerminalPasteClipboardCallback :: Maybe TerminalPasteClipboardCallback
- onTerminalPasteClipboard :: (IsTerminal a, MonadIO m) => a -> TerminalPasteClipboardCallback -> m SignalHandlerId
- wrap_TerminalPasteClipboardCallback :: TerminalPasteClipboardCallback -> C_TerminalPasteClipboardCallback
- type C_TerminalRaiseWindowCallback = Ptr () -> Ptr () -> IO ()
- type TerminalRaiseWindowCallback = IO ()
- afterTerminalRaiseWindow :: (IsTerminal a, MonadIO m) => a -> TerminalRaiseWindowCallback -> m SignalHandlerId
- genClosure_TerminalRaiseWindow :: MonadIO m => TerminalRaiseWindowCallback -> m (GClosure C_TerminalRaiseWindowCallback)
- mk_TerminalRaiseWindowCallback :: C_TerminalRaiseWindowCallback -> IO (FunPtr C_TerminalRaiseWindowCallback)
- noTerminalRaiseWindowCallback :: Maybe TerminalRaiseWindowCallback
- onTerminalRaiseWindow :: (IsTerminal a, MonadIO m) => a -> TerminalRaiseWindowCallback -> m SignalHandlerId
- wrap_TerminalRaiseWindowCallback :: TerminalRaiseWindowCallback -> C_TerminalRaiseWindowCallback
- type C_TerminalRefreshWindowCallback = Ptr () -> Ptr () -> IO ()
- type TerminalRefreshWindowCallback = IO ()
- afterTerminalRefreshWindow :: (IsTerminal a, MonadIO m) => a -> TerminalRefreshWindowCallback -> m SignalHandlerId
- genClosure_TerminalRefreshWindow :: MonadIO m => TerminalRefreshWindowCallback -> m (GClosure C_TerminalRefreshWindowCallback)
- mk_TerminalRefreshWindowCallback :: C_TerminalRefreshWindowCallback -> IO (FunPtr C_TerminalRefreshWindowCallback)
- noTerminalRefreshWindowCallback :: Maybe TerminalRefreshWindowCallback
- onTerminalRefreshWindow :: (IsTerminal a, MonadIO m) => a -> TerminalRefreshWindowCallback -> m SignalHandlerId
- wrap_TerminalRefreshWindowCallback :: TerminalRefreshWindowCallback -> C_TerminalRefreshWindowCallback
- type C_TerminalResizeWindowCallback = Ptr () -> Word32 -> Word32 -> Ptr () -> IO ()
- type TerminalResizeWindowCallback = Word32 -> Word32 -> IO ()
- afterTerminalResizeWindow :: (IsTerminal a, MonadIO m) => a -> TerminalResizeWindowCallback -> m SignalHandlerId
- genClosure_TerminalResizeWindow :: MonadIO m => TerminalResizeWindowCallback -> m (GClosure C_TerminalResizeWindowCallback)
- mk_TerminalResizeWindowCallback :: C_TerminalResizeWindowCallback -> IO (FunPtr C_TerminalResizeWindowCallback)
- noTerminalResizeWindowCallback :: Maybe TerminalResizeWindowCallback
- onTerminalResizeWindow :: (IsTerminal a, MonadIO m) => a -> TerminalResizeWindowCallback -> m SignalHandlerId
- wrap_TerminalResizeWindowCallback :: TerminalResizeWindowCallback -> C_TerminalResizeWindowCallback
- type C_TerminalRestoreWindowCallback = Ptr () -> Ptr () -> IO ()
- type TerminalRestoreWindowCallback = IO ()
- afterTerminalRestoreWindow :: (IsTerminal a, MonadIO m) => a -> TerminalRestoreWindowCallback -> m SignalHandlerId
- genClosure_TerminalRestoreWindow :: MonadIO m => TerminalRestoreWindowCallback -> m (GClosure C_TerminalRestoreWindowCallback)
- mk_TerminalRestoreWindowCallback :: C_TerminalRestoreWindowCallback -> IO (FunPtr C_TerminalRestoreWindowCallback)
- noTerminalRestoreWindowCallback :: Maybe TerminalRestoreWindowCallback
- onTerminalRestoreWindow :: (IsTerminal a, MonadIO m) => a -> TerminalRestoreWindowCallback -> m SignalHandlerId
- wrap_TerminalRestoreWindowCallback :: TerminalRestoreWindowCallback -> C_TerminalRestoreWindowCallback
- type C_TerminalSelectionChangedCallback = Ptr () -> Ptr () -> IO ()
- type TerminalSelectionChangedCallback = IO ()
- afterTerminalSelectionChanged :: (IsTerminal a, MonadIO m) => a -> TerminalSelectionChangedCallback -> m SignalHandlerId
- genClosure_TerminalSelectionChanged :: MonadIO m => TerminalSelectionChangedCallback -> m (GClosure C_TerminalSelectionChangedCallback)
- mk_TerminalSelectionChangedCallback :: C_TerminalSelectionChangedCallback -> IO (FunPtr C_TerminalSelectionChangedCallback)
- noTerminalSelectionChangedCallback :: Maybe TerminalSelectionChangedCallback
- onTerminalSelectionChanged :: (IsTerminal a, MonadIO m) => a -> TerminalSelectionChangedCallback -> m SignalHandlerId
- wrap_TerminalSelectionChangedCallback :: TerminalSelectionChangedCallback -> C_TerminalSelectionChangedCallback
- type C_TerminalTextDeletedCallback = Ptr () -> Ptr () -> IO ()
- type TerminalTextDeletedCallback = IO ()
- afterTerminalTextDeleted :: (IsTerminal a, MonadIO m) => a -> TerminalTextDeletedCallback -> m SignalHandlerId
- genClosure_TerminalTextDeleted :: MonadIO m => TerminalTextDeletedCallback -> m (GClosure C_TerminalTextDeletedCallback)
- mk_TerminalTextDeletedCallback :: C_TerminalTextDeletedCallback -> IO (FunPtr C_TerminalTextDeletedCallback)
- noTerminalTextDeletedCallback :: Maybe TerminalTextDeletedCallback
- onTerminalTextDeleted :: (IsTerminal a, MonadIO m) => a -> TerminalTextDeletedCallback -> m SignalHandlerId
- wrap_TerminalTextDeletedCallback :: TerminalTextDeletedCallback -> C_TerminalTextDeletedCallback
- type C_TerminalTextInsertedCallback = Ptr () -> Ptr () -> IO ()
- type TerminalTextInsertedCallback = IO ()
- afterTerminalTextInserted :: (IsTerminal a, MonadIO m) => a -> TerminalTextInsertedCallback -> m SignalHandlerId
- genClosure_TerminalTextInserted :: MonadIO m => TerminalTextInsertedCallback -> m (GClosure C_TerminalTextInsertedCallback)
- mk_TerminalTextInsertedCallback :: C_TerminalTextInsertedCallback -> IO (FunPtr C_TerminalTextInsertedCallback)
- noTerminalTextInsertedCallback :: Maybe TerminalTextInsertedCallback
- onTerminalTextInserted :: (IsTerminal a, MonadIO m) => a -> TerminalTextInsertedCallback -> m SignalHandlerId
- wrap_TerminalTextInsertedCallback :: TerminalTextInsertedCallback -> C_TerminalTextInsertedCallback
- type C_TerminalTextModifiedCallback = Ptr () -> Ptr () -> IO ()
- type TerminalTextModifiedCallback = IO ()
- afterTerminalTextModified :: (IsTerminal a, MonadIO m) => a -> TerminalTextModifiedCallback -> m SignalHandlerId
- genClosure_TerminalTextModified :: MonadIO m => TerminalTextModifiedCallback -> m (GClosure C_TerminalTextModifiedCallback)
- mk_TerminalTextModifiedCallback :: C_TerminalTextModifiedCallback -> IO (FunPtr C_TerminalTextModifiedCallback)
- noTerminalTextModifiedCallback :: Maybe TerminalTextModifiedCallback
- onTerminalTextModified :: (IsTerminal a, MonadIO m) => a -> TerminalTextModifiedCallback -> m SignalHandlerId
- wrap_TerminalTextModifiedCallback :: TerminalTextModifiedCallback -> C_TerminalTextModifiedCallback
- type C_TerminalTextScrolledCallback = Ptr () -> Int32 -> Ptr () -> IO ()
- type TerminalTextScrolledCallback = Int32 -> IO ()
- afterTerminalTextScrolled :: (IsTerminal a, MonadIO m) => a -> TerminalTextScrolledCallback -> m SignalHandlerId
- genClosure_TerminalTextScrolled :: MonadIO m => TerminalTextScrolledCallback -> m (GClosure C_TerminalTextScrolledCallback)
- mk_TerminalTextScrolledCallback :: C_TerminalTextScrolledCallback -> IO (FunPtr C_TerminalTextScrolledCallback)
- noTerminalTextScrolledCallback :: Maybe TerminalTextScrolledCallback
- onTerminalTextScrolled :: (IsTerminal a, MonadIO m) => a -> TerminalTextScrolledCallback -> m SignalHandlerId
- wrap_TerminalTextScrolledCallback :: TerminalTextScrolledCallback -> C_TerminalTextScrolledCallback
- type C_TerminalWindowTitleChangedCallback = Ptr () -> Ptr () -> IO ()
- type TerminalWindowTitleChangedCallback = IO ()
- afterTerminalWindowTitleChanged :: (IsTerminal a, MonadIO m) => a -> TerminalWindowTitleChangedCallback -> m SignalHandlerId
- genClosure_TerminalWindowTitleChanged :: MonadIO m => TerminalWindowTitleChangedCallback -> m (GClosure C_TerminalWindowTitleChangedCallback)
- mk_TerminalWindowTitleChangedCallback :: C_TerminalWindowTitleChangedCallback -> IO (FunPtr C_TerminalWindowTitleChangedCallback)
- noTerminalWindowTitleChangedCallback :: Maybe TerminalWindowTitleChangedCallback
- onTerminalWindowTitleChanged :: (IsTerminal a, MonadIO m) => a -> TerminalWindowTitleChangedCallback -> m SignalHandlerId
- wrap_TerminalWindowTitleChangedCallback :: TerminalWindowTitleChangedCallback -> C_TerminalWindowTitleChangedCallback

# 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 # (/=) :: Terminal -> Terminal -> Bool #
IsGValue Terminal Source # | Convert `Terminal` to and from `GValue` with `toGValue` and `fromGValue`.
Instance details Defined in GI.Vte.Objects.Terminal Methods toGValue :: Terminal -> IO GValue Source # fromGValue :: GValue -> IO Terminal Source #
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 #
GObject Terminal Source # |
Instance details Defined in GI.Vte.Objects.Terminal
HasParentTypes Terminal Source # |
Instance details Defined in GI.Vte.Objects.Terminal
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

## Overloaded methods

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

## 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 send UTF-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 GtkWidget[draw](#g:signal:draw) 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.

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

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

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.

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

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

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

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

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

## getText

terminalGetText Source #

Arguments

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

Extracts a view of the visible part of the terminal. If `isSelected` is not `Nothing`, characters will only be read if `isSelected` returns `True` after being passed the column and row, respectively. A `CharAttributes` structure is added to `attributes` for each byte added to the returned string detailing the character's position, colors, and other characteristics.

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

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

## getTextIncludeTrailingSpaces

terminalGetTextIncludeTrailingSpaces Source #

Arguments

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

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

Extracts a view of the visible part of the terminal. If `isSelected` is not `Nothing`, characters will only be read if `isSelected` returns `True` after being passed the column and row, respectively. A `CharAttributes` structure is added to `attributes` for each byte added to the returned string detailing the character's position, colors, and other characteristics.

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

## 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
-> m (Text, [CharAttributes]) | Returns: a newly allocated text string, or `Nothing`.

Extracts a view of the visible part of the terminal. If `isSelected` is not `Nothing`, characters will only be read if `isSelected` returns `True` after being passed the column and row, respectively. A `CharAttributes` structure is added to `attributes` for each byte added to the returned string detailing the character's position, colors, and other characteristics. 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.

## getWindowTitle

terminalGetWindowTitle Source #

Arguments

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

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

## 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` or `vte_terminal_match_add_regex_full()` 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 `PCRE2_MULTILINE` 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.

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

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

## 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 `PCRE2_MULTILINE` 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 (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 |
-> 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].

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

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

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

This function does nothing.

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.

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

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

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

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

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.

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

## 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()`.

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

## 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`::`gtk-cursor-blink` 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 ]

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

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

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

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

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

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

# Signals

## bell

type C_TerminalBellCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

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

genClosure_TerminalBell :: MonadIO m => TerminalBellCallback -> m (GClosure C_TerminalBellCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalBellCallback :: C_TerminalBellCallback -> IO (FunPtr C_TerminalBellCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalBellCallback`.

noTerminalBellCallback :: Maybe TerminalBellCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalBellCallback``.

onTerminalBell :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalBellCallback :: TerminalBellCallback -> C_TerminalBellCallback Source #

Wrap a `TerminalBellCallback` into a `C_TerminalBellCallback`.

## charSizeChanged

type C_TerminalCharSizeChangedCallback = Ptr () -> Word32 -> Word32 -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

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

genClosure_TerminalCharSizeChanged :: MonadIO m => TerminalCharSizeChangedCallback -> m (GClosure C_TerminalCharSizeChangedCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalCharSizeChangedCallback :: C_TerminalCharSizeChangedCallback -> IO (FunPtr C_TerminalCharSizeChangedCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalCharSizeChangedCallback`.

noTerminalCharSizeChangedCallback :: Maybe TerminalCharSizeChangedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalCharSizeChangedCallback``.

onTerminalCharSizeChanged :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalCharSizeChangedCallback :: TerminalCharSizeChangedCallback -> C_TerminalCharSizeChangedCallback Source #

Wrap a `TerminalCharSizeChangedCallback` into a `C_TerminalCharSizeChangedCallback`.

## childExited

type C_TerminalChildExitedCallback = Ptr () -> Int32 -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

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

genClosure_TerminalChildExited :: MonadIO m => TerminalChildExitedCallback -> m (GClosure C_TerminalChildExitedCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalChildExitedCallback :: C_TerminalChildExitedCallback -> IO (FunPtr C_TerminalChildExitedCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalChildExitedCallback`.

noTerminalChildExitedCallback :: Maybe TerminalChildExitedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalChildExitedCallback``.

onTerminalChildExited :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalChildExitedCallback :: TerminalChildExitedCallback -> C_TerminalChildExitedCallback Source #

Wrap a `TerminalChildExitedCallback` into a `C_TerminalChildExitedCallback`.

## commit

type C_TerminalCommitCallback = Ptr () -> CString -> Word32 -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

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

genClosure_TerminalCommit :: MonadIO m => TerminalCommitCallback -> m (GClosure C_TerminalCommitCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalCommitCallback :: C_TerminalCommitCallback -> IO (FunPtr C_TerminalCommitCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalCommitCallback`.

noTerminalCommitCallback :: Maybe TerminalCommitCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalCommitCallback``.

onTerminalCommit :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalCommitCallback :: TerminalCommitCallback -> C_TerminalCommitCallback Source #

Wrap a `TerminalCommitCallback` into a `C_TerminalCommitCallback`.

## contentsChanged

type C_TerminalContentsChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalContentsChangedCallback = IO () Source #

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

afterTerminalContentsChanged :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalContentsChanged :: MonadIO m => TerminalContentsChangedCallback -> m (GClosure C_TerminalContentsChangedCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalContentsChangedCallback :: C_TerminalContentsChangedCallback -> IO (FunPtr C_TerminalContentsChangedCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalContentsChangedCallback`.

noTerminalContentsChangedCallback :: Maybe TerminalContentsChangedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalContentsChangedCallback``.

onTerminalContentsChanged :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalContentsChangedCallback :: TerminalContentsChangedCallback -> C_TerminalContentsChangedCallback Source #

Wrap a `TerminalContentsChangedCallback` into a `C_TerminalContentsChangedCallback`.

## copyClipboard

type C_TerminalCopyClipboardCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalCopyClipboardCallback = IO () Source #

Emitted whenever `terminalCopyClipboard` is called.

afterTerminalCopyClipboard :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalCopyClipboard :: MonadIO m => TerminalCopyClipboardCallback -> m (GClosure C_TerminalCopyClipboardCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalCopyClipboardCallback :: C_TerminalCopyClipboardCallback -> IO (FunPtr C_TerminalCopyClipboardCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalCopyClipboardCallback`.

noTerminalCopyClipboardCallback :: Maybe TerminalCopyClipboardCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalCopyClipboardCallback``.

onTerminalCopyClipboard :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalCopyClipboardCallback :: TerminalCopyClipboardCallback -> C_TerminalCopyClipboardCallback Source #

Wrap a `TerminalCopyClipboardCallback` into a `C_TerminalCopyClipboardCallback`.

## currentDirectoryUriChanged

type C_TerminalCurrentDirectoryUriChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalCurrentDirectoryUriChangedCallback = IO () Source #

Emitted when the current directory URI is modified.

afterTerminalCurrentDirectoryUriChanged :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalCurrentDirectoryUriChanged :: MonadIO m => TerminalCurrentDirectoryUriChangedCallback -> m (GClosure C_TerminalCurrentDirectoryUriChangedCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalCurrentDirectoryUriChangedCallback :: C_TerminalCurrentDirectoryUriChangedCallback -> IO (FunPtr C_TerminalCurrentDirectoryUriChangedCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalCurrentDirectoryUriChangedCallback`.

noTerminalCurrentDirectoryUriChangedCallback :: Maybe TerminalCurrentDirectoryUriChangedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalCurrentDirectoryUriChangedCallback``.

onTerminalCurrentDirectoryUriChanged :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalCurrentDirectoryUriChangedCallback :: TerminalCurrentDirectoryUriChangedCallback -> C_TerminalCurrentDirectoryUriChangedCallback Source #

Wrap a `TerminalCurrentDirectoryUriChangedCallback` into a `C_TerminalCurrentDirectoryUriChangedCallback`.

## currentFileUriChanged

type C_TerminalCurrentFileUriChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalCurrentFileUriChangedCallback = IO () Source #

Emitted when the current file URI is modified.

afterTerminalCurrentFileUriChanged :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalCurrentFileUriChanged :: MonadIO m => TerminalCurrentFileUriChangedCallback -> m (GClosure C_TerminalCurrentFileUriChangedCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalCurrentFileUriChangedCallback :: C_TerminalCurrentFileUriChangedCallback -> IO (FunPtr C_TerminalCurrentFileUriChangedCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalCurrentFileUriChangedCallback`.

noTerminalCurrentFileUriChangedCallback :: Maybe TerminalCurrentFileUriChangedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalCurrentFileUriChangedCallback``.

onTerminalCurrentFileUriChanged :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalCurrentFileUriChangedCallback :: TerminalCurrentFileUriChangedCallback -> C_TerminalCurrentFileUriChangedCallback Source #

Wrap a `TerminalCurrentFileUriChangedCallback` into a `C_TerminalCurrentFileUriChangedCallback`.

## cursorMoved

type C_TerminalCursorMovedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalCursorMovedCallback = IO () Source #

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

afterTerminalCursorMoved :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalCursorMoved :: MonadIO m => TerminalCursorMovedCallback -> m (GClosure C_TerminalCursorMovedCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalCursorMovedCallback :: C_TerminalCursorMovedCallback -> IO (FunPtr C_TerminalCursorMovedCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalCursorMovedCallback`.

noTerminalCursorMovedCallback :: Maybe TerminalCursorMovedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalCursorMovedCallback``.

onTerminalCursorMoved :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalCursorMovedCallback :: TerminalCursorMovedCallback -> C_TerminalCursorMovedCallback Source #

Wrap a `TerminalCursorMovedCallback` into a `C_TerminalCursorMovedCallback`.

## decreaseFontSize

type C_TerminalDecreaseFontSizeCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalDecreaseFontSizeCallback = IO () Source #

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

afterTerminalDecreaseFontSize :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalDecreaseFontSize :: MonadIO m => TerminalDecreaseFontSizeCallback -> m (GClosure C_TerminalDecreaseFontSizeCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalDecreaseFontSizeCallback :: C_TerminalDecreaseFontSizeCallback -> IO (FunPtr C_TerminalDecreaseFontSizeCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalDecreaseFontSizeCallback`.

noTerminalDecreaseFontSizeCallback :: Maybe TerminalDecreaseFontSizeCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalDecreaseFontSizeCallback``.

onTerminalDecreaseFontSize :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalDecreaseFontSizeCallback :: TerminalDecreaseFontSizeCallback -> C_TerminalDecreaseFontSizeCallback Source #

Wrap a `TerminalDecreaseFontSizeCallback` into a `C_TerminalDecreaseFontSizeCallback`.

## deiconifyWindow

type C_TerminalDeiconifyWindowCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalDeiconifyWindowCallback = IO () Source #

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalDeiconifyWindow :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalDeiconifyWindow :: MonadIO m => TerminalDeiconifyWindowCallback -> m (GClosure C_TerminalDeiconifyWindowCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalDeiconifyWindowCallback :: C_TerminalDeiconifyWindowCallback -> IO (FunPtr C_TerminalDeiconifyWindowCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalDeiconifyWindowCallback`.

noTerminalDeiconifyWindowCallback :: Maybe TerminalDeiconifyWindowCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalDeiconifyWindowCallback``.

onTerminalDeiconifyWindow :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalDeiconifyWindowCallback :: TerminalDeiconifyWindowCallback -> C_TerminalDeiconifyWindowCallback Source #

Wrap a `TerminalDeiconifyWindowCallback` into a `C_TerminalDeiconifyWindowCallback`.

## encodingChanged

type C_TerminalEncodingChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

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

genClosure_TerminalEncodingChanged :: MonadIO m => TerminalEncodingChangedCallback -> m (GClosure C_TerminalEncodingChangedCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalEncodingChangedCallback :: C_TerminalEncodingChangedCallback -> IO (FunPtr C_TerminalEncodingChangedCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalEncodingChangedCallback`.

noTerminalEncodingChangedCallback :: Maybe TerminalEncodingChangedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalEncodingChangedCallback``.

onTerminalEncodingChanged :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalEncodingChangedCallback :: TerminalEncodingChangedCallback -> C_TerminalEncodingChangedCallback Source #

Wrap a `TerminalEncodingChangedCallback` into a `C_TerminalEncodingChangedCallback`.

## eof

type C_TerminalEofCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

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

afterTerminalEof :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalEof :: MonadIO m => TerminalEofCallback -> m (GClosure C_TerminalEofCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalEofCallback :: C_TerminalEofCallback -> IO (FunPtr C_TerminalEofCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalEofCallback`.

noTerminalEofCallback :: Maybe TerminalEofCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalEofCallback``.

onTerminalEof :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalEofCallback :: TerminalEofCallback -> C_TerminalEofCallback Source #

Wrap a `TerminalEofCallback` into a `C_TerminalEofCallback`.

## hyperlinkHoverUriChanged

type C_TerminalHyperlinkHoverUriChangedCallback = Ptr () -> CString -> Ptr Rectangle -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalHyperlinkHoverUriChangedCallback Source #

Arguments

= Text | `uri`: the nonempty target URI under the mouse, or NULL
-> Rectangle | `bbox`: the bounding box of the hyperlink anchor text, or NULL
-> IO () |

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

genClosure_TerminalHyperlinkHoverUriChanged :: MonadIO m => TerminalHyperlinkHoverUriChangedCallback -> m (GClosure C_TerminalHyperlinkHoverUriChangedCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalHyperlinkHoverUriChangedCallback :: C_TerminalHyperlinkHoverUriChangedCallback -> IO (FunPtr C_TerminalHyperlinkHoverUriChangedCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalHyperlinkHoverUriChangedCallback`.

noTerminalHyperlinkHoverUriChangedCallback :: Maybe TerminalHyperlinkHoverUriChangedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalHyperlinkHoverUriChangedCallback``.

onTerminalHyperlinkHoverUriChanged :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalHyperlinkHoverUriChangedCallback :: TerminalHyperlinkHoverUriChangedCallback -> C_TerminalHyperlinkHoverUriChangedCallback Source #

Wrap a `TerminalHyperlinkHoverUriChangedCallback` into a `C_TerminalHyperlinkHoverUriChangedCallback`.

## iconTitleChanged

type C_TerminalIconTitleChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

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

genClosure_TerminalIconTitleChanged :: MonadIO m => TerminalIconTitleChangedCallback -> m (GClosure C_TerminalIconTitleChangedCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalIconTitleChangedCallback :: C_TerminalIconTitleChangedCallback -> IO (FunPtr C_TerminalIconTitleChangedCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalIconTitleChangedCallback`.

noTerminalIconTitleChangedCallback :: Maybe TerminalIconTitleChangedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalIconTitleChangedCallback``.

onTerminalIconTitleChanged :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalIconTitleChangedCallback :: TerminalIconTitleChangedCallback -> C_TerminalIconTitleChangedCallback Source #

Wrap a `TerminalIconTitleChangedCallback` into a `C_TerminalIconTitleChangedCallback`.

## iconifyWindow

type C_TerminalIconifyWindowCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalIconifyWindowCallback = IO () Source #

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalIconifyWindow :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalIconifyWindow :: MonadIO m => TerminalIconifyWindowCallback -> m (GClosure C_TerminalIconifyWindowCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalIconifyWindowCallback :: C_TerminalIconifyWindowCallback -> IO (FunPtr C_TerminalIconifyWindowCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalIconifyWindowCallback`.

noTerminalIconifyWindowCallback :: Maybe TerminalIconifyWindowCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalIconifyWindowCallback``.

onTerminalIconifyWindow :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalIconifyWindowCallback :: TerminalIconifyWindowCallback -> C_TerminalIconifyWindowCallback Source #

Wrap a `TerminalIconifyWindowCallback` into a `C_TerminalIconifyWindowCallback`.

## increaseFontSize

type C_TerminalIncreaseFontSizeCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalIncreaseFontSizeCallback = IO () Source #

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

afterTerminalIncreaseFontSize :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalIncreaseFontSize :: MonadIO m => TerminalIncreaseFontSizeCallback -> m (GClosure C_TerminalIncreaseFontSizeCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalIncreaseFontSizeCallback :: C_TerminalIncreaseFontSizeCallback -> IO (FunPtr C_TerminalIncreaseFontSizeCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalIncreaseFontSizeCallback`.

noTerminalIncreaseFontSizeCallback :: Maybe TerminalIncreaseFontSizeCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalIncreaseFontSizeCallback``.

onTerminalIncreaseFontSize :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalIncreaseFontSizeCallback :: TerminalIncreaseFontSizeCallback -> C_TerminalIncreaseFontSizeCallback Source #

Wrap a `TerminalIncreaseFontSizeCallback` into a `C_TerminalIncreaseFontSizeCallback`.

## lowerWindow

type C_TerminalLowerWindowCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalLowerWindowCallback = IO () Source #

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalLowerWindow :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalLowerWindow :: MonadIO m => TerminalLowerWindowCallback -> m (GClosure C_TerminalLowerWindowCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalLowerWindowCallback :: C_TerminalLowerWindowCallback -> IO (FunPtr C_TerminalLowerWindowCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalLowerWindowCallback`.

noTerminalLowerWindowCallback :: Maybe TerminalLowerWindowCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalLowerWindowCallback``.

onTerminalLowerWindow :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalLowerWindowCallback :: TerminalLowerWindowCallback -> C_TerminalLowerWindowCallback Source #

Wrap a `TerminalLowerWindowCallback` into a `C_TerminalLowerWindowCallback`.

## maximizeWindow

type C_TerminalMaximizeWindowCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalMaximizeWindowCallback = IO () Source #

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalMaximizeWindow :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalMaximizeWindow :: MonadIO m => TerminalMaximizeWindowCallback -> m (GClosure C_TerminalMaximizeWindowCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalMaximizeWindowCallback :: C_TerminalMaximizeWindowCallback -> IO (FunPtr C_TerminalMaximizeWindowCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalMaximizeWindowCallback`.

noTerminalMaximizeWindowCallback :: Maybe TerminalMaximizeWindowCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalMaximizeWindowCallback``.

onTerminalMaximizeWindow :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalMaximizeWindowCallback :: TerminalMaximizeWindowCallback -> C_TerminalMaximizeWindowCallback Source #

Wrap a `TerminalMaximizeWindowCallback` into a `C_TerminalMaximizeWindowCallback`.

## moveWindow

type C_TerminalMoveWindowCallback = Ptr () -> Word32 -> Word32 -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

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

genClosure_TerminalMoveWindow :: MonadIO m => TerminalMoveWindowCallback -> m (GClosure C_TerminalMoveWindowCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalMoveWindowCallback :: C_TerminalMoveWindowCallback -> IO (FunPtr C_TerminalMoveWindowCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalMoveWindowCallback`.

noTerminalMoveWindowCallback :: Maybe TerminalMoveWindowCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalMoveWindowCallback``.

onTerminalMoveWindow :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalMoveWindowCallback :: TerminalMoveWindowCallback -> C_TerminalMoveWindowCallback Source #

Wrap a `TerminalMoveWindowCallback` into a `C_TerminalMoveWindowCallback`.

## pasteClipboard

type C_TerminalPasteClipboardCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalPasteClipboardCallback = IO () Source #

Emitted whenever `terminalPasteClipboard` is called.

afterTerminalPasteClipboard :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalPasteClipboard :: MonadIO m => TerminalPasteClipboardCallback -> m (GClosure C_TerminalPasteClipboardCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalPasteClipboardCallback :: C_TerminalPasteClipboardCallback -> IO (FunPtr C_TerminalPasteClipboardCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalPasteClipboardCallback`.

noTerminalPasteClipboardCallback :: Maybe TerminalPasteClipboardCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalPasteClipboardCallback``.

onTerminalPasteClipboard :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalPasteClipboardCallback :: TerminalPasteClipboardCallback -> C_TerminalPasteClipboardCallback Source #

Wrap a `TerminalPasteClipboardCallback` into a `C_TerminalPasteClipboardCallback`.

## raiseWindow

type C_TerminalRaiseWindowCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalRaiseWindowCallback = IO () Source #

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalRaiseWindow :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalRaiseWindow :: MonadIO m => TerminalRaiseWindowCallback -> m (GClosure C_TerminalRaiseWindowCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalRaiseWindowCallback :: C_TerminalRaiseWindowCallback -> IO (FunPtr C_TerminalRaiseWindowCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalRaiseWindowCallback`.

noTerminalRaiseWindowCallback :: Maybe TerminalRaiseWindowCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalRaiseWindowCallback``.

onTerminalRaiseWindow :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalRaiseWindowCallback :: TerminalRaiseWindowCallback -> C_TerminalRaiseWindowCallback Source #

Wrap a `TerminalRaiseWindowCallback` into a `C_TerminalRaiseWindowCallback`.

## refreshWindow

type C_TerminalRefreshWindowCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalRefreshWindowCallback = IO () Source #

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalRefreshWindow :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalRefreshWindow :: MonadIO m => TerminalRefreshWindowCallback -> m (GClosure C_TerminalRefreshWindowCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalRefreshWindowCallback :: C_TerminalRefreshWindowCallback -> IO (FunPtr C_TerminalRefreshWindowCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalRefreshWindowCallback`.

noTerminalRefreshWindowCallback :: Maybe TerminalRefreshWindowCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalRefreshWindowCallback``.

onTerminalRefreshWindow :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalRefreshWindowCallback :: TerminalRefreshWindowCallback -> C_TerminalRefreshWindowCallback Source #

Wrap a `TerminalRefreshWindowCallback` into a `C_TerminalRefreshWindowCallback`.

## resizeWindow

type C_TerminalResizeWindowCallback = Ptr () -> Word32 -> Word32 -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

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

genClosure_TerminalResizeWindow :: MonadIO m => TerminalResizeWindowCallback -> m (GClosure C_TerminalResizeWindowCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalResizeWindowCallback :: C_TerminalResizeWindowCallback -> IO (FunPtr C_TerminalResizeWindowCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalResizeWindowCallback`.

noTerminalResizeWindowCallback :: Maybe TerminalResizeWindowCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalResizeWindowCallback``.

onTerminalResizeWindow :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalResizeWindowCallback :: TerminalResizeWindowCallback -> C_TerminalResizeWindowCallback Source #

Wrap a `TerminalResizeWindowCallback` into a `C_TerminalResizeWindowCallback`.

## restoreWindow

type C_TerminalRestoreWindowCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalRestoreWindowCallback = IO () Source #

Deprecated: (Since version 0.60)

Never emitted.

afterTerminalRestoreWindow :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalRestoreWindow :: MonadIO m => TerminalRestoreWindowCallback -> m (GClosure C_TerminalRestoreWindowCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalRestoreWindowCallback :: C_TerminalRestoreWindowCallback -> IO (FunPtr C_TerminalRestoreWindowCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalRestoreWindowCallback`.

noTerminalRestoreWindowCallback :: Maybe TerminalRestoreWindowCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalRestoreWindowCallback``.

onTerminalRestoreWindow :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalRestoreWindowCallback :: TerminalRestoreWindowCallback -> C_TerminalRestoreWindowCallback Source #

Wrap a `TerminalRestoreWindowCallback` into a `C_TerminalRestoreWindowCallback`.

## selectionChanged

type C_TerminalSelectionChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalSelectionChangedCallback = IO () Source #

Emitted whenever the contents of terminal's selection changes.

afterTerminalSelectionChanged :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalSelectionChanged :: MonadIO m => TerminalSelectionChangedCallback -> m (GClosure C_TerminalSelectionChangedCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalSelectionChangedCallback :: C_TerminalSelectionChangedCallback -> IO (FunPtr C_TerminalSelectionChangedCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalSelectionChangedCallback`.

noTerminalSelectionChangedCallback :: Maybe TerminalSelectionChangedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalSelectionChangedCallback``.

onTerminalSelectionChanged :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalSelectionChangedCallback :: TerminalSelectionChangedCallback -> C_TerminalSelectionChangedCallback Source #

Wrap a `TerminalSelectionChangedCallback` into a `C_TerminalSelectionChangedCallback`.

## textDeleted

type C_TerminalTextDeletedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalTextDeletedCallback = IO () Source #

An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.

afterTerminalTextDeleted :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalTextDeleted :: MonadIO m => TerminalTextDeletedCallback -> m (GClosure C_TerminalTextDeletedCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalTextDeletedCallback :: C_TerminalTextDeletedCallback -> IO (FunPtr C_TerminalTextDeletedCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalTextDeletedCallback`.

noTerminalTextDeletedCallback :: Maybe TerminalTextDeletedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalTextDeletedCallback``.

onTerminalTextDeleted :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalTextDeletedCallback :: TerminalTextDeletedCallback -> C_TerminalTextDeletedCallback Source #

Wrap a `TerminalTextDeletedCallback` into a `C_TerminalTextDeletedCallback`.

## textInserted

type C_TerminalTextInsertedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalTextInsertedCallback = IO () Source #

An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.

afterTerminalTextInserted :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalTextInserted :: MonadIO m => TerminalTextInsertedCallback -> m (GClosure C_TerminalTextInsertedCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalTextInsertedCallback :: C_TerminalTextInsertedCallback -> IO (FunPtr C_TerminalTextInsertedCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalTextInsertedCallback`.

noTerminalTextInsertedCallback :: Maybe TerminalTextInsertedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalTextInsertedCallback``.

onTerminalTextInserted :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalTextInsertedCallback :: TerminalTextInsertedCallback -> C_TerminalTextInsertedCallback Source #

Wrap a `TerminalTextInsertedCallback` into a `C_TerminalTextInsertedCallback`.

## textModified

type C_TerminalTextModifiedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalTextModifiedCallback = IO () Source #

An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.

afterTerminalTextModified :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalTextModified :: MonadIO m => TerminalTextModifiedCallback -> m (GClosure C_TerminalTextModifiedCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalTextModifiedCallback :: C_TerminalTextModifiedCallback -> IO (FunPtr C_TerminalTextModifiedCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalTextModifiedCallback`.

noTerminalTextModifiedCallback :: Maybe TerminalTextModifiedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalTextModifiedCallback``.

onTerminalTextModified :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalTextModifiedCallback :: TerminalTextModifiedCallback -> C_TerminalTextModifiedCallback Source #

Wrap a `TerminalTextModifiedCallback` into a `C_TerminalTextModifiedCallback`.

## textScrolled

type C_TerminalTextScrolledCallback = Ptr () -> Int32 -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalTextScrolledCallback Source #

Arguments

= Int32 | `delta`: the number of lines scrolled
-> IO () |

An internal signal used for communication between the terminal and its accessibility peer. May not be emitted under certain circumstances.

afterTerminalTextScrolled :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalTextScrolled :: MonadIO m => TerminalTextScrolledCallback -> m (GClosure C_TerminalTextScrolledCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalTextScrolledCallback :: C_TerminalTextScrolledCallback -> IO (FunPtr C_TerminalTextScrolledCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalTextScrolledCallback`.

noTerminalTextScrolledCallback :: Maybe TerminalTextScrolledCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalTextScrolledCallback``.

onTerminalTextScrolled :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalTextScrolledCallback :: TerminalTextScrolledCallback -> C_TerminalTextScrolledCallback Source #

Wrap a `TerminalTextScrolledCallback` into a `C_TerminalTextScrolledCallback`.

## windowTitleChanged

type C_TerminalWindowTitleChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TerminalWindowTitleChangedCallback = IO () Source #

Emitted when the terminal's `window_title` field is modified.

afterTerminalWindowTitleChanged :: (IsTerminal a, MonadIO m) => 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

genClosure_TerminalWindowTitleChanged :: MonadIO m => TerminalWindowTitleChangedCallback -> m (GClosure C_TerminalWindowTitleChangedCallback) Source #

Wrap the callback into a `GClosure`.

mk_TerminalWindowTitleChangedCallback :: C_TerminalWindowTitleChangedCallback -> IO (FunPtr C_TerminalWindowTitleChangedCallback) Source #

Generate a function pointer callable from C code, from a `C_TerminalWindowTitleChangedCallback`.

noTerminalWindowTitleChangedCallback :: Maybe TerminalWindowTitleChangedCallback Source #

A convenience synonym for ``Nothing` :: `Maybe` `TerminalWindowTitleChangedCallback``.

onTerminalWindowTitleChanged :: (IsTerminal a, MonadIO m) => 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

wrap_TerminalWindowTitleChangedCallback :: TerminalWindowTitleChangedCallback -> C_TerminalWindowTitleChangedCallback Source #

Wrap a `TerminalWindowTitleChangedCallback` into a `C_TerminalWindowTitleChangedCallback`.