Monomer.Core.SizeReq

Helper functions creating, validating and merging size requirements.

Documentation

type SizeReqUpdater = (SizeReq, SizeReq) -> (SizeReq, SizeReq)

Transforms a SizeReq pair by applying an arbitrary operation.

clearExtra :: SizeReqUpdater

Clears the extra field of a SizeReq.

sizeReqBounded :: SizeReq -> Double -> Double -> Double

Returns a bounded value by the SizeReq, starting from value and offset.

sizeReqValid :: SizeReq -> Double -> Double -> Bool

Checks that value, given an offset, matches a SizeReq.

sizeReqAddStyle :: StyleState -> (SizeReq, SizeReq) -> (SizeReq, SizeReq)

Adds border/padding size to a SizeReq pair.

sizeReqMin :: SizeReq -> Double

Returns the minimum valid value for a SizeReq.

sizeReqMax :: SizeReq -> Double

Returns the maximum valid value for a SizeReq. This can be unbounded if extra field is not zero.

sizeReqMaxBounded :: SizeReq -> Double

Returns the maximum, bounded, valid value for a SizeReq. Extra is ignored.

sizeReqFixed :: SizeReq -> Double

Returns the fixed size of a SizeReq.

sizeReqFlex :: SizeReq -> Double

Returns the flex size of a SizeReq.

sizeReqExtra :: SizeReq -> Double

Returns the extra size of a SizeReq.

sizeReqFactor :: SizeReq -> Double

Returns the resize factor of a SizeReq.

sizeReqMergeSum :: SizeReq -> SizeReq -> SizeReq

Sums two SizeReqs. This is used for combining two widgets one after the other, summing their sizes.

The fixed, flex and extra fields are summed individually, while the max factor is kept.

sizeReqMergeMax :: SizeReq -> SizeReq -> SizeReq

Merges two SizeReqs. This is used for combining two widgets by keeping the largest size requirement.

Fields are combined in order to first satisfy fixed requirements, adapting flex if one of the fixed provided more space than required. For both extra and factor the largest value is kept.