gi-vte-2.91.27: Vte bindings

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

GI.Vte.Enums

Contents

- Enumerations
  - CursorBlinkMode
  - CursorShape
  - EraseBinding
  - Format
  - PtyError
  - RegexError
  - TextBlinkMode
  - WriteFlags

Description

Synopsis

- data CursorBlinkMode
  - = CursorBlinkModeSystem
  - | CursorBlinkModeOn
  - | CursorBlinkModeOff
  - | AnotherCursorBlinkMode Int
- data CursorShape
  - = CursorShapeBlock
  - | CursorShapeIbeam
  - | CursorShapeUnderline
  - | AnotherCursorShape Int
- data EraseBinding
  - = EraseBindingAuto
  - | EraseBindingAsciiBackspace
  - | EraseBindingAsciiDelete
  - | EraseBindingDeleteSequence
  - | EraseBindingTty
  - | AnotherEraseBinding Int
- data Format
  - = FormatText
  - | FormatHtml
  - | AnotherFormat Int
- data PtyError
  - = PtyErrorPtyHelperFailed
  - | PtyErrorPty98Failed
  - | AnotherPtyError Int
- catchPtyError :: IO a -> (PtyError -> GErrorMessage -> IO a) -> IO a
- handlePtyError :: (PtyError -> GErrorMessage -> IO a) -> IO a -> IO a
- data RegexError
  - = RegexErrorIncompatible
  - | RegexErrorNotSupported
  - | AnotherRegexError Int
- catchRegexError :: IO a -> (RegexError -> GErrorMessage -> IO a) -> IO a
- handleRegexError :: (RegexError -> GErrorMessage -> IO a) -> IO a -> IO a
- data TextBlinkMode
  - = TextBlinkModeNever
  - | TextBlinkModeFocused
  - | TextBlinkModeUnfocused
  - | TextBlinkModeAlways
  - | AnotherTextBlinkMode Int
- data WriteFlags
  - = WriteFlagsDefault
  - | AnotherWriteFlags Int

# Enumerations

## CursorBlinkMode

data CursorBlinkMode Source #

An enumerated type which can be used to indicate the cursor blink mode for the terminal.

Constructors

CursorBlinkModeSystem | Follow GTK+ settings for cursor blinking.
CursorBlinkModeOn | Cursor blinks.
CursorBlinkModeOff | Cursor does not blink.
AnotherCursorBlinkMode Int | Catch-all for unknown values

#### Instances

Instances details

Enum CursorBlinkMode Source # |

Instance details

Defined in GI.Vte.Enums

Methods

succ :: CursorBlinkMode -> CursorBlinkMode

pred :: CursorBlinkMode -> CursorBlinkMode

toEnum :: Int -> CursorBlinkMode #

fromEnum :: CursorBlinkMode -> Int #

enumFrom :: CursorBlinkMode -> [CursorBlinkMode]

enumFromThen :: CursorBlinkMode -> CursorBlinkMode -> [CursorBlinkMode]

enumFromTo :: CursorBlinkMode -> CursorBlinkMode -> [CursorBlinkMode]

enumFromThenTo :: CursorBlinkMode -> CursorBlinkMode -> CursorBlinkMode -> [CursorBlinkMode]

Eq CursorBlinkMode Source # |
Instance details Defined in GI.Vte.Enums Methods (==) :: CursorBlinkMode -> CursorBlinkMode -> Bool # (/=) :: CursorBlinkMode -> CursorBlinkMode -> Bool #
Ord CursorBlinkMode Source # |

Instance details

Defined in GI.Vte.Enums

Methods

compare :: CursorBlinkMode -> CursorBlinkMode -> Ordering

(<) :: CursorBlinkMode -> CursorBlinkMode -> Bool

(<=) :: CursorBlinkMode -> CursorBlinkMode -> Bool

(>) :: CursorBlinkMode -> CursorBlinkMode -> Bool

(>=) :: CursorBlinkMode -> CursorBlinkMode -> Bool

max :: CursorBlinkMode -> CursorBlinkMode -> CursorBlinkMode

min :: CursorBlinkMode -> CursorBlinkMode -> CursorBlinkMode

