Reflex.Vty.Widget.Layout

Documentation

data Orientation

The main-axis orientation of a Layout widget

Constructors

Orientation_Column

Orientation_Row

Instances

Eq Orientation

Defined in Reflex.Vty.Widget.Layout

Methods

(==) :: Orientation -> Orientation -> Bool

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

Ord Orientation

Defined in Reflex.Vty.Widget.Layout

Methods

compare :: Orientation -> Orientation -> Ordering

(<) :: Orientation -> Orientation -> Bool

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

(>) :: Orientation -> Orientation -> Bool

(>=) :: Orientation -> Orientation -> Bool

max :: Orientation -> Orientation -> Orientation

min :: Orientation -> Orientation -> Orientation

Read Orientation

Defined in Reflex.Vty.Widget.Layout

Methods

readsPrec :: Int -> ReadS Orientation

readList :: ReadS [Orientation]

readPrec :: ReadPrec Orientation

readListPrec :: ReadPrec [Orientation]

Show Orientation

Defined in Reflex.Vty.Widget.Layout

Methods

showsPrec :: Int -> Orientation -> ShowS

show :: Orientation -> String

showList :: [Orientation] -> ShowS

data Constraint

Datatype representing constraints on a widget's size along the main axis (see Orientation)

Constructors

Constraint_Fixed Int

Constraint_Min Int

Instances

Eq Constraint

Defined in Reflex.Vty.Widget.Layout

Methods

(==) :: Constraint -> Constraint -> Bool

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

Ord Constraint

Defined in Reflex.Vty.Widget.Layout

Methods

compare :: Constraint -> Constraint -> Ordering

(<) :: Constraint -> Constraint -> Bool

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

(>) :: Constraint -> Constraint -> Bool

(>=) :: Constraint -> Constraint -> Bool

max :: Constraint -> Constraint -> Constraint

min :: Constraint -> Constraint -> Constraint

Read Constraint

Defined in Reflex.Vty.Widget.Layout

Methods

readsPrec :: Int -> ReadS Constraint

readList :: ReadS [Constraint]

readPrec :: ReadPrec Constraint

readListPrec :: ReadPrec [Constraint]

Show Constraint

Defined in Reflex.Vty.Widget.Layout

Methods

showsPrec :: Int -> Constraint -> ShowS

show :: Constraint -> String

showList :: [Constraint] -> ShowS

data Layout t m a

The Layout monad transformer keeps track of the configuration (e.g., Orientation) and Constraints of its child widgets, apportions vty real estate to each, and acts as a switchboard for focus requests. See tile and runLayout.

Instances

NotReady t m => NotReady t (Layout t m)

Defined in Reflex.Vty.Widget.Layout

Methods

notReadyUntil :: Event t a -> Layout t m ()

notReady :: Layout t m ()

PerformEvent t m => PerformEvent t (Layout t m)

Defined in Reflex.Vty.Widget.Layout

Associated Types

type Performable (Layout t m) :: Type -> Type

Methods

performEvent :: Event t (Performable (Layout t m) a) -> Layout t m (Event t a)

performEvent_ :: Event t (Performable (Layout t m) ()) -> Layout t m ()

TriggerEvent t m => TriggerEvent t (Layout t m)

Defined in Reflex.Vty.Widget.Layout

Methods

newTriggerEvent :: Layout t m (Event t a, a -> IO ())

newTriggerEventWithOnComplete :: Layout t m (Event t a, a -> IO () -> IO ())

newEventWithLazyTriggerWithOnComplete :: ((a -> IO () -> IO ()) -> IO (IO ())) -> Layout t m (Event t a)

(Adjustable t m, MonadFix m, MonadHold t m) => Adjustable t (Layout t m)

Defined in Reflex.Vty.Widget.Layout

Methods

runWithReplace :: Layout t m a -> Event t (Layout t m b) -> Layout t m (a, Event t b)

