Safe Haskell	Safe-Inferred
Language	Haskell2010

Graphics.Vty.Platform.Windows.WindowsConsoleInput

Description

This module provides a function to obtain input events from the Win32 API

Synopsis

data KeyEventRecord = KeyEventRecordC {
- keyDown :: BOOL
- repeatCount :: WORD
- virtualKeyCode :: WORD
- virtualScanCode :: WORD
- uChar :: CWchar
- controlKeyStateK :: DWORD
}
data MouseEventRecord = MouseEventRecordC {
- mousePosition :: COORD
- buttonState :: DWORD
- controlKeyStateM :: DWORD
- eventFlags :: DWORD
}
newtype WindowBufferSizeRecord = WindowBufferSizeRecordC {
- windowSize :: COORD
}
newtype MenuEventRecord = MenuEventRecordC {
- commandId :: UINT
}
newtype FocusEventRecord = FocusEventRecordC {
- setFocus :: BOOL
}
data WinConsoleInputEvent
readConsoleInput :: Ptr WinConsoleInputEvent -> Int -> Handle -> IO [WinConsoleInputEvent]

Documentation

data KeyEventRecord Source #

This type represents a keyboard input event. The structure is documented here: https://learn.microsoft.com/en-us/windows/console/key-event-record-str

Constructors

KeyEventRecordC
Fields keyDown :: BOOL repeatCount :: WORD virtualKeyCode :: WORD virtualScanCode :: WORD uChar :: CWchar controlKeyStateK :: DWORD

Instances

Instances details

Storable KeyEventRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods sizeOf :: KeyEventRecord -> Int alignment :: KeyEventRecord -> Int peekElemOff :: Ptr KeyEventRecord -> Int -> IO KeyEventRecord pokeElemOff :: Ptr KeyEventRecord -> Int -> KeyEventRecord -> IO () peekByteOff :: Ptr b -> Int -> IO KeyEventRecord pokeByteOff :: Ptr b -> Int -> KeyEventRecord -> IO () peek :: Ptr KeyEventRecord -> IO KeyEventRecord poke :: Ptr KeyEventRecord -> KeyEventRecord -> IO ()
Show KeyEventRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods showsPrec :: Int -> KeyEventRecord -> ShowS show :: KeyEventRecord -> String showList :: [KeyEventRecord] -> ShowS
Eq KeyEventRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods (==) :: KeyEventRecord -> KeyEventRecord -> Bool (/=) :: KeyEventRecord -> KeyEventRecord -> Bool

data MouseEventRecord Source #

This type represents a mouse event. The structure is documented here: https://learn.microsoft.com/en-us/windows/console/mouse-event-record-str

Constructors

MouseEventRecordC
Fields mousePosition :: COORD buttonState :: DWORD controlKeyStateM :: DWORD eventFlags :: DWORD

Instances

Instances details

Storable MouseEventRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods sizeOf :: MouseEventRecord -> Int alignment :: MouseEventRecord -> Int peekElemOff :: Ptr MouseEventRecord -> Int -> IO MouseEventRecord pokeElemOff :: Ptr MouseEventRecord -> Int -> MouseEventRecord -> IO () peekByteOff :: Ptr b -> Int -> IO MouseEventRecord pokeByteOff :: Ptr b -> Int -> MouseEventRecord -> IO () peek :: Ptr MouseEventRecord -> IO MouseEventRecord poke :: Ptr MouseEventRecord -> MouseEventRecord -> IO ()
Show MouseEventRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods showsPrec :: Int -> MouseEventRecord -> ShowS show :: MouseEventRecord -> String showList :: [MouseEventRecord] -> ShowS
Eq MouseEventRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods (==) :: MouseEventRecord -> MouseEventRecord -> Bool (/=) :: MouseEventRecord -> MouseEventRecord -> Bool

newtype WindowBufferSizeRecord Source #

This type represents a window size change event. The structure is documented here: https://learn.microsoft.com/en-us/windows/console/window-buffer-size-record-str

Constructors

WindowBufferSizeRecordC
Fields windowSize :: COORD

Instances

Instances details

Storable WindowBufferSizeRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods sizeOf :: WindowBufferSizeRecord -> Int alignment :: WindowBufferSizeRecord -> Int peekElemOff :: Ptr WindowBufferSizeRecord -> Int -> IO WindowBufferSizeRecord pokeElemOff :: Ptr WindowBufferSizeRecord -> Int -> WindowBufferSizeRecord -> IO () peekByteOff :: Ptr b -> Int -> IO WindowBufferSizeRecord pokeByteOff :: Ptr b -> Int -> WindowBufferSizeRecord -> IO () peek :: Ptr WindowBufferSizeRecord -> IO WindowBufferSizeRecord poke :: Ptr WindowBufferSizeRecord -> WindowBufferSizeRecord -> IO ()
Show WindowBufferSizeRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods showsPrec :: Int -> WindowBufferSizeRecord -> ShowS show :: WindowBufferSizeRecord -> String showList :: [WindowBufferSizeRecord] -> ShowS
Eq WindowBufferSizeRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods (==) :: WindowBufferSizeRecord -> WindowBufferSizeRecord -> Bool (/=) :: WindowBufferSizeRecord -> WindowBufferSizeRecord -> Bool

