xtd - Reference Guide  0.2.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Public Member Functions | List of all members
xtd::forms::run_worker_completed_event_args Class Reference

#include <run_worker_completed_event_args.h>

Definition

Provides data for the do_work event handler.

Namespace
xtd::forms
Library
xtd.forms

Public Member Functions

 run_worker_completed_event_args (const std::any &result, std::optional< std::reference_wrapper< std::exception >> exception, bool cancel)
 Initializes a new instance of the DoWorkEventArgs class. More...
 
bool cancel () const
 
void cancel (bool value)
 
std::any result () const
 
std::any user_state () const
 Gets a value that represents the argument of an asynchronous operation. 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...
 
virtual 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...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const
 Gets the type of the current instance. More...
 
virtual xtd::ustring to_string () const noexcept
 Returns a std::string that represents the current object. 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...
 
- 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

◆ run_worker_completed_event_args()

xtd::forms::run_worker_completed_event_args::run_worker_completed_event_args ( const std::any result,
std::optional< std::reference_wrapper< std::exception >>  exception,
bool  cancel 
)
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::run_worker_completed_event_args::user_state ( ) const
inline

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: