Copyright	(c) 2018 Francisco Vallarino
License	BSD-3-Clause (see the LICENSE file)
Maintainer	fjvallarino@gmail.com
Stability	experimental
Portability	non-portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Monomer.Event.Types

Description

Basic types for Monomer events.

Synopsis

newtype KeyCode = KeyCode {
- unKeyCode :: Int
}
data KeyStatus
- = KeyPressed
- | KeyReleased
data Button
- = BtnLeft
- | BtnMiddle
- | BtnRight
data ButtonState
- = BtnPressed
- | BtnReleased
data WheelDirection
- = WheelNormal
- | WheelFlipped
data ClipboardData
- = ClipboardEmpty
- | ClipboardText Text
type DragMsg i = (Eq i, Typeable i)
data WidgetDragMsg = forall i.DragMsg i => WidgetDragMsg i
data SystemEvent
- = Click Point Button Int
- | ButtonAction Point Button ButtonState Int
- | WheelScroll Point Point WheelDirection
- | KeyAction KeyMod KeyCode KeyStatus
- | TextInput Text
- | Clipboard ClipboardData
- | Focus Path
- | Blur Path
- | Enter Point
- | Move Point
- | Leave Point
- | Drag Point Path WidgetDragMsg
- | Drop Point Path WidgetDragMsg
data InputStatus = InputStatus {
- _ipsMousePos :: Point
- _ipsMousePosPrev :: Point
- _ipsKeyMod :: KeyMod
- _ipsKeys :: Map KeyCode KeyStatus
- _ipsButtons :: Map Button ButtonState
}
data KeyMod = KeyMod {
- _kmLeftShift :: Bool
- _kmRightShift :: Bool
- _kmLeftCtrl :: Bool
- _kmRightCtrl :: Bool
- _kmLeftAlt :: Bool
- _kmRightAlt :: Bool
- _kmLeftGUI :: Bool
- _kmRightGUI :: Bool
- _kmNumLock :: Bool
- _kmCapsLock :: Bool
- _kmAltGr :: Bool
}

Documentation

newtype KeyCode Source #

Keycode for keyboard events. Used instead of Scancodes to avoid mappings.

Constructors

KeyCode
Fields unKeyCode :: Int

Instances

Instances details

Eq KeyCode Source #
Instance details Defined in Monomer.Event.Types Methods (==) :: KeyCode -> KeyCode -> Bool # (/=) :: KeyCode -> KeyCode -> Bool #
Ord KeyCode Source #
Instance details Defined in Monomer.Event.Types Methods compare :: KeyCode -> KeyCode -> Ordering # (<) :: KeyCode -> KeyCode -> Bool # (<=) :: KeyCode -> KeyCode -> Bool # (>) :: KeyCode -> KeyCode -> Bool # (>=) :: KeyCode -> KeyCode -> Bool # max :: KeyCode -> KeyCode -> KeyCode # min :: KeyCode -> KeyCode -> KeyCode #
Show KeyCode Source #
Instance details Defined in Monomer.Event.Types Methods showsPrec :: Int -> KeyCode -> ShowS # show :: KeyCode -> String # showList :: [KeyCode] -> ShowS #
HasKeys InputStatus (Map KeyCode KeyStatus) Source #
Instance details Defined in Monomer.Event.Lens Methods keys :: Lens' InputStatus (Map KeyCode KeyStatus) Source #

data KeyStatus Source #

Status of a keyboard key.

Constructors

KeyPressed
KeyReleased

Instances

Instances details

Eq KeyStatus Source #
Instance details Defined in Monomer.Event.Types Methods (==) :: KeyStatus -> KeyStatus -> Bool # (/=) :: KeyStatus -> KeyStatus -> Bool #
Show KeyStatus Source #
Instance details Defined in Monomer.Event.Types Methods showsPrec :: Int -> KeyStatus -> ShowS # show :: KeyStatus -> String # showList :: [KeyStatus] -> ShowS #
HasKeys InputStatus (Map KeyCode KeyStatus) Source #
Instance details Defined in Monomer.Event.Lens Methods keys :: Lens' InputStatus (Map KeyCode KeyStatus) Source #

data Button Source #

Button of a pointer device (mouse).

Constructors

BtnLeft
BtnMiddle
BtnRight

Instances

Instances details

Eq Button Source #
Instance details Defined in Monomer.Event.Types Methods (==) :: Button -> Button -> Bool # (/=) :: Button -> Button -> Bool #
Ord Button Source #
Instance details Defined in Monomer.Event.Types Methods compare :: Button -> Button -> Ordering # (<) :: Button -> Button -> Bool # (<=) :: Button -> Button -> Bool # (>) :: Button -> Button -> Bool # (>=) :: Button -> Button -> Bool # max :: Button -> Button -> Button # min :: Button -> Button -> Button #
Show Button Source #
Instance details Defined in Monomer.Event.Types Methods showsPrec :: Int -> Button -> ShowS # show :: Button -> String # showList :: [Button] -> ShowS #
HasButtons InputStatus (Map Button ButtonState) Source #
Instance details Defined in Monomer.Event.Lens Methods buttons :: Lens' InputStatus (Map Button ButtonState) Source #
HasMainButton (AppConfig e) (Maybe Button) Source #
Instance details Defined in Monomer.Main.Lens Methods mainButton :: Lens' (AppConfig e) (Maybe Button) Source #
HasContextButton (AppConfig e) (Maybe Button) Source #
Instance details Defined in Monomer.Main.Lens Methods contextButton :: Lens' (AppConfig e) (Maybe Button) Source #
HasMainButton (WidgetEnv s e) Button Source #
Instance details Defined in Monomer.Core.Lens Methods mainButton :: Lens' (WidgetEnv s e) Button Source #
HasContextButton (WidgetEnv s e) Button Source #
Instance details Defined in Monomer.Core.Lens Methods contextButton :: Lens' (WidgetEnv s e) Button Source #

data ButtonState Source #

Status of a mouse button.

Constructors

BtnPressed
BtnReleased

Instances

Instances details

Eq ButtonState Source #
Instance details Defined in Monomer.Event.Types Methods (==) :: ButtonState -> ButtonState -> Bool # (/=) :: ButtonState -> ButtonState -> Bool #
Show ButtonState Source #
Instance details Defined in Monomer.Event.Types Methods showsPrec :: Int -> ButtonState -> ShowS # show :: ButtonState -> String # showList :: [ButtonState] -> ShowS #
HasButtons InputStatus (Map Button ButtonState) Source #
Instance details Defined in Monomer.Event.Lens Methods buttons :: Lens' InputStatus (Map Button ButtonState) Source #

data WheelDirection Source #

Movement direction in which wheel values are positive.

Constructors

WheelNormal
WheelFlipped

Instances

Instances details

Eq WheelDirection Source #
Instance details Defined in Monomer.Event.Types Methods (==) :: WheelDirection -> WheelDirection -> Bool # (/=) :: WheelDirection -> WheelDirection -> Bool #
Show WheelDirection Source #
Instance details Defined in Monomer.Event.Types Methods showsPrec :: Int -> WheelDirection -> ShowS # show :: WheelDirection -> String # showList :: [WheelDirection] -> ShowS #

data ClipboardData Source #

Types of clipboard content.

Constructors

ClipboardEmpty
ClipboardText Text

Instances

Instances details

Eq ClipboardData Source #
Instance details Defined in Monomer.Event.Types Methods (==) :: ClipboardData -> ClipboardData -> Bool # (/=) :: ClipboardData -> ClipboardData -> Bool #
Show ClipboardData Source #
Instance details Defined in Monomer.Event.Types Methods showsPrec :: Int -> ClipboardData -> ShowS # show :: ClipboardData -> String # showList :: [ClipboardData] -> ShowS #

type DragMsg i = (Eq i, Typeable i) Source #

Constraints for drag event messages.

data WidgetDragMsg Source #

Drag message container.

Constructors

forall i.DragMsg i => WidgetDragMsg i

Instances

Instances details

Eq WidgetDragMsg Source #
Instance details Defined in Monomer.Event.Types Methods (==) :: WidgetDragMsg -> WidgetDragMsg -> Bool # (/=) :: WidgetDragMsg -> WidgetDragMsg -> Bool #
Show WidgetDragMsg Source #
Instance details Defined in Monomer.Event.Types Methods showsPrec :: Int -> WidgetDragMsg -> ShowS # show :: WidgetDragMsg -> String # showList :: [WidgetDragMsg] -> ShowS #
HasDragData DragAction WidgetDragMsg Source #
Instance details Defined in Monomer.Main.Lens Methods dragData :: Lens' DragAction WidgetDragMsg Source #
HasDragStatus (WidgetEnv s e) (Maybe (Path, WidgetDragMsg)) Source #
Instance details Defined in Monomer.Core.Lens Methods dragStatus :: Lens' (WidgetEnv s e) (Maybe (Path, WidgetDragMsg)) Source #

data SystemEvent Source #

Supported Monomer SystemEvents

Constructors

Click Point Button Int	Click (press and release) of a mouse button. Includes mouse position and click count.
ButtonAction Point Button ButtonState Int	Click or release of a mouse button. Includes times pressed/released and mouse position.
WheelScroll Point Point WheelDirection	Mouse wheel movement. Includes mouse position, move size in both axes and wheel direction.
KeyAction KeyMod KeyCode KeyStatus	Keyboard key action. Includes modifiers, keyCode and pressed/released. This event should not be used for text input.
TextInput Text	Processed keyboard events. Some Unicode characters require several key presses to produce the result. This event provides the final result.
Clipboard ClipboardData	Provides current clipboard contents to a requesting widget.
Focus Path	Target now has focus. Includes path of the previously focused widget.
Blur Path	Target has lost focus. Includes path of the next focused widget.
Enter Point	Mouse has entered the assigned viewport.
Move Point	Mouse has moved inside the assigned viewport. This event keeps being received if the main mouse button is pressed, even if the mouse is outside the assigned bounds or even the window.
Leave Point	Mouse has left the assigned viewport. This event is not received until the main mouse button has been pressed.
Drag Point Path WidgetDragMsg	A drag action is active and the mouse is inside the current viewport. The messsage can be used to decide if it applies to the current widget. This event is not received by the widget which initiated the drag action, even if dragging over it.
Drop Point Path WidgetDragMsg	A drag action was active and the main button was released inside the current viewport.

Instances

Instances details

Eq SystemEvent Source #
Instance details Defined in Monomer.Event.Types Methods (==) :: SystemEvent -> SystemEvent -> Bool # (/=) :: SystemEvent -> SystemEvent -> Bool #
Show SystemEvent Source #
Instance details Defined in Monomer.Event.Types Methods showsPrec :: Int -> SystemEvent -> ShowS # show :: SystemEvent -> String # showList :: [SystemEvent] -> ShowS #

data InputStatus Source #

Status of input devices.

Constructors

InputStatus
Fields _ipsMousePos :: Point Mouse position. _ipsMousePosPrev :: Point Previous mouse position. _ipsKeyMod :: KeyMod Current key modifiers (shift, ctrl, alt, etc). _ipsKeys :: Map KeyCode KeyStatus Current status of keyCodes. If not in the map, status is KeyReleased. _ipsButtons :: Map Button ButtonState Status of mouse buttons. If not in the map, status is BtnReleased.

Instances

Instances details

