Events.md

November 2, 2015 · View on GitHub

Module Data.DOM.Simple.Events

`Read`

class Read s where
  read :: String -> s

Instances

instance mouseEventTypeRead :: Read MouseEventType
instance keyboardEventTypeRead :: Read KeyboardEventType
instance uiEventTypeRead :: Read UIEventType

`Event`

class Event e where
  eventTarget :: forall eff a. e -> Eff (dom :: DOM | eff) a
  stopPropagation :: forall eff. e -> Eff (dom :: DOM | eff) Unit
  preventDefault :: forall eff. e -> Eff (dom :: DOM | eff) Unit

Instances

instance eventDOMEvent :: Event DOMEvent

`MouseEventType`

data MouseEventType
  = MouseMoveEvent
  | MouseOverEvent
  | MouseEnterEvent
  | MouseOutEvent
  | MouseLeaveEvent
  | MouseClickEvent
  | MouseDblClickEvent
  | MouseUpEvent
  | MouseDownEvent
  | MouseUnknownEvent String

Instances

instance mouseEventTypeShow :: Show MouseEventType
instance mouseEventTypeRead :: Read MouseEventType

`MouseEvent`

class (Event e) <= MouseEvent e where
  mouseEventType :: forall eff. e -> Eff (dom :: DOM | eff) MouseEventType
  screenX :: forall eff. e -> Eff (dom :: DOM | eff) Int
  screenY :: forall eff. e -> Eff (dom :: DOM | eff) Int
  clientX :: forall eff. e -> Eff (dom :: DOM | eff) Int
  clientY :: forall eff. e -> Eff (dom :: DOM | eff) Int

Instances

instance mouseEventDOMEvent :: MouseEvent DOMEvent

`MouseEventTarget`

class MouseEventTarget b where
  addMouseEventListener :: forall e t ta. (MouseEvent e) => MouseEventType -> (e -> Eff (dom :: DOM | t) Unit) -> b -> Eff (dom :: DOM | ta) Unit
  removeMouseEventListener :: forall e t ta. (MouseEvent e) => MouseEventType -> (e -> Eff (dom :: DOM | t) Unit) -> b -> Eff (dom :: DOM | ta) Unit

Instances

instance mouseEventTargetHTMLWindow :: MouseEventTarget HTMLWindow
instance mouseEventTargetHTMLDocument :: MouseEventTarget HTMLDocument
instance mouseEventTargetHTMLElement :: MouseEventTarget HTMLElement

`KeyboardEventType`

data KeyboardEventType
  = KeydownEvent
  | KeypressEvent
  | KeyupEvent
  | KeyUnknownEvent String

Instances

instance keyboardEventTypeShow :: Show KeyboardEventType
instance keyboardEventTypeRead :: Read KeyboardEventType

`KeyLocation`

data KeyLocation
  = KeyLocationStandard
  | KeyLocationLeft
  | KeyLocationRight
  | KeyLocationNumpad
  | KeyLocationUnknown Int

`toKeyLocation`

toKeyLocation :: Int -> KeyLocation

`KeyboardEvent`

class (Event e) <= KeyboardEvent e where
  keyboardEventType :: forall eff. e -> Eff (dom :: DOM | eff) KeyboardEventType
  key :: forall eff. e -> Eff (dom :: DOM | eff) String
  keyCode :: forall eff. e -> Eff (dom :: DOM | eff) Int
  keyLocation :: forall eff. e -> Eff (dom :: DOM | eff) KeyLocation
  altKey :: forall eff. e -> Eff (dom :: DOM | eff) Boolean
  ctrlKey :: forall eff. e -> Eff (dom :: DOM | eff) Boolean
  metaKey :: forall eff. e -> Eff (dom :: DOM | eff) Boolean
  shiftKey :: forall eff. e -> Eff (dom :: DOM | eff) Boolean

Instances

instance keyboardEventDOMEvent :: KeyboardEvent DOMEvent

`KeyboardEventTarget`

class KeyboardEventTarget b where
  addKeyboardEventListener :: forall e t ta. (KeyboardEvent e) => KeyboardEventType -> (e -> Eff (dom :: DOM | t) Unit) -> b -> Eff (dom :: DOM | ta) Unit
  removeKeyboardEventListener :: forall e t ta. (KeyboardEvent e) => KeyboardEventType -> (e -> Eff (dom :: DOM | t) Unit) -> b -> Eff (dom :: DOM | ta) Unit

Instances

instance keyboardEventTargetHTMLWindow :: KeyboardEventTarget HTMLWindow
instance keyboardEventTargetHTMLDocument :: KeyboardEventTarget HTMLDocument
instance keyboardEventTargetHTMLElement :: KeyboardEventTarget HTMLElement

`UIEventType`

data UIEventType
  = LoadEvent
  | UnloadEvent
  | AbortEvent
  | ErrorEvent
  | SelectEvent
  | ResizeEvent
  | ScrollEvent
  | UnknownEvent String

Instances

instance uiEventTypeShow :: Show UIEventType
instance uiEventTypeRead :: Read UIEventType

`UIEvent`

class (Event e) <= UIEvent e where
  view :: forall eff. e -> Eff (dom :: DOM | eff) HTMLWindow
  detail :: forall eff. e -> Eff (dom :: DOM | eff) Int

Instances

instance uiEventDOMEvent :: UIEvent DOMEvent

`UIEventTarget`

class UIEventTarget b where
  addUIEventListener :: forall e t ta. (UIEvent e) => UIEventType -> (e -> Eff (dom :: DOM | t) Unit) -> b -> Eff (dom :: DOM | ta) Unit
  removeUIEventListener :: forall e t ta. (UIEvent e) => UIEventType -> (e -> Eff (dom :: DOM | t) Unit) -> b -> Eff (dom :: DOM | ta) Unit

Instances

instance uiEventTargetHTMLWindow :: UIEventTarget HTMLWindow