xtd::forms::mouse_event_args Class Reference

Inheritance diagram for xtd::forms::mouse_event_args:

Definition

Provides data for the xtd::forms::control::mouse_up, xtd::forms::control::mouse_down, and xtd::forms::control::mouse_move events.

Header

#include <xtd/forms/mouse_event_args>

Namespace

xtd::forms

Library

xtd.forms

Public Constructors
	mouse_event_args ()=default
	Initializes a new instance of the MouseEventArgs class.
	mouse_event_args (mouse_buttons button, int32 clicks, int32 x, int32 y, int32 delta)
	Initializes a new instance of the MouseEventArgs class.
	mouse_event_args (mouse_buttons button, int32 clicks, const drawing::point &location, int32 delta)
	Initializes a new instance of the MouseEventArgs class.

Public Properties
mouse_buttons	button () const noexcept
	Gets which mouse button was pressed.
int32	clicks () const noexcept
	Gets the number of times the mouse button was pressed and released.
int32	delta () const noexcept
	Gets a signed count of the number of detents the mouse wheel has rotated, multiplied by the WHEEL_DELTA constant. A detent is one notch of the mouse wheel.
const drawing::point &	location () const noexcept
	Gets the location of the mouse during the generating mouse event.
int32	x () const noexcept
	Gets the x-coordinate of the mouse during the generating mouse event.
int32	y () const noexcept
	Gets the y-coordinate of the mouse during the generating mouse event.

Additional Inherited Members
static const event_args	empty
	Provides a value to use with events that do not have event data.
	event_args ()=default
	Initializes a new instance of the event_args class.
	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 xtd::size	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<class object_t>
xtd::unique_ptr_object< 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.
template<class object_a_t, class 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<class object_a_t, class 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

mouse_event_args() [1/3]

xtd::forms::mouse_event_args::mouse_event_args ( )

default

Initializes a new instance of the MouseEventArgs class.

mouse_event_args() [2/3]

xtd::forms::mouse_event_args::mouse_event_args ( mouse_buttons button, int32 clicks, int32 x, int32 y, int32 delta )

inline

Initializes a new instance of the MouseEventArgs class.

Parameters

button	One of the xtd::forms::mouse_buttons values that indicate which mouse button was pressed.
clicks	The number of times a mouse button was pressed.
x	The x-coordinate of a mouse click, in pixels.
y	The y-coordinate of a mouse click, in pixels.
delta	A signed count of the number of detents the wheel has rotated.

mouse_event_args() [3/3]

xtd::forms::mouse_event_args::mouse_event_args ( mouse_buttons button, int32 clicks, const drawing::point & location, int32 delta )

inline

Initializes a new instance of the MouseEventArgs class.

Parameters

button	One of the xtd::forms::mouse_buttons values that indicate which mouse button was pressed.
clicks	The number of times a mouse button was pressed.
location	The location of a mouse click, in pixels.
delta	A signed count of the number of detents the wheel has rotated.

Member Function Documentation

button()

mouse_buttons xtd::forms::mouse_event_args::button ( ) const

inlinenoexcept

Gets which mouse button was pressed.

Returns

One of the xtd::forms::mouse_buttons values.

clicks()

int32 xtd::forms::mouse_event_args::clicks ( ) const

inlinenoexcept

Gets the number of times the mouse button was pressed and released.

Returns

An std::int32_t that contains the number of times the mouse button was pressed and released.

delta()

int32 xtd::forms::mouse_event_args::delta ( ) const

inlinenoexcept

Gets a signed count of the number of detents the mouse wheel has rotated, multiplied by the WHEEL_DELTA constant. A detent is one notch of the mouse wheel.

Returns

A signed count of the number of detents the mouse wheel has rotated, multiplied by the WHEEL_DELTA constant.

location()

const drawing::point & xtd::forms::mouse_event_args::location ( ) const

inlinenoexcept

Gets the location of the mouse during the generating mouse event.

Returns

A xtd::drawing::point that contains the x- and y- mouse coordinates, in pixels, relative to the upper-left corner of the form.

x()

int32 xtd::forms::mouse_event_args::x ( ) const

inlinenoexcept

Gets the x-coordinate of the mouse during the generating mouse event.

Returns

The x-coordinate of the mouse, in pixels.

y()

int32 xtd::forms::mouse_event_args::y ( ) const

inlinenoexcept

Gets the y-coordinate of the mouse during the generating mouse event.

Returns

The y-coordinate of the mouse, in pixels.

---

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

• xtd.forms/include/xtd/forms/mouse_event_args.hpp