Show CursorBlinkMode Source # |
Instance details Defined in GI.Vte.Enums Methods showsPrec :: Int -> CursorBlinkMode -> ShowS # show :: CursorBlinkMode -> String # showList :: [CursorBlinkMode] -> ShowS #
TypedObject CursorBlinkMode Source # |
Instance details Defined in GI.Vte.Enums Methods glibType :: IO GType Source #
BoxedEnum CursorBlinkMode Source # |
Instance details Defined in GI.Vte.Enums
HasParentTypes CursorBlinkMode Source # |
Instance details Defined in GI.Vte.Enums
type ParentTypes CursorBlinkMode Source # |
Instance details Defined in GI.Vte.Enums type ParentTypes CursorBlinkMode = '[] :: [Type]

## CursorShape

data CursorShape Source #

An enumerated type which can be used to indicate what should the terminal draw at the cursor position.

Constructors

CursorShapeBlock | Draw a block cursor. This is the default.
CursorShapeIbeam | Draw a vertical bar on the left side of character. This is similar to the default cursor for other GTK+ widgets.
CursorShapeUnderline | Draw a horizontal bar below the character.
AnotherCursorShape Int | Catch-all for unknown values

#### Instances

Instances details

Enum CursorShape Source # |

Instance details

Defined in GI.Vte.Enums

Methods

succ :: CursorShape -> CursorShape

pred :: CursorShape -> CursorShape

toEnum :: Int -> CursorShape #

fromEnum :: CursorShape -> Int #

enumFrom :: CursorShape -> [CursorShape]

enumFromThen :: CursorShape -> CursorShape -> [CursorShape]

enumFromTo :: CursorShape -> CursorShape -> [CursorShape]

enumFromThenTo :: CursorShape -> CursorShape -> CursorShape -> [CursorShape]

Eq CursorShape Source # |
Instance details Defined in GI.Vte.Enums Methods (==) :: CursorShape -> CursorShape -> Bool # (/=) :: CursorShape -> CursorShape -> Bool #
Ord CursorShape Source # |
Instance details Defined in GI.Vte.Enums Methods compare :: CursorShape -> CursorShape -> Ordering (<) :: CursorShape -> CursorShape -> Bool (<=) :: CursorShape -> CursorShape -> Bool (>) :: CursorShape -> CursorShape -> Bool (>=) :: CursorShape -> CursorShape -> Bool max :: CursorShape -> CursorShape -> CursorShape min :: CursorShape -> CursorShape -> CursorShape
Show CursorShape Source # |
Instance details Defined in GI.Vte.Enums Methods showsPrec :: Int -> CursorShape -> ShowS # show :: CursorShape -> String # showList :: [CursorShape] -> ShowS #
TypedObject CursorShape Source # |
Instance details Defined in GI.Vte.Enums Methods glibType :: IO GType Source #
BoxedEnum CursorShape Source # |
Instance details Defined in GI.Vte.Enums
HasParentTypes CursorShape Source # |
Instance details Defined in GI.Vte.Enums
type ParentTypes CursorShape Source # |
Instance details Defined in GI.Vte.Enums type ParentTypes CursorShape = '[] :: [Type]

## EraseBinding

data EraseBinding Source #

An enumerated type which can be used to indicate which string the terminal should send to an application when the user presses the Delete or Backspace keys.

Constructors

EraseBindingAuto | For backspace, attempt to determine the right value from the terminal's IO settings. For delete, use the control sequence.
EraseBindingAsciiBackspace | Send an ASCII backspace character (0x08).
EraseBindingAsciiDelete | Send an ASCII delete character (0x7F).
EraseBindingDeleteSequence | Send the "@`7`" control sequence.
EraseBindingTty | Send terminal's "erase" setting.
AnotherEraseBinding Int | Catch-all for unknown values

#### Instances

Instances details

Enum EraseBinding Source # |

Instance details

Defined in GI.Vte.Enums

Methods

succ :: EraseBinding -> EraseBinding

pred :: EraseBinding -> EraseBinding

toEnum :: Int -> EraseBinding #

fromEnum :: EraseBinding -> Int #

enumFrom :: EraseBinding -> [EraseBinding]

enumFromThen :: EraseBinding -> EraseBinding -> [EraseBinding]

enumFromTo :: EraseBinding -> EraseBinding -> [EraseBinding]

enumFromThenTo :: EraseBinding -> EraseBinding -> EraseBinding -> [EraseBinding]

