NCurses.Core.Input

Definitions

cBreak : HasIO io => io ()

  Switch keyboard input to cbreak mode.
  
  In cbreak mode, characters are sent to the program
  immediately instead of waiting for a newline to be
  entered. This is the opposite of how most terminals
  accept input by default during normal operation.

Visibility: export

noCBreak : HasIO io => io ()

  Switch keyboard input out of cbreak mode.
  
  In cbreak mode, characters are sent to the program
  immediately instead of waiting for a newline to be
  entered. This is the opposite of how most terminals
  accept input by default during normal operation.

Visibility: export

echo : HasIO io => io ()

  Switch keyboard input to echo mode.

Visibility: export

noEcho : HasIO io => io ()

  Switch keyboard input to noecho mode.

Visibility: export

noDelay' : HasIO io => Window -> Bool -> io ()

  @noDelay'@ controls whether @getCh@ is blocking or not.
  When noDelay is False, @getCh@ will wait until the user types. Otherwise, @getCh@
  returns immediately and returns an error value. Use @safeGetCh@ with @noDelay@ on to
  turn those error values into @Nothing@.

Visibility: export

noDelay : HasIO io => Bool -> io ()

  @noDelay@ controls whether @getCh@ is blocking or not.
  When noDelay is False, @getCh@ will wait until the user types. Otherwise, @getCh@
  returns immediately and returns an error value. Use @safeGetCh@ with @noDelay@ on to
  turn those error values into @Nothing@.

Visibility: export

getCh : HasIO io => io Char

  Get a single character. 
  
  If cbreak mode is on, the character is returned
  immediately. This contrasts with a read from
  the default shell `stdin` which will wait until a
  newline to flush its buffer and send input to a
  program.

Visibility: export

getCh' : HasIO io => Window -> io Char

  Get a single character from the given window. 
  
  If cbreak mode is on, the character is returned
  immediately. This contrasts with a read from
  the default shell `stdin` which will wait until a
  newline to flush its buffer and send input to a
  program.

Visibility: export

safeGetCh : HasIO io => io (Maybe Char)

  Get a single character or Nothing on error. 
  
  If cbreak mode is on, the character is returned
  immediately. This contrasts with a read from
  the default shell `stdin` which will wait until a
  newline to flush its buffer and send input to a
  program.

Visibility: export

safeGetCh' : HasIO io => Window -> io (Maybe Char)

  Get a single character from the given window or Nothing
  on error. 
  
  If cbreak mode is on, the character is returned
  immediately. This contrasts with a read from
  the default shell `stdin` which will wait until a
  newline to flush its buffer and send input to a
  program.

Visibility: export

data CursorVisibility : Type

Totality: total
Visibility: public export
Constructors:

CInvisible : CursorVisibility

CNormal : CursorVisibility

CHighlyVisible : CursorVisibility

setCursorVisibility : HasIO io => CursorVisibility -> io ()

  Set the visibility of the cursor.

Visibility: export