Inheritance diagram for xtd::console_cancel_event_args:

Definition

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

Remarks: A user can interrupt a console application process by simultaneously pressing the Control modifier key and the C console key (Ctrl+C), or the Control modifier key and the Break console key (Ctrl+Break). The console consequently provides a console_cancel_event_args object to the event handler for the console::cancel_key_press event to specify whether the process should be cancelled.; If the cancel property is set to true in the event handler, the process is resumed; otherwise, the process is terminated. By default, the value of the console_cancel_event_args property is false, and the process terminates.

Examples: console_read_key.cpp.

Public Constructors
	console_cancel_event_args ()=default
	Initializes a new instance of the console_cancel_event_args class.
	console_cancel_event_args (console_special_key special_key)
	Initializes a new instance of the console_cancel_event_args class.

Public Properties
auto	cancel () const noexcept -> bool
	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.
auto	cancel (bool cancel) -> void
	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.
auto	special_key () const noexcept -> console_special_key
	Gets the combination of modifier and console keys that interrupted the current process.

Additional Inherited Members
static const event_args	empty
	Provides a value to use with events that do not have event data.
	event_args ()=default
	Initializes a new instance of the event_args class.
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	equals (const object &obj) const noexcept -> bool
	Determines whether the specified object is equal to the current object.
virtual auto	get_hash_code () const noexcept -> xtd::usize
	Serves as a hash function for a particular type.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	to_string () const -> xtd::string
	Returns a xtd::string that represents the current object.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

◆ console_cancel_event_args() [1/2]

xtd::console_cancel_event_args::console_cancel_event_args ( )

default

Initializes a new instance of the console_cancel_event_args class.

◆ console_cancel_event_args() [2/2]

xtd::console_cancel_event_args::console_cancel_event_args ( console_special_key special_key )

explicit

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..

Member Function Documentation

◆ cancel() [1/2]

auto xtd::console_cancel_event_args::cancel ( ) const -> bool

nodiscardnoexcept

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]

auto xtd::console_cancel_event_args::cancel ( bool cancel ) -> void

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

cancel 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()

auto xtd::console_cancel_event_args::special_key ( ) const -> console_special_key

nodiscardnoexcept

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:

xtd.core/include/xtd/console_cancel_event_args.hpp