Hoogle Search

Within LTS Haskell 24.41 (ghc-9.10.3)

Note that Stackage only displays results for the latest LTS and Nightly snapshot. Learn more.

Exact lookup

1. module Brick.AttrMap

   This module provides types and functions for managing an attribute map which maps attribute names (AttrName) to attributes (Attr). Attribute maps work by mapping hierarchical attribute names to attributes and inheriting parent names' attributes when child names specify partial attributes. Hierarchical names are created with mappend:

   let n = attrName "parent" <> attrName "child"
   

   Attribute names are mapped to attributes, but some attributes may be partial (specify only a foreground or background color). When attribute name lookups occur, the attribute corresponding to a more specific name ('parent <> child' as above) is successively merged with the parent attribute (parent as above) all the way to the "root" of the attribute map, the map's default attribute. In this way, more specific attributes inherit what they don't specify from more general attributes in the same hierarchy. This allows more modularity and less repetition in specifying how elements of your user interface take on different attributes.

2. data AttrMap

   brick	Brick.AttrMap

   An attribute map which maps AttrName values to Attr values.

3. applyAttrMappings :: [(AttrName, Attr)] -> AttrMap -> AttrMap

   brick	Brick.AttrMap

   Insert a set of attribute mappings to an attribute map.

4. attrMap :: Attr -> [(AttrName, Attr)] -> AttrMap

   brick	Brick.AttrMap

   Create an attribute map.

5. attrMapLookup :: AttrName -> AttrMap -> Attr

   brick	Brick.AttrMap

   Look up the specified attribute name in the map. Map lookups proceed as follows. If the attribute map is forcing all lookups to a specific attribute, that attribute is returned along with its style settings. If the attribute name is empty, the map's default attribute is returned. If the attribute name is non-empty, every subsequence of names from the specified name are used to perform a lookup and the results are combined as in mergeWithDefault, with more specific results taking precedence over less specific ones. As attributes are merged, styles are also merged. If a more specific attribute name introduces a style (underline, say) and a less specific attribute name introduces an additional style (bold, say) then the final result will include both styles. For example:

   attrMapLookup (attrName "foo" <> attrName "bar") (attrMap a []) == a
   attrMapLookup (attrName "foo" <> attrName "bar") (attrMap (bg blue) [(attrName "foo" <> attrName "bar", fg red)]) == red `on` blue
   attrMapLookup (attrName "foo" <> attrName "bar") (attrMap (bg blue) [(attrName "foo" <> attrName "bar", red on cyan)]) == red `on` cyan
   attrMapLookup (attrName "foo" <> attrName "bar") (attrMap (bg blue) [(attrName "foo" <> attrName "bar", fg red), ("foo", bg cyan)]) == red `on` cyan
   attrMapLookup (attrName "foo" <> attrName "bar") (attrMap (bg blue) [(attrName "foo", fg red)]) == red `on` blue
   

6. forceAttrMap :: Attr -> AttrMap

   brick	Brick.AttrMap

   Create an attribute map in which all lookups map to the same attribute. This is functionally equivalent to attrMap attr [].

7. forceAttrMapAllowStyle :: Attr -> AttrMap -> AttrMap

   brick	Brick.AttrMap

   Create an attribute map in which all lookups map to the same attribute. This is functionally equivalent to attrMap attr [].

8. module Brick.BorderMap

   No documentation available.

9. data BorderMap a

   brick	Brick.BorderMap

   A BorderMap a is like a Map Location a, except that there is a rectangle, and only Locations on the border of this rectangle are retained. The BorderMap can be queried for the position and size of the rectangle. There are also efficient bulk query and bulk update operations for adjacent positions on the border.

10. keyEventMappings :: (Ord k, Eq k) => KeyConfig k -> [(Binding, Set k)]

    brick	Brick.Keybindings.KeyConfig

    Return a list of mappings including each key bound to any event combined with the list of events to which it is bound. This is useful for identifying problematic key binding collisions. Since key binding collisions cannot be determined in general, we leave it up to the application author to determine which key-to-event bindings are problematic.

Page 594 of many | Previous | Next