Safe Haskell	Safe-Inferred
Language	Haskell2010

Ribosome.Float

Description

Data types for floating window configuration.

Synopsis

data FloatOptions = FloatOptions {
- 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
}
newtype FloatZindex = FloatZindex {
- unFloatZindex :: Int
}
data FloatStyle = FloatStyleMinimal
data FloatBorder
- = None
- | Single
- | Double
- | Rounded
- | Solid
- | Shadow
- | Manual [Text]
data FloatAnchor
- = NW
- | NE
- | SW
- | SE
data FloatRelative
- = Editor
- | Win
- | Cursor

Documentation

data FloatOptions Source #

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

Instances details

Generic FloatOptions Source #
Instance details 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 Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods showsPrec :: Int -> FloatOptions -> ShowS # show :: FloatOptions -> String # showList :: [FloatOptions] -> ShowS #
Default FloatOptions Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods def :: FloatOptions #
Eq FloatOptions Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods (==) :: FloatOptions -> FloatOptions -> Bool # (/=) :: FloatOptions -> FloatOptions -> Bool #
MsgpackEncode FloatOptions Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods toMsgpack :: FloatOptions -> Object #
type Rep FloatOptions Source #
Instance details 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 Source #

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

Constructors

FloatZindex
Fields unFloatZindex :: Int

Instances

Instances details

Enum FloatZindex Source #
Instance details 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 Source #
Instance details 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 Source #
Instance details 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 Source #
Instance details 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 Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods toRational :: FloatZindex -> Rational #
Show FloatZindex Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods showsPrec :: Int -> FloatZindex -> ShowS # show :: FloatZindex -> String # showList :: [FloatZindex] -> ShowS #
Eq FloatZindex Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods (==) :: FloatZindex -> FloatZindex -> Bool # (/=) :: FloatZindex -> FloatZindex -> Bool #
Ord FloatZindex Source #
Instance details 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 Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods toMsgpack :: FloatZindex -> Object #
type Rep FloatZindex Source #
Instance details 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 Source #

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

Constructors

FloatStyleMinimal

Instances

Instances details

Show FloatStyle Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods showsPrec :: Int -> FloatStyle -> ShowS # show :: FloatStyle -> String # showList :: [FloatStyle] -> ShowS #
Default FloatStyle Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods def :: FloatStyle #
Eq FloatStyle Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods (==) :: FloatStyle -> FloatStyle -> Bool # (/=) :: FloatStyle -> FloatStyle -> Bool #
MsgpackEncode FloatStyle Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods toMsgpack :: FloatStyle -> Object #

data FloatBorder Source #

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

Instances details

Generic FloatBorder Source #
Instance details 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 Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods showsPrec :: Int -> FloatBorder -> ShowS # show :: FloatBorder -> String # showList :: [FloatBorder] -> ShowS #
Default FloatBorder Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods def :: FloatBorder #
Eq FloatBorder Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods (==) :: FloatBorder -> FloatBorder -> Bool # (/=) :: FloatBorder -> FloatBorder -> Bool #
MsgpackEncode FloatBorder Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods toMsgpack :: FloatBorder -> Object #
type Rep FloatBorder Source #
Instance details 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 Source #

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

Constructors

NW
NE
SW
SE

Instances

Instances details

Show FloatAnchor Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods showsPrec :: Int -> FloatAnchor -> ShowS # show :: FloatAnchor -> String # showList :: [FloatAnchor] -> ShowS #
Default FloatAnchor Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods def :: FloatAnchor #
Eq FloatAnchor Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods (==) :: FloatAnchor -> FloatAnchor -> Bool # (/=) :: FloatAnchor -> FloatAnchor -> Bool #
MsgpackEncode FloatAnchor Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods toMsgpack :: FloatAnchor -> Object #

data FloatRelative Source #

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

Constructors

Editor
Win
Cursor

Instances

Instances details

Show FloatRelative Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods showsPrec :: Int -> FloatRelative -> ShowS # show :: FloatRelative -> String # showList :: [FloatRelative] -> ShowS #
Default FloatRelative Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods def :: FloatRelative #
Eq FloatRelative Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods (==) :: FloatRelative -> FloatRelative -> Bool # (/=) :: FloatRelative -> FloatRelative -> Bool #
MsgpackEncode FloatRelative Source #
Instance details Defined in Ribosome.Data.FloatOptions Methods toMsgpack :: FloatRelative -> Object #