xtd 0.2.0
Loading...
Searching...
No Matches
xtd::forms::help_event_args Class Reference
Inheritance diagram for xtd::forms::help_event_args:
xtd::event_args xtd::object

Definition

Provides data for the xtd::forms::control::control_added and xtd::forms::control::control_removed events.

Header
#include <xtd/forms/help_event_args>
Namespace
xtd::forms
Library
xtd.forms

Public Constructors

 help_event_args (const drawing::point &mouse_pos)
 Initializes a new instance of the xtd::forms::help_event_args class.
 

Public Properties

bool handled () const noexcept
 Gets a value indicating whether the help event was handled.
 
void handled (bool handled)
 Sets a value indicating whether the help event was handled.
 
xtd::drawing::point mouse_pos () const noexcept
 Gets the screen coordinates of the mouse pointer.
 

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.
 
- Public Member Functions inherited from xtd::event_args
 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.
 
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

◆ help_event_args()

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

Initializes a new instance of the xtd::forms::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
inlinenoexcept

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
inlinenoexcept

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: