Provides data for the console::cancel_key_press event. This class cannot be inherited.
- Header
#include <xtd/console_cancel_event_args>
- Namespace
- xtd
- Library
- xtd.core
- Examples:
- console_read_key.cpp.
|
bool | cancel () const noexcept |
| Gets a value that indicates whether simultaneously pressing the Control modifier key and the C console key (Ctrl+C) or the Ctrl+Break keys terminates the current process. The default is false, which terminates the current process. More...
|
|
void | cancel (bool cancel) |
| Sets a value that indicates whether simultaneously pressing the Control modifier key and the C console key (Ctrl+C) or the Ctrl+Break keys terminates the current process. The default is false, which terminates the current process. More...
|
|
console_special_key | special_key () const noexcept |
| Gets the combination of modifier and console keys that interrupted the current process. More...
|
|
◆ console_cancel_event_args() [1/2]
xtd::console_cancel_event_args::console_cancel_event_args |
( |
| ) |
|
|
default |
◆ console_cancel_event_args() [2/2]
Initializes a new instance of the console_cancel_event_args class.
- Parameters
-
special_key | One of the enumeration values that specifies the key combination that interrupted the current process. There is no default value.. |
◆ cancel() [1/2]
bool xtd::console_cancel_event_args::cancel |
( |
| ) |
const |
|
noexcept |
Gets a value that indicates whether simultaneously pressing the Control modifier key and the C console key (Ctrl+C) or the Ctrl+Break keys terminates the current process. The default is false, which terminates the current process.
- Returns
- true if the current process should resume when the event handler concludes; false if the current process should terminate. The default value is false; the current process terminates when the event handler returns. If true, the current process continues.
◆ cancel() [2/2]
void xtd::console_cancel_event_args::cancel |
( |
bool |
cancel | ) |
|
Sets a value that indicates whether simultaneously pressing the Control modifier key and the C console key (Ctrl+C) or the Ctrl+Break keys terminates the current process. The default is false, which terminates the current process.
- Parameters
-
true | if the current process should resume when the event handler concludes; false if the current process should terminate. The default value is false; the current process terminates when the event handler returns. If true, the current process continues. |
◆ special_key()
Gets the combination of modifier and console keys that interrupted the current process.
- Returns
- One of the enumeration values that specifies the key combination that interrupted the current process. There is no default value.
The documentation for this class was generated from the following file: