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

Definition

Returns data from the xtd::speech::synthesis::speech_synthesizer::state_changed event.

Represents the base class for classes that contain event data, and provides a value to use for events...
Definition event_args.h:18
Returns data from the xtd::speech::synthesis::speech_synthesizer::state_changed event.
Definition state_changed_event_args.h:38
Inheritance
xtd::event_argsxtd::speech::synthesis::state_changed_event_args
Header
#include <xtd/speech/synthesis/state_changed_event_args>
Namespace
xtd::speech::synthesis
Library
xtd.core
Remarks
An instance of xtd::speech::synthesis::state_changed_event_args is created when the xtd::speech::synthesis::speech_synthesizer object raises the xtd::speech::synthesis::speech_synthesizer::state_changed event. To obtain the values for the new and the previous xtd::speech::synthesis::synthesizer_state, access the xtd::speech::synthesis::state_changed_event_args::state and xtd::speech::synthesis::state_changed_event_args::previous_state properties in the handler for the event.

Public Properties

synthesizer_state previous_state () const noexcept
 Gets the state of the xtd::speech::synthesis::speech_synthesizer before the xtd::speech::synthesis::speech_synthesizer::state_changed event.
 
synthesizer_state state () const noexcept
 Gets the state of the xtd::speech::synthesis::speech_synthesizer after the xtd::speech::synthesis::speech_synthesizer::state_changed event.
 

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

◆ previous_state()

synthesizer_state xtd::speech::synthesis::state_changed_event_args::previous_state ( ) const
inlinenoexcept

Gets the state of the xtd::speech::synthesis::speech_synthesizer before the xtd::speech::synthesis::speech_synthesizer::state_changed event.

Returns
The state of the synthesizer before the state changed.
Remarks
The xtd::speech::synthesis::state_changed_event_args::previous_state property represents the synthesizer state with a member of the xtd::speech::synthesis::synthesizer_state enumeration.

◆ state()

synthesizer_state xtd::speech::synthesis::state_changed_event_args::state ( ) const
inlinenoexcept

Gets the state of the xtd::speech::synthesis::speech_synthesizer after the xtd::speech::synthesis::speech_synthesizer::state_changed event.

Returns
The state of the synthesizer after the state changed.
Remarks
The xtd::speech::synthesis::state_changed_event_args::state property represents the synthesizer state with a member of the xtd::speech::synthesis::synthesizer_state enumeration.

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