gi-vte-2.91.19: Vte bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Vte.Objects.Terminal

Contents

Description

No description available in the introspection data.

Synopsis

Exported types

newtype Terminal Source #

Memory-managed wrapper type.

Constructors

Terminal (ManagedPtr Terminal) 
Instances
GObject Terminal Source # 
Instance details

Defined in GI.Vte.Objects.Terminal

IsImplementorIface Terminal Source # 
Instance details

Defined in GI.Vte.Objects.Terminal

IsObject Terminal Source # 
Instance details

Defined in GI.Vte.Objects.Terminal

IsWidget Terminal Source # 
Instance details

Defined in GI.Vte.Objects.Terminal

IsScrollable Terminal Source # 
Instance details

Defined in GI.Vte.Objects.Terminal

IsBuildable Terminal Source # 
Instance details

Defined in GI.Vte.Objects.Terminal

IsTerminal Terminal Source # 
Instance details

Defined in GI.Vte.Objects.Terminal

class GObject o => IsTerminal o Source #

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

Instances
(GObject a, (UnknownAncestorError Terminal a :: Constraint)) => IsTerminal a Source # 
Instance details

Defined in GI.Vte.Objects.Terminal

IsTerminal Terminal 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.

noTerminal :: Maybe Terminal Source #

A convenience alias for Nothing :: Maybe Terminal.

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. This can either be used to drive the terminal without a child process, or just to mess with your users.

feedChild

terminalFeedChild Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) 
=> a

terminal: a Terminal

-> Maybe [Int8]

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

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

Checks whether or not the terminal will attempt to draw bold text, either by using a bold font variant or by repainting text with a different offset.

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 when using the UTF-8 encoding (terminalSetEncoding).

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

getCursorShape

terminalGetCursorShape Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) 
=> a

terminal: a Terminal

-> m CursorShape

Returns: cursor shape.

Returns the currently set cursor shape.

getEncoding

terminalGetEncoding Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) 
=> a

terminal: a Terminal

-> m Text

Returns: the current encoding for the terminal

Determines the name of the encoding in which the terminal expects data to be encoded.

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 Text

Returns: the icon title

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

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

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

getWindowTitle

terminalGetWindowTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) 
=> a

terminal: a Terminal

-> m (Maybe Text)

Returns: the window title

No description available in the introspection data.

getWordCharExceptions

terminalGetWordCharExceptions Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) 
=> a

terminal: a Terminal

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

Returns: a newly allocated string containing the target of the hyperlink

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: an integer associated with this expression, or -1 if gregex could not be transformed into a Regex or gflags were incompatible

Deprecated: (Since version 0.46)Use terminalMatchAddRegex or vte_terminal_match_add_regex_full() instead.

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.

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.

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 (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 (Text, Int32)

Returns: a newly allocated string which matches one of the previously set regular expressions

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 terminalMatchSetCursorType or vte_terminal_match_set_cursor_named() 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 () 

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. If necessary, the data is converted from UTF-8 to the terminal's current encoding. 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. If necessary, the data is converted from UTF-8 to the terminal's current encoding. 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, and sets the emulation property from Terminal:emulation.

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.

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

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.

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

Controls whether or not the terminal will attempt to draw bold text, either by using a bold font variant or by repainting text with a different offset.

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 when using the UTF-8 encoding (terminalSetEncoding). In all other encodings, the width of ambiguous-width characters is fixed.

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.

setEncoding

terminalSetEncoding Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) 
=> a

terminal: a Terminal

-> Maybe Text

codeset: a valid GIConv target, or Nothing to use UTF-8

-> m ()

(Can throw GError)

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

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

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.

setScrollSpeed

terminalSetScrollSpeed Source #

Arguments

:: (HasCallStack, MonadIO m, IsTerminal a) 
=> a

terminal: a Terminal

-> Word32

scrollSpeed: move the buffer by this number of lines while scrolling

-> m () 

Sets the number of lines by which the buffer is moved when scrolling with a mouse wheel. Setting it to zero will cause the buffer to be moved by an amount depending on the number of visible rows the widget can display.

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

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 vte_terminal_spawn_async() 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 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 Terminal::child-exited 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. This may happen either by using a bold font variant, or by repainting text with a different offset.

