\inmodule QtWaylandCompositor More...

#include <qwaylandpointer.h>

Inheritance diagram for QWaylandPointer:

Collaboration diagram for QWaylandPointer:

Signals
void	outputChanged ()

void	buttonPressedChanged ()

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QWaylandPointer (QWaylandSeat seat, QObject parent=nullptr)
	Constructs a QWaylandPointer for the given seat and with the given parent.

QWaylandSeat *	seat () const
	Returns the input device for this QWaylandPointer.

QWaylandCompositor *	compositor () const
	Returns the compositor for this QWaylandPointer.

QWaylandOutput *	output () const
	Returns the output for this QWaylandPointer.

void	setOutput (QWaylandOutput *output)
	Sets the output for this QWaylandPointer to output.

virtual uint	sendMousePressEvent (Qt::MouseButton button)
	Sends a mouse press event for button to the view currently holding mouse focus.

virtual uint	sendMouseReleaseEvent (Qt::MouseButton button)
	Sends a mouse release event for button to the view currently holding mouse focus.

virtual void	sendMouseMoveEvent (QWaylandView *view, const QPointF &localPos, const QPointF &outputSpacePos)
	Sets the current mouse focus to view and sends a mouse move event to it with the local position localPos in surface coordinates and output space position outputSpacePos.

virtual void	sendMouseWheelEvent (Qt::Orientation orientation, int delta)
	Sends a mouse wheel event with the given orientation and delta to the view that currently holds mouse focus.

QWaylandView *	mouseFocus () const
	Returns the view that currently holds mouse focus.

QPointF	currentLocalPosition () const
	Returns the current local position of the QWaylandPointer in surface coordinates.

QPointF	currentSpacePosition () const
	Returns the current output space position of the QWaylandPointer.

bool	isButtonPressed () const
	Returns true if any button is currently pressed.

virtual void	addClient (QWaylandClient *client, uint32_t id, uint32_t version)

wl_resource *	focusResource () const
	Returns a Wayland resource for this QWaylandPointer.

uint	sendButton (struct wl_resource *resource, uint32_t time, Qt::MouseButton button, uint32_t state)

Public Member Functions inherited from QWaylandObject
	~QWaylandObject () override

QWaylandCompositorExtension *	extension (const QByteArray &name)
	Returns the compositor extension which matches name if one has been registered with the QWaylandObject.

QWaylandCompositorExtension *	extension (const wl_interface *interface)
	Returns the compositor extension which matches interface if one has been registered with the QWaylandObject.

QList< QWaylandCompositorExtension * >	extensions () const
	Returns the list of compositor extensions that have been registered with this QWaylandObject.

void	addExtension (QWaylandCompositorExtension *extension)
	Registers extension with this QWaylandObject.

void	removeExtension (QWaylandCompositorExtension *extension)
	Removes extension from the list of registered extensions in this QWaylandObject, if it has previously been registered using \l{addExtension()}.

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

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

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

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

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

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

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Static Public Member Functions
static uint32_t	toWaylandButton (Qt::MouseButton button)

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

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

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

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

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Properties
bool	isButtonPressed

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Protected Member Functions inherited from QWaylandObject
	QWaylandObject (QObject *parent=nullptr)
	Creates a QWaylandObject as a child of parent.

	QWaylandObject (QObjectPrivate &d, QObject *parent=nullptr)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes inherited from QWaylandObject
QList< QWaylandCompositorExtension * >	extension_vector

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

\inmodule QtWaylandCompositor

Since: 5.8

The QWaylandPointer class represents a pointer device.

This class provides access to the pointer device in a QWaylandSeat. It corresponds to the Wayland interface wl_pointer.

Definition at line 20 of file qwaylandpointer.h.

Constructor & Destructor Documentation

◆ QWaylandPointer()

QWaylandPointer::QWaylandPointer	(	QWaylandSeat *	seat,
		QObject *	parent = `nullptr`
	)

Constructs a QWaylandPointer for the given seat and with the given parent.

Definition at line 126 of file qwaylandpointer.cpp.

References QObject::connect(), QWaylandDestroyListener::fired(), QWaylandSeat::mouseFocusChanged(), and seat().

Here is the call graph for this function:

Member Function Documentation

◆ addClient()

void QWaylandPointer::addClient	(	QWaylandClient *	client,
		uint32_t	id,
		uint32_t	version
	)

virtual

Definition at line 289 of file qwaylandpointer.cpp.

References QWaylandClient::client(), and d.

Here is the call graph for this function:

◆ buttonPressedChanged

void QWaylandPointer::buttonPressedChanged ( )

signal

Referenced by sendMousePressEvent(), and sendMouseReleaseEvent().

Here is the caller graph for this function:

◆ compositor()

QWaylandCompositor * QWaylandPointer::compositor ( ) const

Returns the compositor for this QWaylandPointer.

Definition at line 145 of file qwaylandpointer.cpp.

References d.

◆ currentLocalPosition()

QPointF QWaylandPointer::currentLocalPosition ( ) const

Returns the current local position of the QWaylandPointer in surface coordinates.

Definition at line 262 of file qwaylandpointer.cpp.

References d.

◆ currentSpacePosition()

QPointF QWaylandPointer::currentSpacePosition ( ) const

Returns the current output space position of the QWaylandPointer.

