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

#include <help_event_args.h>

Definition

Provides data for the control_added and control_removed events.

Namespace
xtd::forms
Library
xtd.forms

Public Member Functions

 help_event_args (const drawing::point &mouse_pos)
 Initializes a new instance of the help_event_args class. More...
 
bool handled () const
 Gets a value indicating whether the help event was handled. More...
 
void handled (bool handled)
 Sets a value indicating whether the help event was handled. More...
 
xtd::drawing::point mouse_pos () const
 Gets the screen coordinates of the mouse pointer. 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...
 

Constructor & Destructor Documentation

◆ help_event_args()

xtd::forms::help_event_args::help_event_args ( const drawing::point mouse_pos)
inline

Initializes a new instance of the help_event_args class.

Parameters
mouse_posThe coordinates of the mouse pointer.

Member Function Documentation

◆ handled() [1/2]

bool xtd::forms::help_event_args::handled ( ) const
inline

Gets a value indicating whether the help event was handled.

Returns
true if the event is handled; otherwise, false. The default is false.
Remarks
If you do not set this property to true the event will be passed to Windows for additional processing.

◆ handled() [2/2]

void xtd::forms::help_event_args::handled ( bool  handled)
inline

Sets a value indicating whether the help event was handled.

Parameters
handledtrue if the event is handled; otherwise, false. The default is false.
Remarks
If you do not set this property to true the event will be passed to Windows for additional processing.

◆ mouse_pos()

xtd::drawing::point xtd::forms::help_event_args::mouse_pos ( ) const
inline

Gets the screen coordinates of the mouse pointer.

Returns
A xtd::drawing::point representing the screen coordinates of the mouse pointer.
Remarks
You can use this information to provide help based on the position of the mouse pointer.

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