jtdaugherty/brick
1
1
Fork 0
mirror of https://github.com/jtdaugherty/brick.git synced 2025-01-06 05:14:11 +03:00
Code Issues Projects Releases Wiki Activity

Internal: minor haddock fixes and improvements

Browse Source
This commit is contained in:
Jonathan Daugherty 2015-07-21 19:15:47 -07:00
parent c35caa61c4
commit c402579bda
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/Brick/Widgets/Internal.hs
View File

@ -821,9 +821,11 @@ scrollToView Horizontal rq vp = vp & vpLeft .~ newHStart
-- rendered inside a viewport. This permits widgets (whose sizes and
-- positions cannot be known due to being embedded in arbitrary layouts)
-- to make a request for a parent viewport to locate them and scroll
-- tenough o put them in view. This, together with 'viewport' is what
-- tmakes the ext editor and list widgets possible without making them
-- tdeal with he details of scrolling state management.
-- enough to put them in view. This, together with 'viewport', is what
-- makes the text editor and list widgets possible without making them
-- deal with the details of scrolling state management.
--
-- This does nothing if not rendered in a viewport.
visible :: Widget -> Widget
visible p =
Widget (hSize p) (vSize p) $ do
@ -839,7 +841,10 @@ visible p =
-- | Similar to 'visible', request that a region (with the specified
-- 'Location' as its origin and 'V.DisplayRegion' as its size) be made
-- visible when it is rendered inside a viewport.
-- visible when it is rendered inside a viewport. The 'Location' is
-- relative to the specified widget's upper-left corner of (0, 0).
--
-- This does nothing if not rendered in a viewport.
visibleRegion :: Location -> V.DisplayRegion -> Widget -> Widget
visibleRegion vrloc sz p =
Widget (hSize p) (vSize p) $ do