java.lang.Object | ||
↳ | java.lang.Enum<E extends java.lang.Enum<E>> | |
↳ | jline.WindowsTerminal.ConsoleMode |
Console mode
Constants copied wincon.h.Enum Values | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
WindowsTerminal.ConsoleMode | ENABLE_ECHO_INPUT | Characters read by the ReadFile or ReadConsole function are written to the active screen buffer as they are read. | |||||||||
WindowsTerminal.ConsoleMode | ENABLE_LINE_INPUT | The ReadFile or ReadConsole function returns only when a carriage return character is read. | |||||||||
WindowsTerminal.ConsoleMode | 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. | |||||||||
WindowsTerminal.ConsoleMode | ENABLE_PROCESSED_INPUT | CTRL+C is processed by the system and is not placed in the input buffer. | |||||||||
WindowsTerminal.ConsoleMode | ENABLE_PROCESSED_OUTPUT | 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. | |||||||||
WindowsTerminal.ConsoleMode | ENABLE_WINDOW_INPUT | User interactions that change the size of the console screen buffer are reported in the console's input buffee. | |||||||||
WindowsTerminal.ConsoleMode | ENABLE_WRAP_AT_EOL_OUTPUT | This flag enables the user to use the mouse to select and edit text. |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
code |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() |
Characters read by the ReadFile or ReadConsole function are written to the active screen buffer as they are read. This mode can be used only if the ENABLE_LINE_INPUT mode is also enabled.
The ReadFile or ReadConsole function returns only when a carriage return character is read. If this mode is disable, the functions return when one or more characters are available.
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.
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 linefeed characters are handled by the system.
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. An OR operation must be performed with this flag and the ENABLE_EXTENDED_FLAGS flag to enable this functionality.
User interactions that change the size of the console screen buffer are reported in the console's input buffee. Information about these events can be read from the input buffer by applications using theReadConsoleInput function, but not by those using ReadFile orReadConsole.
This flag enables the user to use the mouse to select and edit text. To enable this option, use the OR to combine this flag with ENABLE_EXTENDED_FLAGS.