APointerIndex Class Reference

Wrapper class that stores either mouse button index or finger index. More...

#include <AUI/Event/APointerIndex.h>

Public Member Functions
bool	isButton () const noexcept
bool	isFinger () const noexcept
AOptional< AInput::Key >	button () const noexcept
AOptional< int >	finger () const noexcept
auto	operator<=> (const APointerIndex &rhs) const noexcept=default
constexpr int	rawValue () const noexcept

Static Public Member Functions
static constexpr APointerIndex	button (AInput::Key button)
static constexpr APointerIndex	finger (int fingerIndex)

Detailed Description

Wrapper class that stores either mouse button index or finger index.

Member Function Documentation

button()

AOptional< AInput::Key > APointerIndex::button ( ) const

inlinenoexcept

Returns

(mouse) button, if it is.

Examples

/home/runner/work/aui/aui/aui.views/src/AUI/View/AView.h.

finger()

AOptional< int > APointerIndex::finger ( ) const

inlinenoexcept

Returns

finger index, if it is.

isButton()

bool APointerIndex::isButton ( ) const

inlinenodiscardnoexcept

Returns

true if (mouse) button.

isFinger()

bool APointerIndex::isFinger ( ) const

inlinenodiscardnoexcept

Returns

true if finger index.

---

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

• aui.views/src/AUI/Event/APointerIndex.h