Safe Haskell	Safe-Inferred
Language	Haskell2010
Extensions	DisambiguateRecordFields NamedFieldPuns DeriveGeneric DuplicateRecordFields OverloadedLabels

Brick.Widgets.TabularList.Mixed

Contents

Data types
List construction
Rendering
Event handlers
Shared types

Description

Mixed tabular list is a list with different kinds of rows.

demo

Each row belongs to a row kind which is usually a data constructor of row data type. Because there can be more than one data constructor in row data type, this list is called mixed tabular list. Each row kind can have a different number of columns than another row kind.

Cell by cell navigation is not supported. You can navigate row by row.

Because this list is designed to show every column in the available space, horizontal scrolling is not supported.

Synopsis

data MixedRowCtxt = MRowC {
- index :: Index
- selected :: Selected
}
newtype MixedColCtxt = MColC {
- index :: Index
}
data MixedCtxt = MxdCtxt {
- row :: MixedRowCtxt
- col :: MixedColCtxt
}
data MixedColHdr n w = MixedColHdr {
- draw :: ListFocused -> MixedColCtxt -> Widget n
- widths :: w -> [ColWidth]
- height :: ColHdrHeight
}
data MixedRenderers n e w = MixedRenderers {
- cell :: ListFocused -> MixedCtxt -> e -> Widget n
- rowHdr :: Maybe (RowHdr n e)
- colHdr :: Maybe (MixedColHdr n w)
- colHdrRowHdr :: Maybe (ColHdrRowHdr n)
}
newtype WidthsPerRowKind e w = WsPerRK (AvailWidth -> [e] -> w)
newtype WidthsPerRow e w = WsPerR (w -> e -> [ColWidth])
data MixedTabularList n e w = MixedTabularList {
- list :: GenericList n Seq e
- widthsPerRowKind :: WidthsPerRowKind e w
- widthsPerRow :: WidthsPerRow e w
}
mixedTabularList :: n -> Seq e -> ListItemHeight -> WidthsPerRowKind e w -> WidthsPerRow e w -> MixedTabularList n e w
renderMixedTabularList :: (Show n, Ord n) => MixedRenderers n e w -> ListFocused -> MixedTabularList n e w -> Widget n
handleMixedListEvent :: Ord n => Event -> EventM n (MixedTabularList n e w) ()
handleMixedListEventVi :: Ord n => Event -> EventM n (MixedTabularList n e w) ()
module Brick.Widgets.TabularList.Types

Data types

data MixedRowCtxt Source #

Mixed row context

Constructors

MRowC
Fields index :: Index selected :: Selected

Instances

Instances details