Eq EraseBinding Source # |
Instance details Defined in GI.Vte.Enums Methods (==) :: EraseBinding -> EraseBinding -> Bool # (/=) :: EraseBinding -> EraseBinding -> Bool #
Ord EraseBinding Source # |
Instance details Defined in GI.Vte.Enums Methods compare :: EraseBinding -> EraseBinding -> Ordering (<) :: EraseBinding -> EraseBinding -> Bool (<=) :: EraseBinding -> EraseBinding -> Bool (>) :: EraseBinding -> EraseBinding -> Bool (>=) :: EraseBinding -> EraseBinding -> Bool max :: EraseBinding -> EraseBinding -> EraseBinding min :: EraseBinding -> EraseBinding -> EraseBinding
Show EraseBinding Source # |
Instance details Defined in GI.Vte.Enums Methods showsPrec :: Int -> EraseBinding -> ShowS # show :: EraseBinding -> String # showList :: [EraseBinding] -> ShowS #
TypedObject EraseBinding Source # |
Instance details Defined in GI.Vte.Enums Methods glibType :: IO GType Source #
BoxedEnum EraseBinding Source # |
Instance details Defined in GI.Vte.Enums
HasParentTypes EraseBinding Source # |
Instance details Defined in GI.Vte.Enums
type ParentTypes EraseBinding Source # |
Instance details Defined in GI.Vte.Enums type ParentTypes EraseBinding = '[] :: [Type]

## Format

data Format Source #

An enumeration type that can be used to specify the format the selection should be copied to the clipboard in.

Since: 0.50

Constructors

FormatText | Export as plain text
FormatHtml | Export as HTML formatted text
AnotherFormat Int | Catch-all for unknown values

#### Instances

Instances details

Enum Format Source # |
Instance details Defined in GI.Vte.Enums Methods succ :: Format -> Format pred :: Format -> Format toEnum :: Int -> Format # fromEnum :: Format -> Int # enumFrom :: Format -> [Format] enumFromThen :: Format -> Format -> [Format] enumFromTo :: Format -> Format -> [Format] enumFromThenTo :: Format -> Format -> Format -> [Format]
Eq Format Source # |
Instance details Defined in GI.Vte.Enums Methods (==) :: Format -> Format -> Bool # (/=) :: Format -> Format -> Bool #
Ord Format Source # |
Instance details Defined in GI.Vte.Enums Methods compare :: Format -> Format -> Ordering (<) :: Format -> Format -> Bool (<=) :: Format -> Format -> Bool (>) :: Format -> Format -> Bool (>=) :: Format -> Format -> Bool max :: Format -> Format -> Format min :: Format -> Format -> Format
Show Format Source # |
Instance details Defined in GI.Vte.Enums Methods showsPrec :: Int -> Format -> ShowS # show :: Format -> String # showList :: [Format] -> ShowS #
TypedObject Format Source # |
Instance details Defined in GI.Vte.Enums Methods glibType :: IO GType Source #
BoxedEnum Format Source # |
Instance details Defined in GI.Vte.Enums
HasParentTypes Format Source # |
Instance details Defined in GI.Vte.Enums
type ParentTypes Format Source # |
Instance details Defined in GI.Vte.Enums type ParentTypes Format = '[] :: [Type]

## PtyError

data PtyError Source #

No description available in the introspection data.

Constructors

PtyErrorPtyHelperFailed | Obsolete. Deprecated: 0.42
PtyErrorPty98Failed | failure when using PTY98 to allocate the PTY
AnotherPtyError Int | Catch-all for unknown values

#### Instances

Instances details

Enum PtyError Source # |
Instance details Defined in GI.Vte.Enums Methods succ :: PtyError -> PtyError pred :: PtyError -> PtyError toEnum :: Int -> PtyError # fromEnum :: PtyError -> Int # enumFrom :: PtyError -> [PtyError] enumFromThen :: PtyError -> PtyError -> [PtyError] enumFromTo :: PtyError -> PtyError -> [PtyError] enumFromThenTo :: PtyError -> PtyError -> PtyError -> [PtyError]
Eq PtyError Source # |
Instance details Defined in GI.Vte.Enums Methods (==) :: PtyError -> PtyError -> Bool # (/=) :: PtyError -> PtyError -> Bool #
Ord PtyError Source # |
Instance details Defined in GI.Vte.Enums Methods compare :: PtyError -> PtyError -> Ordering (<) :: PtyError -> PtyError -> Bool (<=) :: PtyError -> PtyError -> Bool (>) :: PtyError -> PtyError -> Bool (>=) :: PtyError -> PtyError -> Bool max :: PtyError -> PtyError -> PtyError min :: PtyError -> PtyError -> PtyError
Show PtyError Source # |
Instance details Defined in GI.Vte.Enums Methods showsPrec :: Int -> PtyError -> ShowS # show :: PtyError -> String # showList :: [PtyError] -> ShowS #
GErrorClass PtyError Source # |
Instance details Defined in GI.Vte.Enums Methods gerrorClassDomain :: PtyError -> Text Source #
TypedObject PtyError Source # |
Instance details Defined in GI.Vte.Enums Methods glibType :: IO GType Source #
BoxedEnum PtyError Source # |
Instance details Defined in GI.Vte.Enums
HasParentTypes PtyError Source # |
Instance details Defined in GI.Vte.Enums
type ParentTypes PtyError Source # |
Instance details Defined in GI.Vte.Enums type ParentTypes PtyError = '[] :: [Type]

catchPtyError :: IO a -> (PtyError -> GErrorMessage -> IO a) -> IO a Source #

Catch exceptions of type `PtyError`. This is a specialized version of `catchGErrorJustDomain`.

handlePtyError :: (PtyError -> GErrorMessage -> IO a) -> IO a -> IO a Source #

Handle exceptions of type `PtyError`. This is a specialized version of `handleGErrorJustDomain`.

## RegexError

data RegexError Source #

An enum type for regex errors. In addition to the values listed above, any PCRE2 error values may occur.

Since: 0.46

Constructors

RegexErrorIncompatible | The PCRE2 library was built without Unicode support which is required for VTE
RegexErrorNotSupported | Regexes are not supported because VTE was built without PCRE2 support
AnotherRegexError Int | Catch-all for unknown values

#### Instances

Instances details

Enum RegexError Source # |
Instance details Defined in GI.Vte.Enums Methods succ :: RegexError -> RegexError pred :: RegexError -> RegexError toEnum :: Int -> RegexError # fromEnum :: RegexError -> Int # enumFrom :: RegexError -> [RegexError] enumFromThen :: RegexError -> RegexError -> [RegexError] enumFromTo :: RegexError -> RegexError -> [RegexError] enumFromThenTo :: RegexError -> RegexError -> RegexError -> [RegexError]
Eq RegexError Source # |
Instance details Defined in GI.Vte.Enums Methods (==) :: RegexError -> RegexError -> Bool # (/=) :: RegexError -> RegexError -> Bool #
Ord RegexError Source # |
Instance details Defined in GI.Vte.Enums Methods compare :: RegexError -> RegexError -> Ordering (<) :: RegexError -> RegexError -> Bool (<=) :: RegexError -> RegexError -> Bool (>) :: RegexError -> RegexError -> Bool (>=) :: RegexError -> RegexError -> Bool max :: RegexError -> RegexError -> RegexError min :: RegexError -> RegexError -> RegexError
Show RegexError Source # |
Instance details Defined in GI.Vte.Enums Methods showsPrec :: Int -> RegexError -> ShowS # show :: RegexError -> String # showList :: [RegexError] -> ShowS #
GErrorClass RegexError Source # |
Instance details Defined in GI.Vte.Enums Methods gerrorClassDomain :: RegexError -> Text Source #
TypedObject RegexError Source # |
Instance details Defined in GI.Vte.Enums Methods glibType :: IO GType Source #
BoxedEnum RegexError Source # |
Instance details Defined in GI.Vte.Enums
HasParentTypes RegexError Source # |
Instance details Defined in GI.Vte.Enums
type ParentTypes RegexError Source # |
Instance details Defined in GI.Vte.Enums type ParentTypes RegexError = '[] :: [Type]

catchRegexError :: IO a -> (RegexError -> GErrorMessage -> IO a) -> IO a Source #

Catch exceptions of type `RegexError`. This is a specialized version of `catchGErrorJustDomain`.

handleRegexError :: (RegexError -> GErrorMessage -> IO a) -> IO a -> IO a Source #

Handle exceptions of type `RegexError`. This is a specialized version of `handleGErrorJustDomain`.

## TextBlinkMode

data TextBlinkMode Source #

An enumerated type which can be used to indicate whether the terminal allows the text contents to be blinked.

Since: 0.52

Constructors

TextBlinkModeNever | Do not blink the text.
TextBlinkModeFocused | Allow blinking text only if the terminal is focused.
TextBlinkModeUnfocused | Allow blinking text only if the terminal is unfocused.
TextBlinkModeAlways | Allow blinking text. This is the default.
AnotherTextBlinkMode Int | Catch-all for unknown values

#### Instances

Instances details

Enum TextBlinkMode Source # |

Instance details

Defined in GI.Vte.Enums

Methods

succ :: TextBlinkMode -> TextBlinkMode

pred :: TextBlinkMode -> TextBlinkMode

toEnum :: Int -> TextBlinkMode #

fromEnum :: TextBlinkMode -> Int #

enumFrom :: TextBlinkMode -> [TextBlinkMode]

enumFromThen :: TextBlinkMode -> TextBlinkMode -> [TextBlinkMode]

enumFromTo :: TextBlinkMode -> TextBlinkMode -> [TextBlinkMode]

enumFromThenTo :: TextBlinkMode -> TextBlinkMode -> TextBlinkMode -> [TextBlinkMode]

Eq TextBlinkMode Source # |
Instance details Defined in GI.Vte.Enums Methods (==) :: TextBlinkMode -> TextBlinkMode -> Bool # (/=) :: TextBlinkMode -> TextBlinkMode -> Bool #
Ord TextBlinkMode Source # |
Instance details Defined in GI.Vte.Enums Methods compare :: TextBlinkMode -> TextBlinkMode -> Ordering (<) :: TextBlinkMode -> TextBlinkMode -> Bool (<=) :: TextBlinkMode -> TextBlinkMode -> Bool (>) :: TextBlinkMode -> TextBlinkMode -> Bool (>=) :: TextBlinkMode -> TextBlinkMode -> Bool max :: TextBlinkMode -> TextBlinkMode -> TextBlinkMode min :: TextBlinkMode -> TextBlinkMode -> TextBlinkMode
Show TextBlinkMode Source # |
Instance details Defined in GI.Vte.Enums Methods showsPrec :: Int -> TextBlinkMode -> ShowS # show :: TextBlinkMode -> String # showList :: [TextBlinkMode] -> ShowS #
TypedObject TextBlinkMode Source # |
Instance details Defined in GI.Vte.Enums Methods glibType :: IO GType Source #
BoxedEnum TextBlinkMode Source # |
Instance details Defined in GI.Vte.Enums
HasParentTypes TextBlinkMode Source # |
Instance details Defined in GI.Vte.Enums
type ParentTypes TextBlinkMode Source # |
Instance details Defined in GI.Vte.Enums type ParentTypes TextBlinkMode = '[] :: [Type]

## WriteFlags

data WriteFlags Source #

A flag type to determine how terminal contents should be written to an output stream.

Constructors

WriteFlagsDefault | Write contents as UTF-8 text. This is the default.
AnotherWriteFlags Int | Catch-all for unknown values

#### Instances

Instances details

Enum WriteFlags Source # |
Instance details Defined in GI.Vte.Enums Methods succ :: WriteFlags -> WriteFlags pred :: WriteFlags -> WriteFlags toEnum :: Int -> WriteFlags # fromEnum :: WriteFlags -> Int # enumFrom :: WriteFlags -> [WriteFlags] enumFromThen :: WriteFlags -> WriteFlags -> [WriteFlags] enumFromTo :: WriteFlags -> WriteFlags -> [WriteFlags] enumFromThenTo :: WriteFlags -> WriteFlags -> WriteFlags -> [WriteFlags]
Eq WriteFlags Source # |
Instance details Defined in GI.Vte.Enums Methods (==) :: WriteFlags -> WriteFlags -> Bool # (/=) :: WriteFlags -> WriteFlags -> Bool #
Ord WriteFlags Source # |
Instance details Defined in GI.Vte.Enums Methods compare :: WriteFlags -> WriteFlags -> Ordering (<) :: WriteFlags -> WriteFlags -> Bool (<=) :: WriteFlags -> WriteFlags -> Bool (>) :: WriteFlags -> WriteFlags -> Bool (>=) :: WriteFlags -> WriteFlags -> Bool max :: WriteFlags -> WriteFlags -> WriteFlags min :: WriteFlags -> WriteFlags -> WriteFlags
Show WriteFlags Source # |
Instance details Defined in GI.Vte.Enums Methods showsPrec :: Int -> WriteFlags -> ShowS # show :: WriteFlags -> String # showList :: [WriteFlags] -> ShowS #
TypedObject WriteFlags Source # |
Instance details Defined in GI.Vte.Enums Methods glibType :: IO GType Source #
BoxedEnum WriteFlags Source # |
Instance details Defined in GI.Vte.Enums
HasParentTypes WriteFlags Source # |
Instance details Defined in GI.Vte.Enums
type ParentTypes WriteFlags Source # |
Instance details Defined in GI.Vte.Enums type ParentTypes WriteFlags = '[] :: [Type]