constructTerminalAllowBold :: IsTerminal o => Bool -> IO (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 => Bool -> IO (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 => Bool -> IO (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 => EraseBinding -> IO (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 => Bool -> IO (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 => Double -> IO (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 => Double -> IO (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 when using the UTF-8 encoding (terminalSetEncoding). In all other encodings, the width of ambiguous-width characters is fixed.

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

constructTerminalCjkAmbiguousWidth :: IsTerminal o => Int32 -> IO (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 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 => CursorBlinkMode -> IO (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 => CursorShape -> IO (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 => EraseBinding -> IO (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 ]

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 => Text -> IO (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 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 => FontDescription -> IO (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 => Double -> IO (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

The terminal's so-called icon title, or Nothing if no icon title has been set.

getTerminalIconTitle :: (MonadIO m, IsTerminal o) => o -> m 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 => Bool -> IO (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 => Bool -> IO (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, IsPty a) => a -> IO (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 => Bool -> IO (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 => Bool -> IO (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 => Bool -> IO (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 ]

scrollSpeed

The number of lines by which the buffer is moved when scrolling with a mouse wheel on top of the terminal Setting it to zero will cause the buffer to be moved by an amount depending on the number of visible rows the widget can display.

constructTerminalScrollSpeed :: IsTerminal o => Word32 -> IO (GValueConstruct o) Source #

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

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

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

get terminal #scrollSpeed

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

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

set terminal [ #scrollSpeed := 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 => Word32 -> IO (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 => TextBlinkMode -> IO (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 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

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

Generate a function pointer callable from C code, from a C_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

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 “char-size-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #charSizeChanged callback

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

Connect a signal handler for the “char-size-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #charSizeChanged callback

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 “child-exited” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #childExited callback

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

Connect a signal handler for the “child-exited” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #childExited callback

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. The signal is emitted even when there is no 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

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

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 “contents-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #contentsChanged callback

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

Connect a signal handler for the “contents-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #contentsChanged callback

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 “copy-clipboard” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #copyClipboard callback

onTerminalCopyClipboard :: (IsTerminal a, MonadIO m) => a -> TerminalCopyClipboardCallback -> m SignalHandlerId Source #

Connect a signal handler for the “copy-clipboard” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #copyClipboard callback

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 “current-directory-uri-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #currentDirectoryUriChanged callback

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

Connect a signal handler for the “current-directory-uri-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #currentDirectoryUriChanged callback

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 “current-file-uri-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #currentFileUriChanged callback

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

Connect a signal handler for the “current-file-uri-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #currentFileUriChanged callback

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 “cursor-moved” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #cursorMoved callback

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

Connect a signal handler for the “cursor-moved” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #cursorMoved callback

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 “decrease-font-size” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #decreaseFontSize callback

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

Connect a signal handler for the “decrease-font-size” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #decreaseFontSize callback

deiconifyWindow

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

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

type TerminalDeiconifyWindowCallback = IO () Source #

Emitted at the child application's request.

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

Connect a signal handler for the “deiconify-window” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #deiconifyWindow callback

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

Connect a signal handler for the “deiconify-window” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #deiconifyWindow callback

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, either as a result of receiving a control sequence which toggled between the local and UTF-8 encodings, or at the parent application's request.

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

Connect a signal handler for the “encoding-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #encodingChanged callback

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

Connect a signal handler for the “encoding-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #encodingChanged callback

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 Terminal::child-exited 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

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

Generate a function pointer callable from C code, from a C_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

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 “hyperlink-hover-uri-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #hyperlinkHoverUriChanged callback

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

Connect a signal handler for the “hyperlink-hover-uri-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #hyperlinkHoverUriChanged callback

iconTitleChanged

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

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

type TerminalIconTitleChangedCallback = IO () Source #

Emitted when the terminal's icon_title field is modified.

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

Connect a signal handler for the “icon-title-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #iconTitleChanged callback

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

Connect a signal handler for the “icon-title-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #iconTitleChanged callback

iconifyWindow

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

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

type TerminalIconifyWindowCallback = IO () Source #

Emitted at the child application's request.

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

Connect a signal handler for the “iconify-window” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #iconifyWindow callback

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

Connect a signal handler for the “iconify-window” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #iconifyWindow callback

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 “increase-font-size” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #increaseFontSize callback

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

Connect a signal handler for the “increase-font-size” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #increaseFontSize callback

lowerWindow

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

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

type TerminalLowerWindowCallback = IO () Source #

Emitted at the child application's request.

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

Connect a signal handler for the “lower-window” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #lowerWindow callback

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

Connect a signal handler for the “lower-window” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #lowerWindow callback

maximizeWindow

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

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

type TerminalMaximizeWindowCallback = IO () Source #

Emitted at the child application's request.

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

Connect a signal handler for the “maximize-window” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #maximizeWindow callback

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

Connect a signal handler for the “maximize-window” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #maximizeWindow callback

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

Emitted at the child application's request.

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

Connect a signal handler for the “move-window” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #moveWindow callback

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

Connect a signal handler for the “move-window” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #moveWindow callback

notificationReceived

type C_TerminalNotificationReceivedCallback = Ptr () -> CString -> CString -> Ptr () -> IO () Source #

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

type TerminalNotificationReceivedCallback Source #

Arguments

 = Text

summary: The summary

-> Maybe Text

body: Extra optional text

-> IO () 

Emitted when a process running in the terminal wants to send a notification to the desktop environment.

afterTerminalNotificationReceived :: (IsTerminal a, MonadIO m) => a -> TerminalNotificationReceivedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “notification-received” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #notificationReceived callback

onTerminalNotificationReceived :: (IsTerminal a, MonadIO m) => a -> TerminalNotificationReceivedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “notification-received” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #notificationReceived callback

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 “paste-clipboard” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #pasteClipboard callback

onTerminalPasteClipboard :: (IsTerminal a, MonadIO m) => a -> TerminalPasteClipboardCallback -> m SignalHandlerId Source #

Connect a signal handler for the “paste-clipboard” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #pasteClipboard callback

raiseWindow

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

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

type TerminalRaiseWindowCallback = IO () Source #

Emitted at the child application's request.

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

Connect a signal handler for the “raise-window” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #raiseWindow callback

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

Connect a signal handler for the “raise-window” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #raiseWindow callback

refreshWindow

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

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

type TerminalRefreshWindowCallback = IO () Source #

Emitted at the child application's request.

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

Connect a signal handler for the “refresh-window” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #refreshWindow callback

onTerminalRefreshWindow :: (IsTerminal a, MonadIO m) => a -> TerminalRefreshWindowCallback -> m SignalHandlerId Source #

Connect a signal handler for the “refresh-window” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #refreshWindow callback

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 “resize-window” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #resizeWindow callback

onTerminalResizeWindow :: (IsTerminal a, MonadIO m) => a -> TerminalResizeWindowCallback -> m SignalHandlerId Source #

Connect a signal handler for the “resize-window” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #resizeWindow callback

restoreWindow

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

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

type TerminalRestoreWindowCallback = IO () Source #

Emitted at the child application's request.

afterTerminalRestoreWindow :: (IsTerminal a, MonadIO m) => a -> TerminalRestoreWindowCallback -> m SignalHandlerId Source #

Connect a signal handler for the “restore-window” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #restoreWindow callback

onTerminalRestoreWindow :: (IsTerminal a, MonadIO m) => a -> TerminalRestoreWindowCallback -> m SignalHandlerId Source #

Connect a signal handler for the “restore-window” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #restoreWindow callback

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 “selection-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #selectionChanged callback

onTerminalSelectionChanged :: (IsTerminal a, MonadIO m) => a -> TerminalSelectionChangedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “selection-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #selectionChanged callback

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 “text-deleted” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #textDeleted callback

onTerminalTextDeleted :: (IsTerminal a, MonadIO m) => a -> TerminalTextDeletedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “text-deleted” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #textDeleted callback

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 “text-inserted” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #textInserted callback

onTerminalTextInserted :: (IsTerminal a, MonadIO m) => a -> TerminalTextInsertedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “text-inserted” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #textInserted callback

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 “text-modified” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #textModified callback

onTerminalTextModified :: (IsTerminal a, MonadIO m) => a -> TerminalTextModifiedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “text-modified” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #textModified callback

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 “text-scrolled” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #textScrolled callback

onTerminalTextScrolled :: (IsTerminal a, MonadIO m) => a -> TerminalTextScrolledCallback -> m SignalHandlerId Source #

Connect a signal handler for the “text-scrolled” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #textScrolled callback

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 “window-title-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after terminal #windowTitleChanged callback

onTerminalWindowTitleChanged :: (IsTerminal a, MonadIO m) => a -> TerminalWindowTitleChangedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “window-title-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on terminal #windowTitleChanged callback