CX Framework
Cross-platform C utility framework
Loading...
Searching...
No Matches
conin.h File Reference

Keyboard input: raw mode, key decoding, line/password reading. More...

#include <cx/time/time.h>
#include "console.h"

Go to the source code of this file.

Data Structures

struct  ConKeyEvent
 A single decoded key press. More...
 

Typedefs

typedef enum ConKey ConKey
 Logical key identity, independent of the byte/escape sequence a terminal happened to send.
 
typedef struct ConKeyEvent ConKeyEvent
 A single decoded key press.
 
typedef enum ConInputMode ConInputMode
 Input mode for a stream. See conSetMode().
 

Enumerations

enum  ConKey { CON_Key_None = 0 , CON_Key_Char , CON_Key_Enter , CON_Key_Tab , CON_Key_Backspace , CON_Key_Escape , CON_Key_Up , CON_Key_Down , CON_Key_Left , CON_Key_Right , CON_Key_Home , CON_Key_End , CON_Key_PageUp , CON_Key_PageDown , CON_Key_Insert , CON_Key_Delete , CON_Key_F1 , CON_Key_F2 , CON_Key_F3 , CON_Key_F4 , CON_Key_F5 , CON_Key_F6 , CON_Key_F7 , CON_Key_F8 , CON_Key_F9 , CON_Key_F10 , CON_Key_F11 , CON_Key_F12 , CON_Key_Resize }
 Logical key identity, independent of the byte/escape sequence a terminal happened to send. More...
 
enum  CON_MOD_FLAGS
 Modifier flags for ConKeyEvent::mods.
 
enum  ConInputMode { CON_Cooked , CON_Raw }
 Input mode for a stream. See conSetMode(). More...
 

Functions

bool conSetMode (ConStream *con, ConInputMode mode)
 
bool conSetEcho (ConStream *con, bool echo)
 
bool conInWait (ConStream *con, int64 timeout)
 
bool conReadKey (ConStream *con, ConKeyEvent *out, int64 timeout)
 
bool conReadLine (ConStream *con, string *out)
 
bool conReadPassword (ConStream *con, string *out)
 

Detailed Description

Keyboard input: raw mode, key decoding, line/password reading.

Definition in file conin.h.