KWayland::Client::DataDevice Class Reference

#include <datadevice.h>

Inheritance diagram for KWayland::Client::DataDevice:

Signals
void	dragEntered (quint32 serial, const QPointF &relativeToSurface)
void	dragLeft ()
void	dragMotion (const QPointF &relativeToSurface, quint32 time)
void	dropped ()
void	selectionCleared ()
void	selectionOffered (KWayland::Client::DataOffer *)

Public Member Functions
	DataDevice (QObject *parent=nullptr)
void	clearSelection (quint32 serial)
void	destroy ()
DataOffer *	dragOffer () const
QPointer< Surface >	dragSurface () const
bool	isValid () const
DataOffer *	offeredSelection () const
	operator wl_data_device * ()
	operator wl_data_device * () const
void	release ()
void	setSelection (quint32 serial, DataSource *source=nullptr)
void	setup (wl_data_device *dataDevice)
void	startDrag (quint32 serial, DataSource *source, Surface *origin, Surface *icon=nullptr)
void	startDragInternally (quint32 serial, Surface *origin, Surface *icon=nullptr)
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

DataDevice allows clients to share data by copy-and-paste and drag-and-drop.

This class is a convenient wrapper for the wl_data_device interface. To create a DataDevice call DataDeviceManager::getDataDevice.

See also

DataDeviceManager

Definition at line 46 of file datadevice.h.

Member Function Documentation

void KWayland::Client::DataDevice::destroy

(

)

Destroys the data held by this DataDevice.

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_data_device interface once there is a new connection available.

This method is automatically invoked when the Registry which created this DataDevice gets destroyed.

See also

release

Definition at line 183 of file datadevice.cpp.

void KWayland::Client::DataDevice::dragEntered ( quint32  serial, const QPointF &  relativeToSurface  )

signal

Notification that a drag'n'drop operation entered a Surface on this DataDevice.

Parameters

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

See also

dragSurface

dragOffer

dragLeft

dragMotion

Since

5.22

void KWayland::Client::DataDevice::dragLeft ( )

signal

Notification that the drag'n'drop operation left the Surface on this DataDevice.

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

See also

dragEnter

Since

5.22

void KWayland::Client::DataDevice::dragMotion ( const QPointF &  relativeToSurface, quint32  time  )

signal

Notification of drag motion events on the current drag surface.

Parameters

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

See also

dragEntered

Since

5.22

DataOffer * KWayland::Client::DataDevice::dragOffer

(

)

const

Returns

the DataOffer during a drag'n'drop operation.

Since

5.22

Definition at line 247 of file datadevice.cpp.

QPointer< Surface > KWayland::Client::DataDevice::dragSurface

(

)

const

Returns

the currently focused surface during drag'n'drop on this DataDevice.

Since

5.22

Definition at line 242 of file datadevice.cpp.

void KWayland::Client::DataDevice::dropped ( )

signal

Emitted when the implicit grab is removed and the drag'n'drop operation ended on this DataDevice.

The client can now start a data transfer on the DataOffer.

See also

dragEntered

dragOffer

Since

5.22

bool KWayland::Client::DataDevice::isValid

(

)

const

Returns

true if managing a wl_data_device.

Definition at line 193 of file datadevice.cpp.

void KWayland::Client::DataDevice::release

(

)

Releases the wl_data_device interface.

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

Definition at line 188 of file datadevice.cpp.

void KWayland::Client::DataDevice::setup

(

wl_data_device *

dataDevice

)

Setup this DataDevice to manage the dataDevice.

When using DataDeviceManager::createDataDevice there is no need to call this method.

Definition at line 198 of file datadevice.cpp.

---

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

• datadevice.h
• datadevice.cpp