xtd 0.2.0
Loading...
Searching...
No Matches
xtd::speech::synthesis::prompt_event_args Class Reference
Inheritance diagram for xtd::speech::synthesis::prompt_event_args:
xtd::event_args xtd::object

Definition

Provides data for the method_name_completed event.

Represents the base class for classes that contain event data, and provides a value to use for events...
Definition event_args.h:18
Provides data for the method_name_completed event.
Definition prompt_event_args.h:37
Inheritance
xtd::event_argsxtd::speech::synthesis::prompt_event_args
Header
#include <xtd/speech/synthesis/prompt_event_args>
Namespace
xtd::speech::synthesis
Library
xtd.core

Public Properties

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

Additional Inherited Members

- Static Public Attributes inherited from xtd::event_args
static const event_args empty
 Provides a value to use with events that do not have event data.
 
- Public Member Functions inherited from xtd::event_args
 event_args ()=default
 Initializes a new instance of the event_args class.
 
- Public Member Functions inherited from xtd::object
 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 size_t 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<typename object_t >
xtd::uptr< object_t > memberwise_clone () const
 Creates a shallow copy of the current object.
 
virtual xtd::string to_string () const noexcept
 Returns a xtd::string that represents the current object.
 
- Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename 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<typename object_a_t , typename 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()

bool xtd::speech::synthesis::prompt_event_args::cancelled ( ) const
inlinenoexcept

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

std::optional< std::reference_wrapper< const xtd::system_exception > > xtd::speech::synthesis::prompt_event_args::error ( ) const
inlinenoexcept

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

const xtd::speech::synthesis::prompt & xtd::speech::synthesis::prompt_event_args::prompt ( ) const
inlinenoexcept

Gets the prompt associated with the event.

Returns
The Prompt object associated with the event.

◆ user_state()

std::any xtd::speech::synthesis::prompt_event_args::user_state ( ) const
inlinenoexcept

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: