Graphics.Layout.Grid

Sizes grid cells & positions elements to them.

Documentation

type Grid m n = Size (Track m) (Track n)

An element which positions it's children within a grid.

data Track x

The sizes to which children are alonged on a single axis.

Constructors

Track

Fields

• cells :: [Either x Double]

  The desired size of each cell. If Left specifies ratio of excess space to use.

• trackMins :: [Double]

  The minimum amount of space each cell should take.

• trackNats :: [Double]

  The ideal amount of space each cell should take.

• gap :: x

  How much space to add between cells.

Instances

Read x => Read (Track x)

Defined in Graphics.Layout.Grid

Methods

readsPrec :: Int -> ReadS (Track x)

readList :: ReadS [Track x]

readPrec :: ReadPrec (Track x)

readListPrec :: ReadPrec [Track x]

Show x => Show (Track x)

Defined in Graphics.Layout.Grid

Methods

showsPrec :: Int -> Track x -> ShowS

show :: Track x -> String

showList :: [Track x] -> ShowS

Eq x => Eq (Track x)

Defined in Graphics.Layout.Grid

Methods

(==) :: Track x -> Track x -> Bool

(/=) :: Track x -> Track x -> Bool

Ord x => Ord (Track x)

Defined in Graphics.Layout.Grid

Methods

compare :: Track x -> Track x -> Ordering

(<) :: Track x -> Track x -> Bool

(<=) :: Track x -> Track x -> Bool

(>) :: Track x -> Track x -> Bool

(>=) :: Track x -> Track x -> Bool

max :: Track x -> Track x -> Track x

min :: Track x -> Track x -> Track x

type GridItem = Size GridItem' GridItem'

Which cells a child should be aligned to.

data GridItem'

How a grid child should be aligned per-axis.

Constructors

GridItem

Fields

• cellStart :: Int

  On which cell should this child start.

• cellEnd :: Int

  Before which cell should this child end.

• alignment :: Alignment

  How to redistribute excess space.

• minSize :: Double

  The minimum amount of space to allocate to this child.

• natSize :: Double

  The maximum aount of space to allocate to this child.

Instances

Generic GridItem'

Defined in Graphics.Layout.Grid

Associated Types

type Rep GridItem' :: Type -> Type

Methods

from :: GridItem' -> Rep GridItem' x

to :: Rep GridItem' x -> GridItem'

Read GridItem'

Defined in Graphics.Layout.Grid

Methods

readsPrec :: Int -> ReadS GridItem'

readList :: ReadS [GridItem']

readPrec :: ReadPrec GridItem'

readListPrec :: ReadPrec [GridItem']

Show GridItem'

Defined in Graphics.Layout.Grid

Methods

showsPrec :: Int -> GridItem' -> ShowS

show :: GridItem' -> String

showList :: [GridItem'] -> ShowS

NFData GridItem'

Defined in Graphics.Layout.Grid

Methods

rnf :: GridItem' -> ()

Eq GridItem'

Defined in Graphics.Layout.Grid

Methods

(==) :: GridItem' -> GridItem' -> Bool

(/=) :: GridItem' -> GridItem' -> Bool

Ord GridItem'

Defined in Graphics.Layout.Grid

Methods

compare :: GridItem' -> GridItem' -> Ordering

(<) :: GridItem' -> GridItem' -> Bool

(<=) :: GridItem' -> GridItem' -> Bool

(>) :: GridItem' -> GridItem' -> Bool

(>=) :: GridItem' -> GridItem' -> Bool

max :: GridItem' -> GridItem' -> GridItem'

min :: GridItem' -> GridItem' -> GridItem'

type Rep GridItem'

Defined in Graphics.Layout.Grid

type Rep GridItem' = D1 ('MetaData "GridItem'" "Graphics.Layout.Grid" "cattrap-0.4.0.0-inplace" 'False) (C1 ('MetaCons "GridItem" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cellStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "cellEnd") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :*: (S1 ('MetaSel ('Just "alignment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Alignment) :*: (S1 ('MetaSel ('Just "minSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "natSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))))

data Alignment

How to redistribute excess space.

Constructors

Start

Mid

End

Instances

Enum Alignment

Defined in Graphics.Layout.Grid

Methods

succ :: Alignment -> Alignment

pred :: Alignment -> Alignment

toEnum :: Int -> Alignment

fromEnum :: Alignment -> Int

enumFrom :: Alignment -> [Alignment]

enumFromThen :: Alignment -> Alignment -> [Alignment]

enumFromTo :: Alignment -> Alignment -> [Alignment]

enumFromThenTo :: Alignment -> Alignment -> Alignment -> [Alignment]

Generic Alignment

Defined in Graphics.Layout.Grid

Associated Types

type Rep Alignment :: Type -> Type

Methods

from :: Alignment -> Rep Alignment x

to :: Rep Alignment x -> Alignment

Read Alignment

Defined in Graphics.Layout.Grid

Methods

readsPrec :: Int -> ReadS Alignment

readList :: ReadS [Alignment]

readPrec :: ReadPrec Alignment

readListPrec :: ReadPrec [Alignment]

Show Alignment

Defined in Graphics.Layout.Grid

Methods

showsPrec :: Int -> Alignment -> ShowS

show :: Alignment -> String

showList :: [Alignment] -> ShowS

NFData Alignment

Defined in Graphics.Layout.Grid

Methods

rnf :: Alignment -> ()

Eq Alignment

Defined in Graphics.Layout.Grid

Methods

(==) :: Alignment -> Alignment -> Bool

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

Ord Alignment

Defined in Graphics.Layout.Grid

Methods

compare :: Alignment -> Alignment -> Ordering

(<) :: Alignment -> Alignment -> Bool

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

(>) :: Alignment -> Alignment -> Bool

(>=) :: Alignment -> Alignment -> Bool

max :: Alignment -> Alignment -> Alignment

min :: Alignment -> Alignment -> Alignment

type Rep Alignment

Defined in Graphics.Layout.Grid

type Rep Alignment = D1 ('MetaData "Alignment" "Graphics.Layout.Grid" "cattrap-0.4.0.0-inplace" 'False) (C1 ('MetaCons "Start" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Mid" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "End" 'PrefixI 'False) (U1 :: Type -> Type)))

buildTrack :: CastDouble x => [Either x Double] -> Track x

Constructs a track with default (to-be-computed) values & given cell sizes.

buildGrid :: (CastDouble m, CastDouble n) => [Either m Double] -> [Either n Double] -> Grid m n

Constructs a grid with default (to-be-computed) values & given cell sizes.

setCellBox :: (CastDouble m, CastDouble n) => GridItem -> PaddedBox m n -> GridItem

Sets minimum & natural sizes from the given padded box.

enumerate :: [b] -> [(Int, b)]

Utility for associate an index with each item in a list.

gridItemBox :: (CastDouble x, CastDouble y) => Grid y x -> GridItem -> PaddedBox Double Double

Compute the maximum size as a PaddedBox of a child, for it to be sized to.

cellSize :: CastDouble x => Track x -> GridItem' -> Double

Compute the maximum size along an axis of a child, for it to be sized to.

trackMin :: (n -> Double) -> Track n -> Double

Compute the minimum size for the track given cell sizes. Refers to computed min sizes if cached.

trackNat :: (n -> Double) -> Track n -> Double

Compute the natural size for the track given cell sizes. Refers to compute natural sizes if cached.

gridEstWidth :: Grid y Length -> [GridItem] -> Double

Estimate grid width to inform proper width calculation.

sizeTrackMins :: Double -> Track Length -> [GridItem'] -> [Double]

Calculate minimum sizes for all cells in the track. Sized to fit given children.

sizeTrackNats :: Double -> Track Length -> [GridItem'] -> [Double]

Compute natural sizes for all cells in the track. Sized to fit given children.

sizeTrackMaxs :: Double -> Track Length -> [Double]

Compute maximum sizes for all cells in the track, sized to the parent element.

trackPosition :: Track Double -> [GridItem'] -> [Double]

Compute the position of all children within the grid.

gridPosition :: Grid Double Double -> [GridItem] -> [(Double, Double)]

Compute the position of all children in a grid.

trackLayout :: Double -> Double -> Track Length -> [GridItem'] -> (Track Double, [(Double, GridItem')])

Compute the track sizes & child positions along a single axis.

gridLayout :: Size Double Double -> Grid Length Length -> [GridItem] -> (Grid Double Double, [((Double, Double), GridItem)])

Compute the track sizes & child positions along both axes.