utility 2026.1.9
A comprehensive C++ utilities library tailored for the development of modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
utility::event::CursorEnterEvent Class Reference

Cursor enter/leave event. More...

#include <headers/utility/event/cursor_enter_event.hpp>

Inheritance diagram for utility::event::CursorEnterEvent:
Collaboration diagram for utility::event::CursorEnterEvent:

Classes

class  Factory
 Factory for creating CursorEnterEvent instances. More...
 

Public Member Functions

 CursorEnterEvent (void)
 Default constructor.
 
 ~CursorEnterEvent (void) override
 Default destructor.
 
CursorEnterEventsetEntered (const bool entered) noexcept
 Set whether the cursor entered or left the content area.
 
bool isEntered (void) const noexcept
 Check if the cursor entered the content area.
 
- Public Member Functions inherited from utility::event::Event
 Event (void)=default
 Default constructor.
 
virtual ~Event (void)=default
 Virtual destructor.
 

Detailed Description

Cursor enter/leave event.

Represents the cursor entering or leaving the content area of a window. This event is triggered when the cursor crosses the boundary of the window's content area.

Definition at line 39 of file cursor_enter_event.hpp.

Member Function Documentation

◆ isEntered()

bool utility::event::CursorEnterEvent::isEntered ( void  ) const
noexcept

Check if the cursor entered the content area.

Returns
True if the cursor entered, false if it left.

Definition at line 59 of file cursor_enter_event.cpp.

◆ setEntered()

CursorEnterEvent & utility::event::CursorEnterEvent::setEntered ( const bool  entered)
noexcept

Set whether the cursor entered or left the content area.

Parameters
enteredTrue if the cursor entered the content area, false if it left.
Returns
Reference to this CursorEnterEvent for method chaining.

Definition at line 53 of file cursor_enter_event.cpp.


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