xtd 0.2.0
Loading...
Searching...
No Matches
xtd::event_args Class Reference
Inheritance diagram for xtd::event_args:
xtd::object xtd::console_cancel_event_args xtd::diagnostics::data_received_event_args xtd::forms::animation_updated_event_args xtd::forms::cancel_event_args xtd::forms::color_picker_event_args xtd::forms::control_event_args xtd::forms::date_range_event_args xtd::forms::dialog_closed_event_args xtd::forms::draw_item_event_args xtd::forms::find_event_args xtd::forms::font_picker_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::notifier_button_click_event_args xtd::forms::notifier_closed_event_args xtd::forms::paint_event_args xtd::forms::progress_changed_event_args xtd::forms::replace_event_args xtd::forms::run_worker_completed_event_args xtd::forms::status_bar_panel_click_event_args xtd::forms::tool_bar_button_click_event_args xtd::net::sockets::socket_async_event_args xtd::program_exit_event_args xtd::signal_cancel_event_args xtd::speech::synthesis::prompt_event_args xtd::speech::synthesis::state_changed_event_args xtd::timers::elapsed_event_args

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
animation.cpp, application_enable_dark_mode.cpp, application_enable_light_mode.cpp, application_idle.cpp, calculator.cpp, choice.cpp, combo_box.cpp, context_menu.cpp, demo.cpp, enable_changed_event.cpp, event.cpp, font_changed_event.cpp, form_background_image2.cpp, form_custom_event.cpp, forms_timer.cpp, graph_control.cpp, hello_world_xtd.cpp, main_menu.cpp, main_menu_create_standard_items.cpp, minesweeper.cpp, month_calendar.cpp, numeric_text_box.cpp, painting.cpp, some_controls.cpp, some_system_controls.cpp, stopwatch_form.cpp, themes.cpp, timers_timer_synchronizing_object.cpp, toggle_button2.cpp, toggle_light.cpp, tool_bar.cpp, tutorial_button.cpp, user_control.cpp, and wiggly.cpp.

Public Fields

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

Public Constructors

 event_args ()=default
 Initializes a new instance of the event_args class.
 

Additional Inherited Members

- 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.
 

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.
Examples
event.cpp.

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