xtd - Reference Guide  0.1.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::mouse_event_args Class Reference

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

#include <mouse_event_args.h>

Public Member Functions

 mouse_event_args ()=default
 Initializes a new instance of the MouseEventArgs class. More...
 
 mouse_event_args (mouse_buttons button, int32_t clicks, int32_t x, int32_t y, int32_t delta)
 Initializes a new instance of the MouseEventArgs class. More...
 
 mouse_event_args (mouse_buttons button, int32_t clicks, const drawing::point &location, int32_t delta)
 Initializes a new instance of the MouseEventArgs class. More...
 
mouse_buttons button () const
 Gets which mouse button was pressed. More...
 
int32_t clicks () const
 Gets the number of times the mouse button was pressed and released. More...
 
int32_t delta () const
 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. More...
 
const drawing::pointlocation () const
 Gets the location of the mouse during the generating mouse event. More...
 
int32_t x () const
 Gets the x-coordinate of the mouse during the generating mouse event. More...
 
int32_t y () const
 Gets the y-coordinate of the mouse during the generating mouse event. 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::shared_ptr< objectmemberwise_clone () const
 Gets the type of the current instance. More...
 
virtual std::string to_string () const noexcept
 Returns a std::string that represents the current object. More...
 

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

Detailed Description

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

Library
xtd.forms

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_t  clicks,
int32_t  x,
int32_t  y,
int32_t  delta 
)
inline

Initializes a new instance of the MouseEventArgs class.

Parameters
buttonOne of the xtd::forms::mouse_buttons values that indicate which mouse button was pressed.
clicksThe number of times a mouse button was pressed.
xThe x-coordinate of a mouse click, in pixels.
yThe y-coordinate of a mouse click, in pixels.
deltaA 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_t  clicks,
const drawing::point location,
int32_t  delta 
)
inline

Initializes a new instance of the MouseEventArgs class.

Parameters
buttonOne of the xtd::forms::mouse_buttons values that indicate which mouse button was pressed.
clicksThe number of times a mouse button was pressed.
locationThe location of a mouse click, in pixels.
deltaA signed count of the number of detents the wheel has rotated.

Member Function Documentation

◆ button()

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

Gets which mouse button was pressed.

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

◆ clicks()

int32_t xtd::forms::mouse_event_args::clicks ( ) const
inline

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

Returns
An Int32_t that contains the number of times the mouse button was pressed and released.

◆ delta()

int32_t xtd::forms::mouse_event_args::delta ( ) const
inline

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
inline

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_t xtd::forms::mouse_event_args::x ( ) const
inline

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

Returns
The x-coordinate of the mouse, in pixels.

◆ y()

int32_t xtd::forms::mouse_event_args::y ( ) const
inline

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: