@@ -30,13 +30,20 @@ data Button = BLeft | BMiddle | BRight
3030-- | Events.
3131data Event
3232 = EvKey Key [Modifier]
33− -- | \todo mouse events are not supported
33+ -- ^ A keyboard key was pressed with the specified modifiers.
3434 | EvMouseDown Int Int Button [Modifier]
35+ -- ^ A mouse button was pressed at the specified column and row. Any
36+ -- modifiers available in the event are also provided.
3537 | EvMouseUp Int Int (Maybe Button)
36− -- | if read from 'eventChannel' this is the size at the time of the signal. If read from
37− -- 'nextEvent' this is the size at the time the event was processed by Vty. Typically these are
38− -- the same, but if somebody is resizing the terminal quickly they can be different.
38+ -- ^ A mouse button was released at the specified column and
39+ -- row. Some terminals report only that a button was released
40+ -- without specifying which one; in that case, Nothing is provided.
41+ -- Otherwise Just the button released is included in the event.
3942 | EvResize Int Int
43+ -- ^ If read from 'eventChannel' this is the size at the time of the
44+ -- signal. If read from 'nextEvent' this is the size at the time the
45+ -- event was processed by Vty. Typically these are the same, but if
46+ -- somebody is resizing the terminal quickly they can be different.
4047 deriving (Eq,Show,Read,Ord)
4148
4249type ClassifyMap = [(String,Event)]