xtd 0.2.0
xtd::forms::month_calendar::hit_test_info Class Referencefinal

Definition

Contains information about an area of a xtd::forms::month_calendar control. This class cannot be inherited.

Remarks
xtd::forms::month_calendar::hit_test_info objects are returned by xtd::forms::month_calendar controls in response to the xtd::forms::month_calendar::hit_test method.
Warning
xtd::forms::month_calendar::hit_test_info is for informational purposes only; you should not construct these objects and cannot modify any of the members.

Public Member Functions

xtd::forms::month_calendar::hit_area hit_area () const noexcept
 Gets the xtd::forms::month_calendar::hit_area that represents the area of the calendar evaluated by the hit-test operation. More...
 
const xtd::drawing::pointpoint () const noexcept
 Gets the point that was hit-tested. More...
 
const xtd::date_timetime () const noexcept
 Gets the time information specific to the location that was hit-tested. More...
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
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...
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance. More...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const noexcept
 Creates a shallow copy of the current object. More...
 
virtual xtd::ustring to_string () const noexcept
 Returns a sxd::ustring 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...
 

Member Function Documentation

◆ hit_area()

xtd::forms::month_calendar::hit_area xtd::forms::month_calendar::hit_test_info::hit_area ( ) const
noexcept

Gets the xtd::forms::month_calendar::hit_area that represents the area of the calendar evaluated by the hit-test operation.

Returns
One of the xtd::forms::month_calendar::hit_area values. The default is xtd::forms::month_calendar::hit_area::nowhere.

◆ point()

const xtd::drawing::point& xtd::forms::month_calendar::hit_test_info::point ( ) const
noexcept

Gets the point that was hit-tested.

Returns
A xtd::drawing::point containing the xtd::drawing::point::x and xtd::drawing::point::y values tested.

◆ time()

const xtd::date_time& xtd::forms::month_calendar::hit_test_info::time ( ) const
noexcept

Gets the time information specific to the location that was hit-tested.

Returns
The time information specific to the location that was hit-tested.
Remarks
The xtd::forms::month_calendar::hit_test_info::time property contains a valid date when the xtd::forms::month_calendar::hit_area property is set to xtd::forms::month_calendar::hit_area::date or xtd::forms::month_calendar::hit_area::week_numbers.

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