#include <KoInputDevice.h>

Inheritance diagram for KoInputDevice:

Public Types
enum class	InputDevice { Unknown = 0x0000 , Mouse = 0x0001 , TouchScreen = 0x0002 , TouchPad = 0x0004 , Puck = 0x0008 , Stylus = 0x0010 , Airbrush = 0x0020 , Keyboard = 0x1000 , AllDevices = 0x7FFFFFFF }

enum class	Pointer { Unknown = 0 , Generic = 0x0001 , Finger = 0x0002 , Pen = 0x0004 , Eraser = 0x0008 , Cursor = 0x0010 , AllPointerTypes = 0x7FFF }

Public Member Functions
InputDevice	device () const

bool	isMouse () const

	KoInputDevice ()

	KoInputDevice (const KoInputDevice &other)

	KoInputDevice (InputDevice device, Pointer pointer, qint64 uniqueTabletId=-1)

KoInputDevice &	operator= (const KoInputDevice &)
	assignment

bool	operator== (const KoInputDevice &) const
	equal

Pointer	pointer () const

	Private (KoInputDevice::InputDevice d, KoInputDevice::Pointer p, qint64 id, bool m)

qint64	uniqueTabletId () const

	~KoInputDevice ()

Static Public Member Functions
static InputDevice	convertDeviceType (QTabletEvent *event)

static Pointer	convertPointerType (QTabletEvent *event)

static KoInputDevice	eraser ()
	Wacom eraser.

static KoInputDevice	invalid ()
	invalid input device

static KoInputDevice	mouse ()
	Standard mouse.

static KoInputDevice	stylus ()
	Wacom style/pen.

Public Attributes
KoInputDevice::InputDevice	device

bool	mouse

KoInputDevice::Pointer	pointer

qint64	uniqueTabletId

Private Attributes
Private *const	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

This class represents an input device. A user can manipulate flake-shapes using a large variety of input devices. This ranges from a mouse to a paintbrush-like tool connected to a tablet.

Definition at line 9 of file KoInputDevice.cpp.

Member Enumeration Documentation

◆ InputDevice

enum class KoInputDevice::InputDevice

strong

Enumerator
Unknown
Mouse
TouchScreen
TouchPad
Puck
Stylus
Airbrush
Keyboard
AllDevices

Definition at line 36 of file KoInputDevice.h.

                           {
        Unknown = 0x0000,
        Mouse = 0x0001,
        TouchScreen = 0x0002,
        TouchPad = 0x0004,
        Puck = 0x0008,
        Stylus = 0x0010,
        Airbrush = 0x0020,
        Keyboard = 0x1000,
        AllDevices = 0x7FFFFFFF
    };

◆ Pointer

enum class KoInputDevice::Pointer

strong

Enumerator
Unknown
Generic
Finger
Pen
Eraser
Cursor
AllPointerTypes

Definition at line 26 of file KoInputDevice.h.

                       {
        Unknown = 0,
        Generic = 0x0001,   // mouse or similar
        Finger = 0x0002,    // touchscreen or pad
        Pen = 0x0004,       // stylus on a tablet
        Eraser = 0x0008,    // eraser end of a stylus
        Cursor = 0x0010,    // digitizer with crosshairs
        AllPointerTypes = 0x7FFF
    };

Constructor & Destructor Documentation

◆ KoInputDevice() [1/3]

KoInputDevice::KoInputDevice ( const KoInputDevice & other )

Copy constructor.

Definition at line 34 of file KoInputDevice.cpp.

    : d(new Private(other.d->device, other.d->pointer, other.d->uniqueTabletId, other.d->mouse))
{
}

◆ KoInputDevice() [2/3]

KoInputDevice::KoInputDevice	(	KoInputDevice::InputDevice	device,
		KoInputDevice::Pointer	pointer,
		qint64	uniqueTabletId = -1 )

explicit

Constructor for a tablet. Create a new input device with one of the many types that the tablet can have.

Parameters

device	the device as found on a QTabletEvent
pointer	the pointer as found on a QTabletEvent
uniqueTabletId	the uniqueId as found on a QTabletEvent

Definition at line 24 of file KoInputDevice.cpp.

    : d(new Private(device, pointer, uniqueTabletId, false))
{
}

◆ KoInputDevice() [3/3]

