APointerIndex Class Reference

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

#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)

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.

© 2025 AUI Framework Contributors. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. All trademarks are property of their respective owners.

Contents

Public Member Functions

Static Public Member Functions

View Page SourceEdit Page Source