Update Haddock to avoid mentoining defunct HandleEvent type class

This commit is contained in:
Jonathan Daugherty 2017-03-27 16:18:13 -07:00
parent c95f29a307
commit cf96e9e8ea
2 changed files with 9 additions and 11 deletions

View File

@ -44,16 +44,14 @@ import Brick.Widgets.Border
import Brick.AttrMap
-- | Dialogs present a window with a title (optional), a body, and
-- buttons (optional). They provide a 'HandleEvent' instance that knows
-- about Tab and Shift-Tab as well as ArrowLeft and ArrowRight
-- for changing which button is active. Dialog
-- buttons are labeled with strings and map to values of type 'a', which
-- you choose.
-- buttons (optional). Dialog buttons are labeled with strings and map
-- to values of type 'a', which you choose.
--
-- Dialogs handle the following events by default:
-- Dialogs handle the following events by default with
-- handleDialogEvent:
--
-- * Tab: selecte the next button
-- * Shift-tab: select the previous button
-- * Tab or Right Arrow: select the next button
-- * Shift-tab or Left Arrow: select the previous button
data Dialog a =
Dialog { dialogTitle :: Maybe String
-- ^ The dialog title

View File

@ -8,9 +8,9 @@
-- of the editor, just use 'getEditContents'. To modify it, use the
-- 'Z.TextZipper' interface with 'applyEdit'.
--
-- The editor's 'HandleEvent' instance handles a set of basic input
-- events that should suffice for most purposes; see the source for a
-- complete list.
-- The editor's 'handleEditorEvent' function handles a set of basic
-- input events that should suffice for most purposes; see the source
-- for a complete list.
--
-- Bear in mind that the editor provided by this module is intended to
-- provide basic input support for brick applications but it is not