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::do_work_event_args Class Reference

#include <do_work_event_args.h>

Definition

Provides data for the do_work event handler.

Namespace
xtd::forms
Library
xtd.forms

Public Member Functions

 do_work_event_args (const std::any &argument)
 Initializes a new instance of the DoWorkEventArgs class. More...
 
std::any argument () const
 Gets a value that represents the argument of an asynchronous operation. More...
 
std::any result () const
 Gets a value that represents the result of an asynchronous operation. More...
 
void result (std::any value)
 Sets a value that represents the result of an asynchronous operation. More...
 
- Public Member Functions inherited from xtd::forms::cancel_event_args
 cancel_event_args ()=default
 Initializes a new instance of the cancel_event_args class with the cancel property set to false. More...
 
 cancel_event_args (bool cancel)
 Initializes a new instance of the cancel_event_args class with the cancel property set to the given value. More...
 
virtual bool cancel () const
 Gets a value indicating whether the event should be canceled. More...
 
virtual void cancel (bool cancel)
 Sets a value indicating whether the event should be canceled. 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...
 
- Protected Attributes inherited from xtd::forms::cancel_event_args
bool cancel_ = false
 

Constructor & Destructor Documentation

◆ do_work_event_args()

xtd::forms::do_work_event_args::do_work_event_args ( const std::any argument)
inline

Initializes a new instance of the DoWorkEventArgs class.

Parameters
argumentSpecifies an argument for an asynchronous operation.

Member Function Documentation

◆ argument()

std::any xtd::forms::do_work_event_args::argument ( ) const
inline

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

Returns
An object representing the argument of an asynchronous operation.

◆ result() [1/2]

std::any xtd::forms::do_work_event_args::result ( ) const
inline

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

Returns
A std::any representing the result of an asynchronous operation.

◆ result() [2/2]

void xtd::forms::do_work_event_args::result ( std::any  value)
inline

Sets a value that represents the result of an asynchronous operation.

Parameters
valueA std::any representing the result of an asynchronous operation.

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