Brick.Widgets.TabularList.Grid

Grid tabular list is a uniform grid that supports cell-by-cell navigation.

Because this list is designed to show arbitrary numbers of columns, horizontal scrolling is supported through cell-by-cell navigation.

Grid tabular list tries to show the current column in the center. If it can't show the current column in the center, it shows the first column in the left corner or the last column in the right corner.

It should be fast enough to handle a large spreadsheet. It is also suitable for an interface to a database table.

Data types

data GridRowCtxt

Grid row context

Constructors

GRowC

Fields

• index :: Index
• selected :: Selected

Instances

Generic GridRowCtxt

Defined in Brick.Widgets.TabularList.Grid

Associated Types

type Rep GridRowCtxt :: Type -> Type

Methods

from :: GridRowCtxt -> Rep GridRowCtxt x

to :: Rep GridRowCtxt x -> GridRowCtxt

Show GridRowCtxt

Defined in Brick.Widgets.TabularList.Grid

Methods

showsPrec :: Int -> GridRowCtxt -> ShowS

show :: GridRowCtxt -> String

showList :: [GridRowCtxt] -> ShowS

Eq GridRowCtxt

Defined in Brick.Widgets.TabularList.Grid

Methods

(==) :: GridRowCtxt -> GridRowCtxt -> Bool

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

type Rep GridRowCtxt

Defined in Brick.Widgets.TabularList.Grid