KoInputDevice::KoInputDevice ( )

Constructor for the mouse as input device.

Definition at line 29 of file KoInputDevice.cpp.

    : d(new Private(KoInputDevice::InputDevice::Unknown, KoInputDevice::Pointer::Unknown, -1, true))
{
}

◆ ~KoInputDevice()

KoInputDevice::~KoInputDevice ( )

Definition at line 40 of file KoInputDevice.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ convertDeviceType()

static InputDevice KoInputDevice::convertDeviceType ( QTabletEvent * event )

inlinestatic

Definition at line 101 of file KoInputDevice.h.

    {
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
        switch (event->deviceType()) {
        case QTabletEvent::NoDevice: {
            return InputDevice::Unknown;
        }
            break;
        case QTabletEvent::Puck: {
            return InputDevice::Puck;
        }
            break;
        case QTabletEvent::Stylus: {
            return InputDevice::Stylus;
        }
            break;
        case QTabletEvent::Airbrush: {
            return InputDevice::Airbrush;
        }
        case QTabletEvent::RotationStylus: {
            // Note: Qt6 no longer has the RotationStylus device type, so we will
            // have to stop supporting it.
            return InputDevice::Stylus;
        }
        default:
            return InputDevice::Unknown;
        }
 
#else
        QInputDevice::DeviceType deviceType = event->deviceType();
        switch(deviceType) {
        case QInputDevice::DeviceType::Unknown: {
            return InputDevice::Unknown;
        }
        break;
    case QInputDevice::DeviceType::Mouse:{
            return InputDevice::Mouse;
        }
        break;
    case QInputDevice::DeviceType::TouchScreen:
        {
            return InputDevice::TouchScreen;
        }
        break;
    case QInputDevice::DeviceType::TouchPad:
        {
            return InputDevice::TouchPad;
        }
        break;
    case QInputDevice::DeviceType::Puck:
        {
            return InputDevice::Puck;
        }
        break;
    case QInputDevice::DeviceType::Stylus:
        {
            return InputDevice::Stylus;
        }
        break;
    case QInputDevice::DeviceType::Airbrush:
        {
            return InputDevice::Airbrush;
        }
        break;
    case QInputDevice::DeviceType::Keyboard:
        {
            return InputDevice::Keyboard;
        }
        break;
    case QInputDevice::DeviceType::AllDevices:
        {
            return InputDevice::AllDevices;
        }
    default:
            return InputDevice::Unknown;
    }
#endif
    }

◆ convertPointerType()

static Pointer KoInputDevice::convertPointerType ( QTabletEvent * event )

inlinestatic

Definition at line 48 of file KoInputDevice.h.

    {
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
        switch (event->pointerType()) {
        case QTabletEvent::UnknownPointer: {
            return Pointer::Unknown;
        }
            break;
        case QTabletEvent::Pen: {
            return Pointer::Pen;
        }
            break;
        case QTabletEvent::Cursor: {
            return Pointer::Cursor;
        }
            break;
        case QTabletEvent::Eraser: {
            return Pointer::Eraser;
        }
        default:
            return Pointer::Unknown;
        }
#else
        QPointingDevice::PointerType pointer = event->pointerType();
        switch (pointer) {
        case (QPointingDevice::PointerType::Unknown): {
            return Pointer::Unknown;
        } break;
        case QPointingDevice::PointerType::Generic:{
            return Pointer::Generic;
        } break;
        case QPointingDevice::PointerType::Finger:{
            return Pointer::Finger;
        } break;
        case QPointingDevice::PointerType::Pen:{
            return Pointer::Pen;
        } break;
        case QPointingDevice::PointerType::Eraser:{
            return Pointer::Eraser;
        } break;
 
        case QPointingDevice::PointerType::Cursor:{
            return Pointer::Cursor;
        } break;
        case QPointingDevice::PointerType::AllPointerTypes:{
            return Pointer::AllPointerTypes;
        } break;
        default:
            return Pointer::Unknown;
        }
#endif
    }

◆ device()

InputDevice KoInputDevice::device ( ) const

Return the tablet device used

◆ eraser()

KoInputDevice KoInputDevice::eraser ( )

static

Wacom eraser.

Definition at line 108 of file KoInputDevice.cpp.

{
    KoInputDevice id(KoInputDevice::InputDevice::Stylus, KoInputDevice::Pointer::Eraser);
    return id;
}