Generic MixedRowCtxt Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed Associated Types type Rep MixedRowCtxt :: Type -> Type # Methods from :: MixedRowCtxt -> Rep MixedRowCtxt x # to :: Rep MixedRowCtxt x -> MixedRowCtxt #
Show MixedRowCtxt Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed Methods showsPrec :: Int -> MixedRowCtxt -> ShowS # show :: MixedRowCtxt -> String # showList :: [MixedRowCtxt] -> ShowS #
Eq MixedRowCtxt Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed Methods (==) :: MixedRowCtxt -> MixedRowCtxt -> Bool # (/=) :: MixedRowCtxt -> MixedRowCtxt -> Bool #
type Rep MixedRowCtxt Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed type Rep MixedRowCtxt = D1 ('MetaData "MixedRowCtxt" "Brick.Widgets.TabularList.Mixed" "brick-tabular-list-2.2.0.10-1F10XiequAjJHoOSDwgTaa" 'False) (C1 ('MetaCons "MRowC" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Index) :*: S1 ('MetaSel ('Just "selected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Selected)))

newtype MixedColCtxt Source #

Mixed column context

Constructors

MColC
Fields index :: Index

Instances

Instances details

Generic MixedColCtxt Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed Associated Types type Rep MixedColCtxt :: Type -> Type # Methods from :: MixedColCtxt -> Rep MixedColCtxt x # to :: Rep MixedColCtxt x -> MixedColCtxt #
Show MixedColCtxt Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed Methods showsPrec :: Int -> MixedColCtxt -> ShowS # show :: MixedColCtxt -> String # showList :: [MixedColCtxt] -> ShowS #
Eq MixedColCtxt Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed Methods (==) :: MixedColCtxt -> MixedColCtxt -> Bool # (/=) :: MixedColCtxt -> MixedColCtxt -> Bool #
type Rep MixedColCtxt Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed type Rep MixedColCtxt = D1 ('MetaData "MixedColCtxt" "Brick.Widgets.TabularList.Mixed" "brick-tabular-list-2.2.0.10-1F10XiequAjJHoOSDwgTaa" 'True) (C1 ('MetaCons "MColC" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Index)))

data MixedCtxt Source #

Context for mixed columns

Constructors

MxdCtxt
Fields row :: MixedRowCtxt col :: MixedColCtxt

Instances

Instances details

Generic MixedCtxt Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed Associated Types type Rep MixedCtxt :: Type -> Type # Methods from :: MixedCtxt -> Rep MixedCtxt x # to :: Rep MixedCtxt x -> MixedCtxt #
Show MixedCtxt Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed Methods showsPrec :: Int -> MixedCtxt -> ShowS # show :: MixedCtxt -> String # showList :: [MixedCtxt] -> ShowS #
Eq MixedCtxt Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed Methods (==) :: MixedCtxt -> MixedCtxt -> Bool # (/=) :: MixedCtxt -> MixedCtxt -> Bool #
type Rep MixedCtxt Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed type Rep MixedCtxt = D1 ('MetaData "MixedCtxt" "Brick.Widgets.TabularList.Mixed" "brick-tabular-list-2.2.0.10-1F10XiequAjJHoOSDwgTaa" 'False) (C1 ('MetaCons "MxdCtxt" 'PrefixI 'True) (S1 ('MetaSel ('Just "row") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MixedRowCtxt) :*: S1 ('MetaSel ('Just "col") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MixedColCtxt)))

data MixedColHdr n w Source #

Mixed column header

Constructors

MixedColHdr
Fields draw :: ListFocused -> MixedColCtxt -> Widget n widths :: w -> [ColWidth] A function for getting widths for column headers from the type that contains widths per row kind height :: ColHdrHeight

Instances

Instances details

Generic (MixedColHdr n w) Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed Associated Types type Rep (MixedColHdr n w) :: Type -> Type # Methods from :: MixedColHdr n w -> Rep (MixedColHdr n w) x # to :: Rep (MixedColHdr n w) x -> MixedColHdr n w #
type Rep (MixedColHdr n w) Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed type Rep (MixedColHdr n w) = D1 ('MetaData "MixedColHdr" "Brick.Widgets.TabularList.Mixed" "brick-tabular-list-2.2.0.10-1F10XiequAjJHoOSDwgTaa" 'False) (C1 ('MetaCons "MixedColHdr" 'PrefixI 'True) (S1 ('MetaSel ('Just "draw") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ListFocused -> MixedColCtxt -> Widget n)) :: (S1 ('MetaSel ('Just "widths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (w -> [ColWidth])) :: S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ColHdrHeight))))

data MixedRenderers n e w Source #

Rendering functions for components of mixed tabular list

Constructors

MixedRenderers
Fields cell :: ListFocused -> MixedCtxt -> e -> Widget n rowHdr :: Maybe (RowHdr n e) colHdr :: Maybe (MixedColHdr n w) colHdrRowHdr :: Maybe (ColHdrRowHdr n)

Instances

Instances details

Generic (MixedRenderers n e w) Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed Associated Types type Rep (MixedRenderers n e w) :: Type -> Type # Methods from :: MixedRenderers n e w -> Rep (MixedRenderers n e w) x # to :: Rep (MixedRenderers n e w) x -> MixedRenderers n e w #
type Rep (MixedRenderers n e w) Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed type Rep (MixedRenderers n e w) = D1 ('MetaData "MixedRenderers" "Brick.Widgets.TabularList.Mixed" "brick-tabular-list-2.2.0.10-1F10XiequAjJHoOSDwgTaa" 'False) (C1 ('MetaCons "MixedRenderers" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cell") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ListFocused -> MixedCtxt -> e -> Widget n)) :: S1 ('MetaSel ('Just "rowHdr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (RowHdr n e)))) :: (S1 ('MetaSel ('Just "colHdr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (MixedColHdr n w))) :*: S1 ('MetaSel ('Just "colHdrRowHdr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (ColHdrRowHdr n))))))

newtype WidthsPerRowKind e w Source #

Calculate widths per row kind from visible list rows and the width available after row header.

Type Variables

Constructors

WsPerRK (AvailWidth -> [e] -> w)

Instances

Instances details

Generic (WidthsPerRowKind e w) Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed Associated Types type Rep (WidthsPerRowKind e w) :: Type -> Type # Methods from :: WidthsPerRowKind e w -> Rep (WidthsPerRowKind e w) x # to :: Rep (WidthsPerRowKind e w) x -> WidthsPerRowKind e w #
type Rep (WidthsPerRowKind e w) Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed type Rep (WidthsPerRowKind e w) = D1 ('MetaData "WidthsPerRowKind" "Brick.Widgets.TabularList.Mixed" "brick-tabular-list-2.2.0.10-1F10XiequAjJHoOSDwgTaa" 'True) (C1 ('MetaCons "WsPerRK" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (AvailWidth -> [e] -> w))))

newtype WidthsPerRow e w Source #

It is a function to get widths for each row. Use pattern matching to detect the kind of each row. Usually, a row kind is a data constructor of row data type.

Type Variables

Constructors

WsPerR (w -> e -> [ColWidth])

Instances

Instances details

Generic (WidthsPerRow e w) Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed Associated Types type Rep (WidthsPerRow e w) :: Type -> Type # Methods from :: WidthsPerRow e w -> Rep (WidthsPerRow e w) x # to :: Rep (WidthsPerRow e w) x -> WidthsPerRow e w #
type Rep (WidthsPerRow e w) Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed type Rep (WidthsPerRow e w) = D1 ('MetaData "WidthsPerRow" "Brick.Widgets.TabularList.Mixed" "brick-tabular-list-2.2.0.10-1F10XiequAjJHoOSDwgTaa" 'True) (C1 ('MetaCons "WsPerR" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (w -> e -> [ColWidth]))))

data MixedTabularList n e w Source #

Type Variables

Constructors

MixedTabularList
Fields list :: GenericList n Seq e The underlying list that comes from brick widthsPerRowKind :: WidthsPerRowKind e w widthsPerRow :: WidthsPerRow e w

Instances

Instances details

Generic (MixedTabularList n e w) Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed Associated Types type Rep (MixedTabularList n e w) :: Type -> Type # Methods from :: MixedTabularList n e w -> Rep (MixedTabularList n e w) x # to :: Rep (MixedTabularList n e w) x -> MixedTabularList n e w #
type Rep (MixedTabularList n e w) Source #
Instance details Defined in Brick.Widgets.TabularList.Mixed type Rep (MixedTabularList n e w) = D1 ('MetaData "MixedTabularList" "Brick.Widgets.TabularList.Mixed" "brick-tabular-list-2.2.0.10-1F10XiequAjJHoOSDwgTaa" 'False) (C1 ('MetaCons "MixedTabularList" 'PrefixI 'True) (S1 ('MetaSel ('Just "list") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (GenericList n Seq e)) :: (S1 ('MetaSel ('Just "widthsPerRowKind") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (WidthsPerRowKind e w)) :: S1 ('MetaSel ('Just "widthsPerRow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (WidthsPerRow e w)))))

List construction

mixedTabularList Source #

Arguments

:: n	The name of the list. It must be unique.
-> Seq e	The initial list elements
-> ListItemHeight
-> WidthsPerRowKind e w
-> WidthsPerRow e w
-> MixedTabularList n e w

Create a mixed tabular list.

Rendering

renderMixedTabularList Source #

Arguments

:: (Show n, Ord n)
=> MixedRenderers n e w	Renderers
-> ListFocused
-> MixedTabularList n e w	The list
-> Widget n

Render mixed tabular list.

Event handlers

handleMixedListEvent Source #

Arguments

:: Ord n
=> Event	Event
-> EventM n (MixedTabularList n e w) ()

Handle events for mixed tabular list with navigation keys. This just calls handleListEvent.

handleMixedListEventVi Source #

Arguments

:: Ord n
=> Event	Event
-> EventM n (MixedTabularList n e w) ()

Handle events for mixed tabular list with vim keys. This just calls handleListEventVi.

Shared types

module Brick.Widgets.TabularList.Types