KWayland - KWayland::Client::Pointer Class Reference

View on LXR

KWayland
Client
Pointer

#include <pointer.h>

Inheritance diagram for KWayland::Client::Pointer:

Public Types
enum	Axis { Vertical, Horizontal }

enum	AxisSource { Wheel, Finger, Continuous, WheelTilt }

enum	ButtonState { Released, Pressed }

Signals
void	axisChanged (quint32 time, KWayland::Client::Pointer::Axis axis, qreal delta)

void	axisDiscreteChanged (KWayland::Client::Pointer::Axis axis, qint32 discreteDelta)

void	axisSourceChanged (KWayland::Client::Pointer::AxisSource source)

void	axisStopped (quint32 time, KWayland::Client::Pointer::Axis axis)

void	buttonStateChanged (quint32 serial, quint32 time, quint32 button, KWayland::Client::Pointer::ButtonState state)

void	entered (quint32 serial, const QPointF &relativeToSurface)

void	frame ()

void	left (quint32 serial)

void	motion (const QPointF &relativeToSurface, quint32 time)

Public Member Functions
	Pointer (QObject *parent=nullptr)

void	destroy ()

Surface *	enteredSurface () const

Surface *	enteredSurface ()

void	hideCursor ()

bool	isValid () const

	operator wl_pointer * ()

	operator wl_pointer * () const

void	release ()

void	setCursor (Surface *surface, const QPoint &hotspot=QPoint())

void	setup (wl_pointer *pointer)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

bool	blockSignals (bool block)

const QObjectList &	children () const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const

bool	disconnect (const QObject receiver, const char method) const

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QString &name, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegExp &regExp, QFlags< Qt::FindChildOption > options) const

QList< T >	findChildren (const QRegularExpression &re, QFlags< Qt::FindChildOption > options) const

bool	inherits (const char *className) const

void	installEventFilter (QObject *filterObj)

bool	isWidgetType () const

bool	isWindowType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

QString	objectName () const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const

QVariant	property (const char *name) const

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval, Qt::TimerType timerType)

QThread *	thread () const

Additional Inherited Members
Properties inherited from QObject
	objectName

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Wrapper for the wl_pointer interface.

This class is a convenient wrapper for the wl_pointer interface.

To create an instance use Seat::createPointer.

See also: Seat

Definition at line 46 of file pointer.h.

Member Function Documentation

void KWayland::Client::Pointer::axisChanged	(	quint32	time,
		KWayland::Client::Pointer::Axis	axis,
		qreal	delta
	)

signal

Scroll and other axis notifications.

Parameters

time	timestamp with millisecond granularity
axis	`Vertical` or `Horizontal`
delta

void KWayland::Client::Pointer::axisDiscreteChanged	(	KWayland::Client::Pointer::Axis	axis,
		qint32	discreteDelta
	)

signal

Discrete step information for scroll and other axes.

Since: 5.59

void KWayland::Client::Pointer::axisSourceChanged ( KWayland::Client::Pointer::AxisSource source )

signal

Indicates the source of scroll and other axes.

Since: 5.59

void KWayland::Client::Pointer::axisStopped	(	quint32	time,
		KWayland::Client::Pointer::Axis	axis
	)

signal

Stop notification for scroll and other axes.

Since: 5.59

void KWayland::Client::Pointer::buttonStateChanged	(	quint32	serial,
		quint32	time,
		quint32	button,
		KWayland::Client::Pointer::ButtonState	state
	)

signal

Mouse button click and release notifications.

The location of the click is given by the last motion or enter event.

Parameters

serial	The serial of this button state change
time	timestamp with millisecond granularity, with an undefined base.
button	The button which got changed
state	`Released` or `Pressed`

void KWayland::Client::Pointer::destroy ( )

Destroys the data held by this Pointer.

This method is supposed to be used when the connection to the Wayland server goes away. If the connection is not valid anymore, it's not possible to call release anymore as that calls into the Wayland connection and the call would fail. This method cleans up the data, so that the instance can be deleted or set up to a new wl_pointer interface once there is a new connection available.

This method is automatically invoked when the Seat which created this Pointer gets destroyed.

See also: release

Definition at line 115 of file pointer.cpp.

void KWayland::Client::Pointer::entered	(	quint32	serial,
		const QPointF &	relativeToSurface
	)

signal

Notification that this seat's pointer is focused on a certain surface.

When an seat's focus enters a surface, the pointer image is undefined and a client should respond to this event by setting an appropriate pointer image with the set_cursor request.

Parameters

serial	The serial for this enter
relativeToSurface	Coordinates relative to the upper-left corner of the Surface.

Surface * KWayland::Client::Pointer::enteredSurface ( ) const

Returns: The Surface the Pointer is on, may be null.

Definition at line 248 of file pointer.cpp.

Surface * KWayland::Client::Pointer::enteredSurface ( )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 243 of file pointer.cpp.

void KWayland::Client::Pointer::frame ( )

signal

Indicates the end of a set of events that logically belong together.

A client is expected to accumulate the data in all events within the frame before proceeding.

Since: 5.45

void KWayland::Client::Pointer::hideCursor ( )

Hides the cursor.

Same as calling setCursor with null for surface.

See also: setCursor

Since: 5.3

Definition at line 238 of file pointer.cpp.

bool KWayland::Client::Pointer::isValid ( ) const

Returns: true if managing a wl_pointer.

Definition at line 253 of file pointer.cpp.

void KWayland::Client::Pointer::left ( quint32 serial )

signal

Notification that this seat's pointer is no longer focused on a certain surface.

The leave notification is sent before the enter notification for the new focus.

Parameters

serial The serial of this leave event

void KWayland::Client::Pointer::motion	(	const QPointF &	relativeToSurface,
		quint32	time
	)

signal

Notification of pointer location change.

Parameters

relativeToSurface	Coordinates relative to the upper-left corner of the entered Surface.
time	timestamp with millisecond granularity

void KWayland::Client::Pointer::release ( )

Releases the wl_pointer interface.

After the interface has been released the Pointer instance is no longer valid and can be setup with another wl_pointer interface.

This method is automatically invoked when the Seat which created this Pointer gets released.

Definition at line 110 of file pointer.cpp.

void KWayland::Client::Pointer::setCursor	(	Surface *	surface,
		const QPoint &	hotspot = `QPoint()`
	)

Sets the cursor image for this Pointer.

This has only an effect if a Surface of the same client is focused.

Parameters

surface	The Surface pointing to the image data, if `null` the cursor will be hidden
hotspot	The hotspot of the cursor image

See also: hideCursor

Since: 5.3

Definition at line 228 of file pointer.cpp.

void KWayland::Client::Pointer::setup ( wl_pointer * pointer )

Setup this Pointer to manage the pointer.

When using Seat::createPointer there is no need to call this method.

Definition at line 120 of file pointer.cpp.

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

KDE's Doxygen guidelines are available online.

Quick Links

Class Picker

About

KWayland::Client::Pointer

Public Types

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation