Ribosome.Float

Data types for floating window configuration.

Documentation

data FloatOptions

The set of options accepted by the float key of the argument to nvim_open_win, configuring the appearance and geometry of a floating window.

Constructors

FloatOptions

Fields

• relative :: FloatRelative
• width :: Int
• height :: Int
• row :: Int
• col :: Int
• focusable :: Bool
• anchor :: FloatAnchor
• bufpos :: Maybe (Int, Int)
• border :: FloatBorder
• noautocmd :: Bool
• enter :: Bool
• style :: Maybe FloatStyle
• zindex :: Maybe FloatZindex

Instances

Generic FloatOptions

Defined in Ribosome.Data.FloatOptions

Associated Types

type Rep FloatOptions :: Type -> Type

Methods

from :: FloatOptions -> Rep FloatOptions x

to :: Rep FloatOptions x -> FloatOptions

Show FloatOptions

Defined in Ribosome.Data.FloatOptions

Methods

showsPrec :: Int -> FloatOptions -> ShowS

show :: FloatOptions -> String

showList :: [FloatOptions] -> ShowS

Default FloatOptions

Defined in Ribosome.Data.FloatOptions

Methods

def :: FloatOptions

Eq FloatOptions

Defined in Ribosome.Data.FloatOptions

Methods

(==) :: FloatOptions -> FloatOptions -> Bool

(/=) :: FloatOptions -> FloatOptions -> Bool

MsgpackEncode FloatOptions

Defined in Ribosome.Data.FloatOptions

Methods

toMsgpack :: FloatOptions -> Object

type Rep FloatOptions

Defined in Ribosome.Data.FloatOptions

type Rep FloatOptions = D1 ('MetaData "FloatOptions" "Ribosome.Data.FloatOptions" "ribosome-0.9.9.9-9qviHqnn5IlBIAvGWfH18d" 'False) (C1 ('MetaCons "FloatOptions" 'PrefixI 'True) (((S1 ('MetaSel ('Just "relative") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FloatRelative) :*: (S1 ('MetaSel ('Just "width") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) :*: (S1 ('MetaSel ('Just "row") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: (S1 ('MetaSel ('Just "col") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "focusable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)))) :*: ((S1 ('MetaSel ('Just "anchor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FloatAnchor) :*: (S1 ('MetaSel ('Just "bufpos") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Int, Int))) :*: S1 ('MetaSel ('Just "border") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FloatBorder))) :*: ((S1 ('MetaSel ('Just "noautocmd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "enter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "style") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FloatStyle)) :*: S1 ('MetaSel ('Just "zindex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FloatZindex)))))))

newtype FloatZindex

The z-index of a floating window, determining occlusion.

Constructors

FloatZindex

Fields

• unFloatZindex :: Int

Instances

Enum FloatZindex

Defined in Ribosome.Data.FloatOptions

Methods

succ :: FloatZindex -> FloatZindex

pred :: FloatZindex -> FloatZindex

toEnum :: Int -> FloatZindex

fromEnum :: FloatZindex -> Int

enumFrom :: FloatZindex -> [FloatZindex]

enumFromThen :: FloatZindex -> FloatZindex -> [FloatZindex]

enumFromTo :: FloatZindex -> FloatZindex -> [FloatZindex]

enumFromThenTo :: FloatZindex -> FloatZindex -> FloatZindex -> [FloatZindex]

Generic FloatZindex

Defined in Ribosome.Data.FloatOptions

Associated Types

type Rep FloatZindex :: Type -> Type

Methods

from :: FloatZindex -> Rep FloatZindex x

to :: Rep FloatZindex x -> FloatZindex

Num FloatZindex

Defined in Ribosome.Data.FloatOptions

Methods

(+) :: FloatZindex -> FloatZindex -> FloatZindex

(-) :: FloatZindex -> FloatZindex -> FloatZindex

(*) :: FloatZindex -> FloatZindex -> FloatZindex

negate :: FloatZindex -> FloatZindex

abs :: FloatZindex -> FloatZindex

signum :: FloatZindex -> FloatZindex

fromInteger :: Integer -> FloatZindex

Integral FloatZindex

Defined in Ribosome.Data.FloatOptions

Methods

quot :: FloatZindex -> FloatZindex -> FloatZindex

rem :: FloatZindex -> FloatZindex -> FloatZindex

div :: FloatZindex -> FloatZindex -> FloatZindex

mod :: FloatZindex -> FloatZindex -> FloatZindex

quotRem :: FloatZindex -> FloatZindex -> (FloatZindex, FloatZindex)

divMod :: FloatZindex -> FloatZindex -> (FloatZindex, FloatZindex)

toInteger :: FloatZindex -> Integer

Real FloatZindex

Defined in Ribosome.Data.FloatOptions

Methods

toRational :: FloatZindex -> Rational

Show FloatZindex

Defined in Ribosome.Data.FloatOptions

Methods

showsPrec :: Int -> FloatZindex -> ShowS

show :: FloatZindex -> String

showList :: [FloatZindex] -> ShowS

Eq FloatZindex

Defined in Ribosome.Data.FloatOptions

Methods

(==) :: FloatZindex -> FloatZindex -> Bool

(/=) :: FloatZindex -> FloatZindex -> Bool

Ord FloatZindex

Defined in Ribosome.Data.FloatOptions

Methods

compare :: FloatZindex -> FloatZindex -> Ordering

(<) :: FloatZindex -> FloatZindex -> Bool

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

(>) :: FloatZindex -> FloatZindex -> Bool

(>=) :: FloatZindex -> FloatZindex -> Bool

max :: FloatZindex -> FloatZindex -> FloatZindex

min :: FloatZindex -> FloatZindex -> FloatZindex

MsgpackEncode FloatZindex

Defined in Ribosome.Data.FloatOptions

Methods

toMsgpack :: FloatZindex -> Object

type Rep FloatZindex

Defined in Ribosome.Data.FloatOptions

type Rep FloatZindex = D1 ('MetaData "FloatZindex" "Ribosome.Data.FloatOptions" "ribosome-0.9.9.9-9qviHqnn5IlBIAvGWfH18d" 'True) (C1 ('MetaCons "FloatZindex" 'PrefixI 'True) (S1 ('MetaSel ('Just "unFloatZindex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

data FloatStyle

Neovim has a style option for floating windows that sets a few options in bulk, with only one possible value.

Constructors

FloatStyleMinimal

Instances

Show FloatStyle

Defined in Ribosome.Data.FloatOptions

Methods

showsPrec :: Int -> FloatStyle -> ShowS

show :: FloatStyle -> String

showList :: [FloatStyle] -> ShowS

Default FloatStyle

Defined in Ribosome.Data.FloatOptions

Methods

def :: FloatStyle

Eq FloatStyle

Defined in Ribosome.Data.FloatOptions

Methods

(==) :: FloatStyle -> FloatStyle -> Bool

(/=) :: FloatStyle -> FloatStyle -> Bool

MsgpackEncode FloatStyle

Defined in Ribosome.Data.FloatOptions

Methods

toMsgpack :: FloatStyle -> Object

data FloatBorder

The border style of a floating window.

Constructors

None

Single

Double

Rounded

Solid

Shadow

Manual [Text]

A list of characters that is drawn for the border, starting with the top left corner, going clockwise, repeating if too short.

Instances

Generic FloatBorder

Defined in Ribosome.Data.FloatOptions

Associated Types

type Rep FloatBorder :: Type -> Type

Methods

from :: FloatBorder -> Rep FloatBorder x

to :: Rep FloatBorder x -> FloatBorder

Show FloatBorder

Defined in Ribosome.Data.FloatOptions

Methods

showsPrec :: Int -> FloatBorder -> ShowS

show :: FloatBorder -> String

showList :: [FloatBorder] -> ShowS

Default FloatBorder

Defined in Ribosome.Data.FloatOptions

Methods

def :: FloatBorder

Eq FloatBorder

Defined in Ribosome.Data.FloatOptions

Methods

(==) :: FloatBorder -> FloatBorder -> Bool

(/=) :: FloatBorder -> FloatBorder -> Bool

MsgpackEncode FloatBorder

Defined in Ribosome.Data.FloatOptions

Methods

toMsgpack :: FloatBorder -> Object

type Rep FloatBorder

Defined in Ribosome.Data.FloatOptions

type Rep FloatBorder = D1 ('MetaData "FloatBorder" "Ribosome.Data.FloatOptions" "ribosome-0.9.9.9-9qviHqnn5IlBIAvGWfH18d" 'False) ((C1 ('MetaCons "None" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Single" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Double" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Rounded" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Solid" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Shadow" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Manual" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))))

data FloatAnchor

The corner of a floating window that is positioned at the specified coordinates.

Constructors

NW

NE

SW

SE

Instances

Show FloatAnchor

Defined in Ribosome.Data.FloatOptions

Methods

showsPrec :: Int -> FloatAnchor -> ShowS

show :: FloatAnchor -> String

showList :: [FloatAnchor] -> ShowS

Default FloatAnchor

Defined in Ribosome.Data.FloatOptions

Methods

def :: FloatAnchor

Eq FloatAnchor

Defined in Ribosome.Data.FloatOptions

Methods

(==) :: FloatAnchor -> FloatAnchor -> Bool

(/=) :: FloatAnchor -> FloatAnchor -> Bool

MsgpackEncode FloatAnchor

Defined in Ribosome.Data.FloatOptions

Methods

toMsgpack :: FloatAnchor -> Object

data FloatRelative

The reference point to which a floating window's position is defined.

Constructors

Editor

Win

Cursor

Instances

Show FloatRelative

Defined in Ribosome.Data.FloatOptions

Methods

showsPrec :: Int -> FloatRelative -> ShowS

show :: FloatRelative -> String

showList :: [FloatRelative] -> ShowS

Default FloatRelative

Defined in Ribosome.Data.FloatOptions

Methods

def :: FloatRelative

Eq FloatRelative

Defined in Ribosome.Data.FloatOptions

Methods

(==) :: FloatRelative -> FloatRelative -> Bool

(/=) :: FloatRelative -> FloatRelative -> Bool

MsgpackEncode FloatRelative

Defined in Ribosome.Data.FloatOptions

Methods

toMsgpack :: FloatRelative -> Object