Rasa.Ext.Views.Internal.Views

Documentation

rotate :: Window -> Window

Flip all Horizontal splits to Vertical ones and vice versa.

splitRule :: Lens' Split SplitRule

active :: Lens' View Bool

viewable :: Lens' View Viewable

scrollPos :: Lens' View Int

closeBy :: (View -> Bool) -> Window -> Maybe Window

Close any views which match a given predicate

focusViewLeft :: Window -> Window

Move focus from any viewports one viewport to the left

focusViewRight :: Window -> Window

Move focus from any viewports one viewport to the right

focusViewAbove :: Window -> Window

Move focus from any viewports one viewport above

focusViewBelow :: Window -> Window

Move focus from any viewports one viewport below

getViews :: App (Maybe Window)

Gets the stored views

setViews :: Maybe Window -> App ()

Sets the stored views

overWindows :: (Window -> Window) -> App ()

Run function over stored windows

hSplit :: Window -> Window

Split active views horizontally

vSplit :: Window -> Window

Split active views vertically

addSplit :: Dir -> Viewable -> Window -> Window

Add a new split at the top level in the given direction containing the given buffer.

scrollBy :: Int -> Window -> Window

Scroll all active viewports by the given amount.

data Dir

• Hor denotes a horizontal split.
• Vert denotes a vertical split.

Constructors

Hor

Vert

Instances

Show Dir

Methods

showsPrec :: Int -> Dir -> ShowS

show :: Dir -> String

showList :: [Dir] -> ShowS

Default Dir

Methods

def :: Dir

data SplitRule

A SplitRule determines size of each half of the split.

• Ratio Double sets the split to the given ratio; the double must be between 0 and 1; for example a value of 0.25 sets the first portion of the split to 1/4 of the available space; the other portion takes the remaining 3/4 of the space
• FromStart Int makes the first half of the split (top/left respectively) the set number of rows or columns respectively, the other half of the split gets the rest.
• FromEnd Int makes the first half of the split (top/left respectively) the set number of rows or columns respectively, the other half of the split gets the rest.

Constructors

Ratio Double

FromStart Int

FromEnd Int

Instances

Show SplitRule

Methods

showsPrec :: Int -> SplitRule -> ShowS

show :: SplitRule -> String

showList :: [SplitRule] -> ShowS

Default SplitRule

Methods

def :: SplitRule

type Window = BiTree Split View

A tree of windows branched with splits.

data Split

A Split contains info about a the direction and allocation of a split branch.

Constructors

Split

Fields

• _dir :: Dir
• _splitRule :: SplitRule

Instances

Show Split

Methods

showsPrec :: Int -> Split -> ShowS

show :: Split -> String

showList :: [Split] -> ShowS

Default Split

Methods

def :: Split

data View

A View contains info about a viewport; Whether it's selected and which buffer should be displayed.

Constructors

View

Fields

• _active :: Bool
• _viewable :: Viewable
• _scrollPos :: Int

Instances

HasWidgets View

This represents types which can provide a set of widgets

Methods

computeWidgets :: View -> App Widgets

data Viewable

Represents a renderable entity

Constructors

BufView BufRef

EmptyView

Instances

Renderable Viewable

Methods

render :: Width -> Height -> ScrollPos -> Viewable -> App (Maybe RenderInfo)

_BufViewRef :: Prism' Viewable BufRef

Prism BufView to its bufref

traverseViews :: (View -> App View) -> App ()

Alters views by a given function.