xtd 0.2.0
xtd::forms::progress_changed_event_args Class Reference

Definition

Provides data for the xtd::forms::background_worker::progress_changed event handler.

Header
#include <xtd/forms/progress_changed_event_args>
Namespace
xtd::forms
Library
xtd.forms
Examples:
background_worker.cpp.

Constructors

 progress_changed_event_args (int32 progress_percentage, const std::any &user_state)
 Initializes a new instance of the DoWorkEventArgs class. More...
 

Properties

int32 progress_percentage () const noexcept
 
std::any user_state () const noexcept
 Gets a value that represents the argument of an asynchronous operation. More...
 

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. More...
 
- Public Member Functions inherited from xtd::event_args
 event_args ()=default
 Initializes a new instance of the event_args class. More...
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object. More...
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type. More...
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance. More...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const noexcept
 Creates a shallow copy of the current object. More...
 
virtual xtd::ustring to_string () const noexcept
 Returns a sxd::ustring that represents the current object. More...
 
- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal. More...
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance. More...
 

Constructor & Destructor Documentation

◆ progress_changed_event_args()

xtd::forms::progress_changed_event_args::progress_changed_event_args ( int32  progress_percentage,
const std::any user_state 
)
inline

Initializes a new instance of the DoWorkEventArgs class.

Parameters
argumentSpecifies an argument for an asynchronous operation.

Member Function Documentation

◆ user_state()

std::any xtd::forms::progress_changed_event_args::user_state ( ) const
inlinenoexcept

Gets a value that represents the argument of an asynchronous operation.

Returns
An object representing the argument of an asynchronous operation.

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