xtd::forms::help_event_args Class Reference

Inheritance diagram for xtd::forms::help_event_args:

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 xtd::drawing::point &mouse_pos)
	Initializes a new instance of the xtd::forms::help_event_args class.

Public Properties
auto	handled () const noexcept -> bool
	Gets a value indicating whether the help event was handled.
auto	handled (bool value) -> help_event_args &
	Sets a value indicating whether the help event was handled.
auto	mouse_pos () const noexcept -> xtd::drawing::point
	Gets the screen coordinates of the mouse pointer.

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 auto	equals (const object &obj) const noexcept -> bool
	Determines whether the specified object is equal to the current object.
virtual auto	get_hash_code () const noexcept -> xtd::usize
	Serves as a hash function for a particular type.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	to_string () const -> xtd::string
	Returns a xtd::string that represents the current object.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	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 xtd::drawing::point & mouse_pos )

inlineexplicit

Initializes a new instance of the xtd::forms::help_event_args class.

Parameters

mouse_pos

The coordinates of the mouse pointer.

Member Function Documentation

handled() [1/2]

auto xtd::forms::help_event_args::handled ( ) const -> bool

inlinenodiscardnoexcept

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]

auto xtd::forms::help_event_args::handled ( bool value ) -> help_event_args &

inline

Sets a value indicating whether the help event was handled.

Parameters

value

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.

mouse_pos()

auto xtd::forms::help_event_args::mouse_pos ( ) const -> xtd::drawing::point

inlinenodiscardnoexcept

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:

• xtd.forms/include/xtd/forms/help_event_args.hpp