newtype MenuEventRecord Source #

This type represents a window menu event. (Current ignored by VTY). The structure is documented here: https://learn.microsoft.com/en-us/windows/console/menu-event-record-str

Constructors

MenuEventRecordC
Fields commandId :: UINT

Instances

Instances details

Storable MenuEventRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods sizeOf :: MenuEventRecord -> Int alignment :: MenuEventRecord -> Int peekElemOff :: Ptr MenuEventRecord -> Int -> IO MenuEventRecord pokeElemOff :: Ptr MenuEventRecord -> Int -> MenuEventRecord -> IO () peekByteOff :: Ptr b -> Int -> IO MenuEventRecord pokeByteOff :: Ptr b -> Int -> MenuEventRecord -> IO () peek :: Ptr MenuEventRecord -> IO MenuEventRecord poke :: Ptr MenuEventRecord -> MenuEventRecord -> IO ()
Show MenuEventRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods showsPrec :: Int -> MenuEventRecord -> ShowS show :: MenuEventRecord -> String showList :: [MenuEventRecord] -> ShowS
Eq MenuEventRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods (==) :: MenuEventRecord -> MenuEventRecord -> Bool (/=) :: MenuEventRecord -> MenuEventRecord -> Bool

newtype FocusEventRecord Source #

This type represents a window focus change event. The structure is documented here: https://learn.microsoft.com/en-us/windows/console/focus-event-record-str

Constructors

FocusEventRecordC
Fields setFocus :: BOOL

Instances

Instances details

Storable FocusEventRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods sizeOf :: FocusEventRecord -> Int alignment :: FocusEventRecord -> Int peekElemOff :: Ptr FocusEventRecord -> Int -> IO FocusEventRecord pokeElemOff :: Ptr FocusEventRecord -> Int -> FocusEventRecord -> IO () peekByteOff :: Ptr b -> Int -> IO FocusEventRecord pokeByteOff :: Ptr b -> Int -> FocusEventRecord -> IO () peek :: Ptr FocusEventRecord -> IO FocusEventRecord poke :: Ptr FocusEventRecord -> FocusEventRecord -> IO ()
Show FocusEventRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods showsPrec :: Int -> FocusEventRecord -> ShowS show :: FocusEventRecord -> String showList :: [FocusEventRecord] -> ShowS
Eq FocusEventRecord Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods (==) :: FocusEventRecord -> FocusEventRecord -> Bool (/=) :: FocusEventRecord -> FocusEventRecord -> Bool

data WinConsoleInputEvent Source #

Description of a Windows console input event. Documented here: https://learn.microsoft.com/en-us/windows/console/input-record-str

Constructors

KeyEventRecordU KeyEventRecord
MouseEventRecordU MouseEventRecord
WindowBufferSizeRecordU WindowBufferSizeRecord
MenuEventRecordU MenuEventRecord
FocusEventRecordU FocusEventRecord

Instances

Instances details

Storable WinConsoleInputEvent Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods sizeOf :: WinConsoleInputEvent -> Int alignment :: WinConsoleInputEvent -> Int peekElemOff :: Ptr WinConsoleInputEvent -> Int -> IO WinConsoleInputEvent pokeElemOff :: Ptr WinConsoleInputEvent -> Int -> WinConsoleInputEvent -> IO () peekByteOff :: Ptr b -> Int -> IO WinConsoleInputEvent pokeByteOff :: Ptr b -> Int -> WinConsoleInputEvent -> IO () peek :: Ptr WinConsoleInputEvent -> IO WinConsoleInputEvent poke :: Ptr WinConsoleInputEvent -> WinConsoleInputEvent -> IO ()
Show WinConsoleInputEvent Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods showsPrec :: Int -> WinConsoleInputEvent -> ShowS show :: WinConsoleInputEvent -> String showList :: [WinConsoleInputEvent] -> ShowS
Eq WinConsoleInputEvent Source #
Instance details Defined in Graphics.Vty.Platform.Windows.WindowsConsoleInput Methods (==) :: WinConsoleInputEvent -> WinConsoleInputEvent -> Bool (/=) :: WinConsoleInputEvent -> WinConsoleInputEvent -> Bool

readConsoleInput :: Ptr WinConsoleInputEvent -> Int -> Handle -> IO [WinConsoleInputEvent] Source #

A wrapper for the ReadConsoleInput Win32 API as documented here: https://learn.microsoft.com/en-us/windows/console/readconsoleinput