java.lang.Object
- java.lang.Enum<InputModeFlags>
- - xyz.cofe.term.win.InputModeFlags

All Implemented Interfaces:: Serializable, Comparable<InputModeFlags>, BitFlag

public enum InputModeFlags
extends Enum<InputModeFlags>
implements BitFlag

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ENABLE_ECHO_INPUT`	Characters read by the ReadFile or ReadConsole function are written to the active screen buffer as they are typed into the console.
`ENABLE_INSERT_MODE`	When enabled, text entered in a console window will be inserted at the current cursor location and all text following that location will not be overwritten.
`ENABLE_LINE_INPUT`	The ReadFile or ReadConsole function returns only when a carriage return character is read.
`ENABLE_MOUSE_INPUT`	If the mouse pointer is within the borders of the console window and the window has the keyboard focus, mouse events generated by mouse movement and button presses are placed in the input buffer.
`ENABLE_PROCESSED_INPUT`	CTRL+C is processed by the system and is not placed in the input buffer.
`ENABLE_QUICK_EDIT_MODE`	This flag enables the user to use the mouse to select and edit text.
`ENABLE_VIRTUAL_TERMINAL_INPUT`	Setting this flag directs the Virtual Terminal processing engine to convert user input received by the console window into Console Virtual Terminal Sequences that can be retrieved by a supporting application through ReadFile or ReadConsole functions.
`ENABLE_WINDOW_INPUT`	User interactions that change the size of the console screen buffer are reported in the console's input buffer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`bitFlag()`
`static InputModeFlags`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static InputModeFlags[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface xyz.cofe.term.win.BitFlag
has, update

- Enum Constant Detail
  - ENABLE_ECHO_INPUT
```
public static final InputModeFlags ENABLE_ECHO_INPUT
```
    Characters read by the ReadFile or ReadConsole function are written to the active screen buffer as they are typed into the console.
    This mode can be used only if the ENABLE_LINE_INPUT mode is also enabled.
  - ENABLE_INSERT_MODE
```
public static final InputModeFlags ENABLE_INSERT_MODE
```
    When enabled, text entered in a console window will be inserted at the current cursor location and all text following that location will not be overwritten.
    When disabled, all following text will be overwritten.
  - ENABLE_LINE_INPUT
```
public static final InputModeFlags ENABLE_LINE_INPUT
```
    The ReadFile or ReadConsole function returns only when a carriage return character is read.
    If this mode is disabled, the functions return when one or more characters are available.
  - ENABLE_MOUSE_INPUT
```
public static final InputModeFlags ENABLE_MOUSE_INPUT
```
    If the mouse pointer is within the borders of the console window and the window has the keyboard focus, mouse events generated by mouse movement and button presses are placed in the input buffer.
    These events are discarded by ReadFile or ReadConsole, even when this mode is enabled.
    The ReadConsoleInput function can be used to read MOUSE_EVENT input records from the input buffer.
  - ENABLE_PROCESSED_INPUT
```
public static final InputModeFlags ENABLE_PROCESSED_INPUT
```
    CTRL+C is processed by the system and is not placed in the input buffer.
    If the input buffer is being read by ReadFile or ReadConsole, other control keys are processed by the system and are not returned in the ReadFile or ReadConsole buffer.
    If the ENABLE_LINE_INPUT mode is also enabled, backspace, carriage return, and line feed characters are handled by the system.
  - ENABLE_QUICK_EDIT_MODE
```
public static final InputModeFlags ENABLE_QUICK_EDIT_MODE
```
    This flag enables the user to use the mouse to select and edit text.
    To enable this mode, use ENABLE_QUICK_EDIT_MODE | ENABLE_EXTENDED_FLAGS.
    To disable this mode, use ENABLE_EXTENDED_FLAGS without this flag.
  - ENABLE_WINDOW_INPUT
```
public static final InputModeFlags ENABLE_WINDOW_INPUT
```
    User interactions that change the size of the console screen buffer are reported in the console's input buffer.
    Information about these events can be read from the input buffer by applications using the ReadConsoleInput function, but not by those using ReadFile or ReadConsole.
  - ENABLE_VIRTUAL_TERMINAL_INPUT
```
public static final InputModeFlags ENABLE_VIRTUAL_TERMINAL_INPUT
```
    Setting this flag directs the Virtual Terminal processing engine to convert user input received by the console window into Console Virtual Terminal Sequences that can be retrieved by a supporting application through ReadFile or ReadConsole functions.
    The typical usage of this flag is intended in conjunction with ENABLE_VIRTUAL_TERMINAL_PROCESSING on the output handle to connect to an application that communicates exclusively via virtual terminal sequences.
- Method Detail
  - values
```
public static InputModeFlags[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (InputModeFlags c : InputModeFlags.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static InputModeFlags valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - bitFlag
```
public int bitFlag()
```
    Specified by:
    
    bitFlag in interface BitFlag

Enum InputModeFlags

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface xyz.cofe.term.win.BitFlag

Enum Constant Detail

ENABLE_ECHO_INPUT

ENABLE_INSERT_MODE

ENABLE_LINE_INPUT

ENABLE_MOUSE_INPUT

ENABLE_PROCESSED_INPUT

ENABLE_QUICK_EDIT_MODE

ENABLE_WINDOW_INPUT

ENABLE_VIRTUAL_TERMINAL_INPUT

Method Detail

values

valueOf

bitFlag