type Rep GridRowCtxt = D1 ('MetaData "GridRowCtxt" "Brick.Widgets.TabularList.Grid" "brick-tabular-list-2.2.0.6-AiZXcnb49SU5Sm94CE44Dq" 'False) (C1 ('MetaCons "GRowC" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Index) :*: S1 ('MetaSel ('Just "selected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Selected)))

data GridColCtxt

Grid column context

Constructors

GColC

Fields

• index :: Index
• selected :: Selected

Instances

Generic GridColCtxt

Defined in Brick.Widgets.TabularList.Grid

Associated Types

type Rep GridColCtxt :: Type -> Type

Methods

from :: GridColCtxt -> Rep GridColCtxt x

to :: Rep GridColCtxt x -> GridColCtxt

Show GridColCtxt

Defined in Brick.Widgets.TabularList.Grid

Methods

showsPrec :: Int -> GridColCtxt -> ShowS

show :: GridColCtxt -> String

showList :: [GridColCtxt] -> ShowS

Eq GridColCtxt

Defined in Brick.Widgets.TabularList.Grid

Methods

(==) :: GridColCtxt -> GridColCtxt -> Bool

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

type Rep GridColCtxt

Defined in Brick.Widgets.TabularList.Grid

type Rep GridColCtxt = D1 ('MetaData "GridColCtxt" "Brick.Widgets.TabularList.Grid" "brick-tabular-list-2.2.0.6-AiZXcnb49SU5Sm94CE44Dq" 'False) (C1 ('MetaCons "GColC" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Index) :*: S1 ('MetaSel ('Just "selected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Selected)))

data GridCtxt

Context for grid cells

Constructors

GrdCtxt

Fields

• row :: GridRowCtxt
• col :: GridColCtxt

Instances

Generic GridCtxt

Defined in Brick.Widgets.TabularList.Grid

Associated Types

type Rep GridCtxt :: Type -> Type

Methods

from :: GridCtxt -> Rep GridCtxt x

to :: Rep GridCtxt x -> GridCtxt

Show GridCtxt

Defined in Brick.Widgets.TabularList.Grid

Methods

showsPrec :: Int -> GridCtxt -> ShowS

show :: GridCtxt -> String

showList :: [GridCtxt] -> ShowS

Eq GridCtxt

Defined in Brick.Widgets.TabularList.Grid

Methods

(==) :: GridCtxt -> GridCtxt -> Bool

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

type Rep GridCtxt

Defined in Brick.Widgets.TabularList.Grid

type Rep GridCtxt = D1 ('MetaData "GridCtxt" "Brick.Widgets.TabularList.Grid" "brick-tabular-list-2.2.0.6-AiZXcnb49SU5Sm94CE44Dq" 'False) (C1 ('MetaCons "GrdCtxt" 'PrefixI 'True) (S1 ('MetaSel ('Just "row") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GridRowCtxt) :*: S1 ('MetaSel ('Just "col") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GridColCtxt)))

data GridColHdr n

Grid column header

• Type Variables
• Rendering

Constructors

GridColHdr

Fields

• draw :: ListFocused -> WidthDeficit -> GridColCtxt -> Widget n
• height :: ColHdrHeight

Instances

Generic (GridColHdr n)

Defined in Brick.Widgets.TabularList.Grid

Associated Types

type Rep (GridColHdr n) :: Type -> Type

Methods

from :: GridColHdr n -> Rep (GridColHdr n) x

to :: Rep (GridColHdr n) x -> GridColHdr n

type Rep (GridColHdr n)

Defined in Brick.Widgets.TabularList.Grid

type Rep (GridColHdr n) = D1 ('MetaData "GridColHdr" "Brick.Widgets.TabularList.Grid" "brick-tabular-list-2.2.0.6-AiZXcnb49SU5Sm94CE44Dq" 'False) (C1 ('MetaCons "GridColHdr" 'PrefixI 'True) (S1 ('MetaSel ('Just "draw") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ListFocused -> WidthDeficit -> GridColCtxt -> Widget n)) :*: S1 ('MetaSel ('Just "height") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ColHdrHeight)))

data GridRenderers n e

Rendering functions for components of grid tabular list

• Type Variables
• Rendering

Constructors

GridRenderers

Fields

• cell :: ListFocused -> WidthDeficit -> GridCtxt -> e -> Widget n
• rowHdr :: Maybe (RowHdr n e)
• colHdr :: Maybe (GridColHdr n)
• colHdrRowHdr :: Maybe (ColHdrRowHdr n)

Instances

Generic (GridRenderers n e)

Defined in Brick.Widgets.TabularList.Grid

Associated Types

type Rep (GridRenderers n e) :: Type -> Type

Methods

from :: GridRenderers n e -> Rep (GridRenderers n e) x

to :: Rep (GridRenderers n e) x -> GridRenderers n e

type Rep (GridRenderers n e)

Defined in Brick.Widgets.TabularList.Grid

type Rep (GridRenderers n e) = D1 ('MetaData "GridRenderers" "Brick.Widgets.TabularList.Grid" "brick-tabular-list-2.2.0.6-AiZXcnb49SU5Sm94CE44Dq" 'False) (C1 ('MetaCons "GridRenderers" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cell") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ListFocused -> WidthDeficit -> GridCtxt -> e -> Widget n)) :*: S1 ('MetaSel ('Just "rowHdr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (RowHdr n e)))) :*: (S1 ('MetaSel ('Just "colHdr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (GridColHdr n))) :*: S1 ('MetaSel ('Just "colHdrRowHdr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (ColHdrRowHdr n))))))

data GridTabularList n e

• Type Variables

Constructors

GridTabularList

Fields

• list :: GenericList n Seq e

  The underlying primitive list that comes from brick

• widths :: Seq ColWidth
• currentColumn :: Index

  Manipulating this field directly is unsafe. Use column navigation functions to manipulate this. If you still want to manipulate this directly, create a function that manipulates it, and test the function properly.

Instances

Generic (GridTabularList n e)

Defined in Brick.Widgets.TabularList.Grid

Associated Types

type Rep (GridTabularList n e) :: Type -> Type

Methods

from :: GridTabularList n e -> Rep (GridTabularList n e) x

to :: Rep (GridTabularList n e) x -> GridTabularList n e

type Rep (GridTabularList n e)

Defined in Brick.Widgets.TabularList.Grid

type Rep (GridTabularList n e) = D1 ('MetaData "GridTabularList" "Brick.Widgets.TabularList.Grid" "brick-tabular-list-2.2.0.6-AiZXcnb49SU5Sm94CE44Dq" 'False) (C1 ('MetaCons "GridTabularList" 'PrefixI 'True) (S1 ('MetaSel ('Just "list") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (GenericList n Seq e)) :*: (S1 ('MetaSel ('Just "widths") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq ColWidth)) :*: S1 ('MetaSel ('Just "currentColumn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Index))))

List construction

gridTabularList

Arguments

:: n

The list name (must be unique)

-> Seq e

The initial list elements

-> ListItemHeight

-> Seq ColWidth

-> GridTabularList n e

Create a grid tabular list

Rendering

renderGridTabularList

Arguments

:: (Ord n, Show n)

=> GridRenderers n e

-> ListFocused

-> GridTabularList n e

The list

-> Widget n

Render grid tabular list

Column navigation

gridMoveLeft

Arguments

:: GridTabularList n e

The list

-> GridTabularList n e

Move to the left by one column.

gridMoveRight

Arguments

:: GridTabularList n e

The list

-> GridTabularList n e

Move to the right by one column.

gridMoveTo

Arguments

:: Index

-> GridTabularList n e

The list

-> GridTabularList n e

Move to the given column index

gridMoveToBeginning

Arguments

:: GridTabularList n e

The list

-> GridTabularList n e

Move to the first column.

gridMoveToEnd

Arguments

:: GridTabularList n e

The list

-> GridTabularList n e

Move to the last column.

gridMovePageUp

Arguments

:: Ord n

=> GridRenderers n e

Renderers

-> EventM n (GridTabularList n e) ()

Move to the previous page of columns.

GridRenderers are needed because if row header doesn't exist, width calculation is affected.

gridMovePageDown

Arguments

:: Ord n

=> GridRenderers n e

Renderers

-> EventM n (GridTabularList n e) ()

Move to the next page of columns.

GridRenderers are needed because if row header doesn't exist, width calculation is affected.

Event handlers

handleGridListEvent

Arguments

:: Ord n

=> GridRenderers n e

Renderers

-> Event

-> EventM n (GridTabularList n e) ()

Handle events for grid tabular list with navigation keys.

It adds the following keyboard shortcuts to handleListEvent.

• Move to the left by one column (Left arrow key)
• Move to the right by one column (Right arrow key)
• Go to the first column (Ctrl+Home)
• Go to the last column (Ctrl+End)
• Move to the previous page of columns (Ctrl+PageUp)
• Move to the next page of columns (Ctrl+PageDown)

GridRenderers are needed because if row header doesn't exist, width calculation is affected.

handleGridListEventVi

Arguments

:: Ord n

=> GridRenderers n e

Renderers

-> Event

-> EventM n (GridTabularList n e) ()

Handle events for grid tabular list with vim keys.

It adds the following keyboard shortcuts to handleListEventVi.

• Move to the left by one column (h)
• Move to the right by one column (l)
• Go to the first column (H)
• Go to the last column (L)
• Move to the previous page of columns (Alt+h)
• Move to the next page of columns (Alt+l)

GridRenderers are needed because if row header doesn't exist, width calculation is affected.

Shared types

module Brick.Widgets.TabularList.Types