traverseIntMapWithKeyWithAdjust :: (Key -> v -> Layout t m v') -> IntMap v -> Event t (PatchIntMap v) -> Layout t m (IntMap v', Event t (PatchIntMap v'))

traverseDMapWithKeyWithAdjust :: GCompare k => (forall a. k a -> v a -> Layout t m (v' a)) -> DMap k v -> Event t (PatchDMap k v) -> Layout t m (DMap k v', Event t (PatchDMap k v'))

traverseDMapWithKeyWithAdjustWithMove :: GCompare k => (forall a. k a -> v a -> Layout t m (v' a)) -> DMap k v -> Event t (PatchDMapWithMove k v) -> Layout t m (DMap k v', Event t (PatchDMapWithMove k v'))

MonadReflexCreateTrigger t m => MonadReflexCreateTrigger t (Layout t m)

Defined in Reflex.Vty.Widget.Layout

Methods

newEventWithTrigger :: (EventTrigger t a -> IO (IO ())) -> Layout t m (Event t a)

newFanEventWithTrigger :: GCompare k => (forall a. k a -> EventTrigger t a -> IO (IO ())) -> Layout t m (EventSelector t k)

(Reflex t, Monad m) => HasDisplaySize t (Layout t m)

Defined in Reflex.Vty.Widget.Layout

Methods

displayWidth :: Layout t m (Dynamic t Int)

displayHeight :: Layout t m (Dynamic t Int)

MonadTrans (Layout t)

Defined in Reflex.Vty.Widget.Layout

Methods

lift :: Monad m => m a -> Layout t m a

MonadSample t m => MonadSample (t :: Type) (Layout t m)

Defined in Reflex.Vty.Widget.Layout

Methods

sample :: Behavior t a -> Layout t m a

MonadHold t m => MonadHold (t :: Type) (Layout t m)

Defined in Reflex.Vty.Widget.Layout

Methods

hold :: a -> Event t a -> Layout t m (Behavior t a)

holdDyn :: a -> Event t a -> Layout t m (Dynamic t a)

holdIncremental :: Patch p => PatchTarget p -> Event t p -> Layout t m (Incremental t p)

buildDynamic :: PushM t a -> Event t a -> Layout t m (Dynamic t a)

headE :: Event t a -> Layout t m (Event t a)

Monad m => Monad (Layout t m)

Defined in Reflex.Vty.Widget.Layout

Methods

(>>=) :: Layout t m a -> (a -> Layout t m b) -> Layout t m b

(>>) :: Layout t m a -> Layout t m b -> Layout t m b

return :: a -> Layout t m a

fail :: String -> Layout t m a

Functor m => Functor (Layout t m)

Defined in Reflex.Vty.Widget.Layout

Methods

fmap :: (a -> b) -> Layout t m a -> Layout t m b

(<$) :: a -> Layout t m b -> Layout t m a

MonadFix m => MonadFix (Layout t m)

Defined in Reflex.Vty.Widget.Layout

Methods

mfix :: (a -> Layout t m a) -> Layout t m a

Monad m => Applicative (Layout t m)

Defined in Reflex.Vty.Widget.Layout

Methods

pure :: a -> Layout t m a

(<*>) :: Layout t m (a -> b) -> Layout t m a -> Layout t m b

liftA2 :: (a -> b -> c) -> Layout t m a -> Layout t m b -> Layout t m c

(*>) :: Layout t m a -> Layout t m b -> Layout t m b

(<*) :: Layout t m a -> Layout t m b -> Layout t m a

MonadNodeId m => MonadNodeId (Layout t m)

Defined in Reflex.Vty.Widget.Layout

Methods

getNextNodeId :: Layout t m NodeId

type Performable (Layout t m)

Defined in Reflex.Vty.Widget.Layout

type Performable (Layout t m)

runLayout

Arguments

:: (MonadFix m, MonadHold t m, PostBuild t m, Monad m, MonadNodeId m)

=> Dynamic t Orientation

The main-axis Orientation of this Layout

-> Int

The positional index of the initially focused tile

-> Event t Int

An event that shifts focus by a given number of tiles

-> Layout t m a

The Layout widget

-> VtyWidget t m a

Run a Layout action

data TileConfig t

Configuration options for and constraints on tile

Constructors

TileConfig

Fields

• _tileConfig_constraint :: Dynamic t Constraint

  Constraint on the tile's size

• _tileConfig_focusable :: Dynamic t Bool

  Whether the tile is focusable data TileConfig t = TileConfig

Instances

Reflex t => Default (TileConfig t)

Defined in Reflex.Vty.Widget.Layout

Methods

def :: TileConfig t

tile

Arguments

:: (Reflex t, Monad m, MonadNodeId m)

=> TileConfig t

The tile's configuration

-> VtyWidget t m (Event t x, a)

A child widget. The Event that it returns is used to request that it be focused.

-> Layout t m a

Tiles are the basic building blocks of Layout widgets. Each tile has a constraint on its size and ability to grow and on whether it can be focused. It also allows its child widget to request focus.

fixed :: (Reflex t, Monad m, MonadNodeId m) => Dynamic t Int -> VtyWidget t m a -> Layout t m a

A tile of a fixed size that is focusable and gains focus on click

stretch :: (Reflex t, Monad m, MonadNodeId m) => VtyWidget t m a -> Layout t m a

A tile that can stretch (i.e., has no fixed size) and has a minimum size of 0. This tile is focusable and gains focus on click.

col :: (MonadFix m, MonadHold t m, PostBuild t m, MonadNodeId m) => Layout t m a -> VtyWidget t m a

A version of runLayout that arranges tiles in a column and uses tabNavigation to change tile focus.

row :: (MonadFix m, MonadHold t m, PostBuild t m, MonadNodeId m) => Layout t m a -> VtyWidget t m a

A version of runLayout that arranges tiles in a row and uses tabNavigation to change tile focus.

tabNavigation :: (Reflex t, Monad m) => VtyWidget t m (Event t Int)

Produces an Event that navigates forward one tile when the Tab key is pressed and backward one tile when Shift+Tab is pressed.

askOrientation :: Monad m => Layout t m (Dynamic t Orientation)

Retrieve the current orientation of a Layout