xtd 1.0.0
Loading...
Searching...
No Matches
xtd::forms::link_label_clicked_event_args Class Reference
Inheritance diagram for xtd::forms::link_label_clicked_event_args:
xtd::event_args xtd::object

Definition

Represents a Windows label control that can display hyperlinks.

Header
#include <xtd/forms/link_label_clicked_event_args>
Namespace
xtd::forms
Library
xtd.forms
Todo
rename to link_label_link_clicked_event_args

Public Constructors

 link_label_clicked_event_args (const xtd::forms::link &link, xtd::forms::mouse_buttons button)
 Initialise a new instance of xtd::forms::link_labelc_clicked_event_args class.

Public Properties

auto link () const noexcept -> const xtd::forms::link &
 Geyts the link clicked.
auto button () const noexcept -> xtd::forms::mouse_buttons
 Gets which mouse button was pressed.
auto visited () const noexcept -> bool
 Gets the visited link value.
auto visited (bool value) -> link_label_clicked_event_args &
 Sets the visited link value.

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

◆ link_label_clicked_event_args()

xtd::forms::link_label_clicked_event_args::link_label_clicked_event_args ( const xtd::forms::link & link,
xtd::forms::mouse_buttons button )

Initialise a new instance of xtd::forms::link_labelc_clicked_event_args class.

Parameters
linkThe xtd::forms::link clicked.
buttonOne of the xtd::forms::mouse_buttons values that indicate which mouse button was pressed.

Member Function Documentation

◆ link()

auto xtd::forms::link_label_clicked_event_args::link ( ) const -> const xtd::forms::link &
nodiscardnoexcept

Geyts the link clicked.

Returns
The link clocked.

◆ button()

auto xtd::forms::link_label_clicked_event_args::button ( ) const -> xtd::forms::mouse_buttons
nodiscardnoexcept

Gets which mouse button was pressed.

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

◆ visited() [1/2]

auto xtd::forms::link_label_clicked_event_args::visited ( ) const -> bool
nodiscardnoexcept

Gets the visited link value.

Returns
true if visited link; otherwise false.

◆ visited() [2/2]

auto xtd::forms::link_label_clicked_event_args::visited ( bool value) -> link_label_clicked_event_args &

Sets the visited link value.

Parameters
valuetrue if visited link; otherwise false.

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