Definition at line 271 of file qwaylandpointer.cpp.

References d.

◆ focusResource()

struct wl_resource * QWaylandPointer::focusResource ( ) const

Returns a Wayland resource for this QWaylandPointer.

This API doesn't actually make sense, since there may be many pointer resources per client It's here for compatibility reasons.

Definition at line 306 of file qwaylandpointer.cpp.

References d, and focus.

◆ isButtonPressed()

bool QWaylandPointer::isButtonPressed ( ) const

Returns true if any button is currently pressed.

Otherwise returns false.

Definition at line 280 of file qwaylandpointer.cpp.

References d.

◆ mouseFocus()

QWaylandView * QWaylandPointer::mouseFocus ( ) const

Returns the view that currently holds mouse focus.

Definition at line 253 of file qwaylandpointer.cpp.

References d.

◆ output()

QWaylandOutput * QWaylandPointer::output ( ) const

Returns the output for this QWaylandPointer.

Definition at line 154 of file qwaylandpointer.cpp.

References d.

Referenced by setOutput().

Here is the caller graph for this function:

◆ outputChanged

void QWaylandPointer::outputChanged ( )

signal

Referenced by setOutput().

Here is the caller graph for this function:

◆ seat()

QWaylandSeat * QWaylandPointer::seat ( ) const

Returns the input device for this QWaylandPointer.

Definition at line 136 of file qwaylandpointer.cpp.

References d.

Referenced by QWaylandPointer().

Here is the caller graph for this function:

◆ sendButton()

uint QWaylandPointer::sendButton	(	struct wl_resource *	resource,
		uint32_t	time,
		Qt::MouseButton	button,
		uint32_t	state
	)

Definition at line 320 of file qwaylandpointer.cpp.

References button, d, state, time, and toWaylandButton().

Here is the call graph for this function:

◆ sendMouseMoveEvent()

void QWaylandPointer::sendMouseMoveEvent	(	QWaylandView *	view,
		const QPointF &	localPos,
		const QPointF &	outputSpacePos
	)

virtual

Sets the current mouse focus to view and sends a mouse move event to it with the local position localPos in surface coordinates and output space position outputSpacePos.

Definition at line 207 of file qwaylandpointer.cpp.

References d, setOutput(), and view.

Here is the call graph for this function:

◆ sendMousePressEvent()

uint QWaylandPointer::sendMousePressEvent ( Qt::MouseButton button )

virtual

Sends a mouse press event for button to the view currently holding mouse focus.

Returns the serial number of the press event.

Definition at line 176 of file qwaylandpointer.cpp.

References button, buttonPressedChanged(), d, and emit.

Here is the call graph for this function:

◆ sendMouseReleaseEvent()

uint QWaylandPointer::sendMouseReleaseEvent ( Qt::MouseButton button )

virtual

Sends a mouse release event for button to the view currently holding mouse focus.

Returns the serial number of the release event.

Definition at line 192 of file qwaylandpointer.cpp.

References button, buttonPressedChanged(), d, and emit.

Here is the call graph for this function:

◆ sendMouseWheelEvent()

void QWaylandPointer::sendMouseWheelEvent	(	Qt::Orientation	orientation,
		int	delta
	)

virtual

Sends a mouse wheel event with the given orientation and delta to the view that currently holds mouse focus.

Definition at line 236 of file qwaylandpointer.cpp.

References d, Qt::Horizontal, and time.

◆ setOutput()

void QWaylandPointer::setOutput ( QWaylandOutput * output )

Sets the output for this QWaylandPointer to output.

Definition at line 163 of file qwaylandpointer.cpp.

References d, output(), and outputChanged().

Referenced by sendMouseMoveEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toWaylandButton()

uint32_t QWaylandPointer::toWaylandButton ( Qt::MouseButton button )

static

Definition at line 333 of file qwaylandpointer.cpp.

References button, Qt::ExtraButton1, Qt::ExtraButton10, Qt::ExtraButton11, Qt::ExtraButton12, Qt::ExtraButton13, Qt::ExtraButton2, Qt::ExtraButton3, Qt::ExtraButton4, Qt::ExtraButton5, Qt::ExtraButton6, Qt::ExtraButton7, Qt::ExtraButton8, Qt::ExtraButton9, Qt::LeftButton, Qt::MiddleButton, and Qt::RightButton.

Referenced by sendButton().

Here is the caller graph for this function:

Property Documentation

◆ isButtonPressed

bool QWaylandPointer::isButtonPressed

read

Definition at line 60 of file qwaylandpointer.h.

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

qtwayland/src/compositor/compositor_api/qwaylandpointer.h
qtwayland/src/compositor/compositor_api/qwaylandpointer.cpp

Signals

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QWaylandPointer()

Member Function Documentation

◆ addClient()

◆ buttonPressedChanged

◆ compositor()

◆ currentLocalPosition()

◆ currentSpacePosition()

◆ focusResource()

◆ isButtonPressed()

◆ mouseFocus()

◆ output()

◆ outputChanged

◆ seat()

◆ sendButton()

◆ sendMouseMoveEvent()

◆ sendMousePressEvent()

◆ sendMouseReleaseEvent()

◆ sendMouseWheelEvent()

◆ setOutput()

◆ toWaylandButton()

Property Documentation

◆ isButtonPressed