xtd::event_args Class Reference

#include <event_args.h>

Definition

Represents the base class for classes that contain event data, and provides a value to use for events that do not include event data.

Namespace

xtd

Library

xtd.core

Remarks

This class serves as the base class for all classes that represent event data. For example, the xtd::forms::form_closing_event_args class derives from event_args and is used to hold information when form closing. To create a custom event data class, create a class that derives from the event_args class and provide the properties to store the necessary data. The name of your custom event data class should end with _event_args.

To pass an object that does not contain any data, use the empty field.

Examples

choice.cpp, combo_box.cpp, main_menu.cpp, main_menu_create_standard_items.cpp, timer.cpp, and user_control.cpp.

Inherits xtd::object.

Inherited by xtd::console_cancel_event_args, xtd::diagnostics::data_received_event_args, xtd::forms::animation_updated_event_args, xtd::forms::cancel_event_args, xtd::forms::control_event_args, xtd::forms::dialog_closed_event_args, xtd::forms::form_closed_event_args, xtd::forms::help_event_args, xtd::forms::item_check_event_args, xtd::forms::key_event_args, xtd::forms::key_press_event_args, xtd::forms::link_label_clicked_event_args, xtd::forms::mouse_event_args, xtd::forms::paint_event_args, xtd::forms::progress_changed_event_args, xtd::forms::run_worker_completed_event_args, and xtd::net::sockets::socket_async_event_args.

Static Public Attributes
static const event_args	empty
	Provides a value to use with events that do not have event data.

Public Member Functions
	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.
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const
	Gets the type of the current instance.
virtual xtd::ustring	to_string () const noexcept
	Returns a std::string that represents the current object.

Additional Inherited Members
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.
static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Constructor & Destructor Documentation

event_args()

xtd::event_args::event_args ( )

default

Initializes a new instance of the event_args class.

Remarks

To pass an object that does not contain any data, use the empty field.

Member Data Documentation

empty

const event_args xtd::event_args::empty

static

Provides a value to use with events that do not have event data.

Remarks

Pass this value to event handlers that are associated with events that do not have data.

---

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

• xtd.core/include/xtd/event_args.h