Eq InputStatus Source #
Instance details Defined in Monomer.Event.Types Methods (==) :: InputStatus -> InputStatus -> Bool # (/=) :: InputStatus -> InputStatus -> Bool #
Show InputStatus Source #
Instance details Defined in Monomer.Event.Types Methods showsPrec :: Int -> InputStatus -> ShowS # show :: InputStatus -> String # showList :: [InputStatus] -> ShowS #
Default InputStatus Source #
Instance details Defined in Monomer.Event.Types Methods def :: InputStatus #
HasMousePosPrev InputStatus Point Source #
Instance details Defined in Monomer.Event.Lens Methods mousePosPrev :: Lens' InputStatus Point Source #
HasMousePos InputStatus Point Source #
Instance details Defined in Monomer.Event.Lens Methods mousePos :: Lens' InputStatus Point Source #
HasKeyMod InputStatus KeyMod Source #
Instance details Defined in Monomer.Event.Lens Methods keyMod :: Lens' InputStatus KeyMod Source #
HasKeys InputStatus (Map KeyCode KeyStatus) Source #
Instance details Defined in Monomer.Event.Lens Methods keys :: Lens' InputStatus (Map KeyCode KeyStatus) Source #
HasButtons InputStatus (Map Button ButtonState) Source #
Instance details Defined in Monomer.Event.Lens Methods buttons :: Lens' InputStatus (Map Button ButtonState) Source #
HasInputStatus (WidgetEnv s e) InputStatus Source #
Instance details Defined in Monomer.Core.Lens Methods inputStatus :: Lens' (WidgetEnv s e) InputStatus Source #
HasInputStatus (MonomerCtx s e) InputStatus Source #
Instance details Defined in Monomer.Main.Lens Methods inputStatus :: Lens' (MonomerCtx s e) InputStatus Source #

data KeyMod Source #

Keyboard modifiers. True indicates the key is pressed.

Note: The fn function in Macs cannot be detected individually.

Constructors

KeyMod
Fields _kmLeftShift :: Bool _kmRightShift :: Bool _kmLeftCtrl :: Bool _kmRightCtrl :: Bool _kmLeftAlt :: Bool _kmRightAlt :: Bool _kmLeftGUI :: Bool _kmRightGUI :: Bool _kmNumLock :: Bool _kmCapsLock :: Bool _kmAltGr :: Bool

Instances

Instances details

Eq KeyMod Source #
Instance details Defined in Monomer.Event.Types Methods (==) :: KeyMod -> KeyMod -> Bool # (/=) :: KeyMod -> KeyMod -> Bool #
Show KeyMod Source #
Instance details Defined in Monomer.Event.Types Methods showsPrec :: Int -> KeyMod -> ShowS # show :: KeyMod -> String # showList :: [KeyMod] -> ShowS #
Default KeyMod Source #
Instance details Defined in Monomer.Event.Types Methods def :: KeyMod #
HasKeyMod InputStatus KeyMod Source #
Instance details Defined in Monomer.Event.Lens Methods keyMod :: Lens' InputStatus KeyMod Source #
HasRightShift KeyMod Bool Source #
Instance details Defined in Monomer.Event.Lens Methods rightShift :: Lens' KeyMod Bool Source #
HasRightGUI KeyMod Bool Source #
Instance details Defined in Monomer.Event.Lens Methods rightGUI :: Lens' KeyMod Bool Source #
HasRightCtrl KeyMod Bool Source #
Instance details Defined in Monomer.Event.Lens Methods rightCtrl :: Lens' KeyMod Bool Source #
HasRightAlt KeyMod Bool Source #
Instance details Defined in Monomer.Event.Lens Methods rightAlt :: Lens' KeyMod Bool Source #
HasNumLock KeyMod Bool Source #
Instance details Defined in Monomer.Event.Lens Methods numLock :: Lens' KeyMod Bool Source #
HasLeftShift KeyMod Bool Source #
Instance details Defined in Monomer.Event.Lens Methods leftShift :: Lens' KeyMod Bool Source #
HasLeftGUI KeyMod Bool Source #
Instance details Defined in Monomer.Event.Lens Methods leftGUI :: Lens' KeyMod Bool Source #
HasLeftCtrl KeyMod Bool Source #
Instance details Defined in Monomer.Event.Lens Methods leftCtrl :: Lens' KeyMod Bool Source #
HasLeftAlt KeyMod Bool Source #
Instance details Defined in Monomer.Event.Lens Methods leftAlt :: Lens' KeyMod Bool Source #
HasCapsLock KeyMod Bool Source #
Instance details Defined in Monomer.Event.Lens Methods capsLock :: Lens' KeyMod Bool Source #
HasAltGr KeyMod Bool Source #
Instance details Defined in Monomer.Event.Lens Methods altGr :: Lens' KeyMod Bool Source #