| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Brick.Widgets.TabularList.Types
Description
Types shared by tabular list widgets
You don't have to import this module because modules for tabular list widgets re-export this module.
Synopsis
- type ColumnIndex = Int
- type RowIndex = Int
- type Index = Int
- type Width = Int
- type Height = Int
- type AvailWidth = Int
- type ListItemHeight = Int
- data Position = Position {}
- type WidthDeficit = Int
- type ListFocused = Bool
- data RowHeaderWidth rowH
- = FixedRowHeader Width
- | AvailRowHeader (AvailWidth -> Width)
- | VisibleRowHeaders (AvailWidth -> [rowH] -> Width)
Documentation
type ColumnIndex = Int Source #
Index of column among columns
type AvailWidth = Int Source #
Available width
type ListItemHeight = Int Source #
The fixed height for row headers and cells.
If the height of row headers or cells is not this height, then the list will look broken.
Linear position for tabular list elements.
Constructors
| Position | |
Instances
| Generic Position Source # | |
| Show Position Source # | |
| type Rep Position Source # | |
Defined in Brick.Widgets.TabularList.Types type Rep Position = D1 ('MetaData "Position" "Brick.Widgets.TabularList.Types" "brick-tabular-list-0.1.0.2-xtK2tbLVHI135hCs28APH" 'False) (C1 ('MetaCons "Position" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Index) :*: S1 ('MetaSel ('Just "selected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) | |
type WidthDeficit = Int Source #
widthDeficit = max 0 $ desiredWidth - availableWidth
It is positive when an element is shrunk to the available width.
If it is positive, you may want to remove paddings in your content because it is not followed or preceded by other columns.
type ListFocused = Bool Source #
Whether the list is focused in an application
data RowHeaderWidth rowH Source #
Row header width information
Constructors
| FixedRowHeader Width | A fixed width for row header. |
| AvailRowHeader (AvailWidth -> Width) | Calculate row header width with the width available for each row of a list |
| VisibleRowHeaders (AvailWidth -> [rowH] -> Width) | Calculate row header width with visible row headers and the width available for each row of a list. |