References Eraser, and Stylus.

◆ invalid()

KoInputDevice KoInputDevice::invalid ( )

static

invalid input device

Definition at line 86 of file KoInputDevice.cpp.

{
    KoInputDevice id(KoInputDevice::InputDevice::Unknown, KoInputDevice::Pointer::Unknown);
    return id;
}

References Unknown.

◆ isMouse()

bool KoInputDevice::isMouse ( ) const

Return if this is a mouse device.

Definition at line 60 of file KoInputDevice.cpp.

{
    // sometimes, the system gives us tablet events with NoDevice or UnknownPointer. This is
    // likely an XInput2 bug. However, assuming that if cannot identify the tablet device we've
    // actually got a mouse is reasonable. See https://bugs.kde.org/show_bug.cgi?id=283130.
    return d->mouse || d->device == KoInputDevice::InputDevice::Unknown
            || d->pointer == KoInputDevice::Pointer::Unknown;
}

References d, and Unknown.

◆ mouse()

static KoInputDevice KoInputDevice::mouse ( )

static

Standard mouse.

◆ operator=()

KoInputDevice & KoInputDevice::operator= ( const KoInputDevice & other )

assignment

Definition at line 76 of file KoInputDevice.cpp.

{
    d->device = other.d->device;
    d->pointer = other.d->pointer;
    d->uniqueTabletId = other.d->uniqueTabletId;
    d->mouse = other.d->mouse;
    return *this;
}

References d.

◆ operator==()

bool KoInputDevice::operator== ( const KoInputDevice & other ) const

equal

Definition at line 70 of file KoInputDevice.cpp.

{
    return d->device == other.d->device && d->pointer == other.d->pointer &&
        d->uniqueTabletId == other.d->uniqueTabletId && d->mouse == other.d->mouse;
}

References d.

◆ pointer()

Pointer KoInputDevice::pointer ( ) const

Return the pointer used

◆ Private()

KoInputDevice::Private	(	KoInputDevice::InputDevice	d,
		KoInputDevice::Pointer	p,
		qint64	id,
		bool	m )

inline

Definition at line 12 of file KoInputDevice.cpp.

        : device(d),
        pointer(p),
        uniqueTabletId(id),
        mouse(m) {
    }

◆ stylus()

KoInputDevice KoInputDevice::stylus ( )

static

Wacom style/pen.

Definition at line 101 of file KoInputDevice.cpp.

{
    KoInputDevice id(KoInputDevice::InputDevice::Stylus, KoInputDevice::Pointer::Pen);
    return id;
}

References Pen, and Stylus.

◆ uniqueTabletId()

qint64 KoInputDevice::uniqueTabletId ( ) const

Return the unique tablet id as registered by QTabletEvents. Note that this id can change randomly, so it's not dependable.

See https://bugs.kde.org/show_bug.cgi?id=407659

Member Data Documentation

◆ d

Private* const KoInputDevice::d

private

Definition at line 237 of file KoInputDevice.h.

◆ device

KoInputDevice::InputDevice KoInputDevice::device

Definition at line 18 of file KoInputDevice.cpp.

◆ mouse

KoInputDevice KoInputDevice::mouse

Definition at line 21 of file KoInputDevice.cpp.

◆ pointer

KoInputDevice::Pointer KoInputDevice::pointer

Definition at line 19 of file KoInputDevice.cpp.

◆ uniqueTabletId

qint64 KoInputDevice::uniqueTabletId

Definition at line 20 of file KoInputDevice.cpp.

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

libs/flake/KoInputDevice.cpp
libs/flake/KoInputDevice.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ InputDevice

◆ Pointer

Constructor & Destructor Documentation

◆ KoInputDevice() [1/3]

◆ KoInputDevice() [2/3]

◆ KoInputDevice() [3/3]

◆ ~KoInputDevice()

Member Function Documentation

◆ convertDeviceType()

◆ convertPointerType()

◆ device()

◆ eraser()

◆ invalid()

◆ isMouse()

◆ mouse()

◆ operator=()

◆ operator==()

◆ pointer()

◆ Private()

◆ stylus()

◆ uniqueTabletId()

Member Data Documentation

◆ d

◆ device

◆ mouse

◆ pointer

◆ uniqueTabletId