xtd::speech::synthesis::prompt_event_args Class Reference

Inheritance diagram for xtd::speech::synthesis::prompt_event_args:

Definition

Provides data for the method_name_completed event.

class prompt_event_args : public xtd::event_args

Inheritance

xtd::event_args → xtd::speech::synthesis::prompt_event_args

Header

#include <xtd/speech/synthesis/prompt_event_args>

Namespace

xtd::speech::synthesis

Library

xtd.core

Public Properties
auto	cancelled () const noexcept -> bool
	Gets a value indicating whether an asynchronous operation has been canceled.
auto	error () const noexcept -> std::optional< xtd::ref< const xtd::system_exception > >
	Gets a value indicating which error occurred during an asynchronous operation.
auto	prompt () const noexcept -> const xtd::speech::synthesis::prompt &
	Gets the prompt associated with the event.
auto	user_state () const noexcept -> xtd::any_object
	Gets the unique identifier for the asynchronous task.

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 bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual xtd::size	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<class object_t>
xtd::unique_ptr_object< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual xtd::string	to_string () const
	Returns a xtd::string that represents the current object.
template<class object_a_t, class object_b_t>
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<class object_a_t, class object_b_t>
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Member Function Documentation

cancelled()

auto xtd::speech::synthesis::prompt_event_args::cancelled ( ) const -> bool

inlinenodiscardnoexcept

Gets a value indicating whether an asynchronous operation has been canceled.

Returns

true if the background operation has been canceled; otherwise false. The default is false.

error()

auto xtd::speech::synthesis::prompt_event_args::error ( ) const -> std::optional<xtd::ref<const xtd::system_exception>>

inlinenodiscardnoexcept

Gets a value indicating which error occurred during an asynchronous operation.

Returns

An xtd::system_exception instance, if an error occurred during an asynchronous operation; otherwise std::nullopt.

prompt()

auto xtd::speech::synthesis::prompt_event_args::prompt ( ) const -> const xtd::speech::synthesis::prompt&

inlinenodiscardnoexcept

Gets the prompt associated with the event.

Returns

The Prompt object associated with the event.

user_state()

auto xtd::speech::synthesis::prompt_event_args::user_state ( ) const -> xtd::any_object

inlinenodiscardnoexcept

Gets the unique identifier for the asynchronous task.

Returns

An object reference that uniquely identifies the asynchronous task.

---

The documentation for this class was generated from the following file:

• xtd.core/include/xtd/speech/synthesis/prompt_event_args.hpp