KWayland::Client::DataSource Class Reference

#include <datasource.h>

Inheritance diagram for KWayland::Client::DataSource:

Signals
void	cancelled ()
void	dragAndDropFinished ()
void	dragAndDropPerformed ()
void	selectedDragAndDropActionChanged ()
void	sendDataRequested (const QString &mimeType, qint32 fd)
void	targetAccepts (const QString &mimeType)

Public Member Functions
	DataSource (QObject *parent=nullptr)
void	destroy ()
bool	isValid () const
void	offer (const QString &mimeType)
void	offer (const QMimeType &mimeType)
	operator wl_data_source * ()
	operator wl_data_source * () const
void	release ()
DataDeviceManager::DnDAction	selectedDragAndDropAction () const
void	setDragAndDropActions (DataDeviceManager::DnDActions actions)
void	setup (wl_data_source *dataSource)
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_data_source interface.

This class is a convenient wrapper for the wl_data_source interface. To create a DataSource call DataDeviceManager::createDataSource.

See also

DataDeviceManager

Definition at line 47 of file datasource.h.

Member Function Documentation

void KWayland::Client::DataSource::cancelled ( )

signal

This DataSource has been replaced by another DataSource.

The client should clean up and destroy this DataSource.

void KWayland::Client::DataSource::destroy

(

)

Destroys the data held by this DataSource.

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

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

See also

release

Definition at line 159 of file datasource.cpp.

void KWayland::Client::DataSource::dragAndDropFinished ( )

signal

The drag-and-drop operation concluded.

The drop destination finished interoperating with this DataSource, so the client is now free to destroy this DataSource.

If the action used to perform the operation was "move", the source can now delete the transferred data.

Since

5.42

void KWayland::Client::DataSource::dragAndDropPerformed ( )

signal

The drag-and-drop operation physically finished.

The user performed the drop action. This signal does not indicate acceptance, cancelled} may still be emitted afterwards if the drop destination does not accept any mime type.

However, this signal might not be received if the compositor cancelled the drag-and-drop operation before this signal could happen.

Note that the DataSource may still be used in the future and should not be destroyed here.

Since

5.42

bool KWayland::Client::DataSource::isValid

(

)

const

Returns

true if managing a wl_data_source.

Definition at line 164 of file datasource.cpp.

void KWayland::Client::DataSource::release

(

)

Releases the wl_data_source interface.

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

Definition at line 154 of file datasource.cpp.

DataDeviceManager::DnDAction KWayland::Client::DataSource::selectedDragAndDropAction

(

)

const

The currently selected drag and drop action by the compositor.

See also

selectedDragAndDropActionChanged

Since

5.42

Definition at line 212 of file datasource.cpp.

void KWayland::Client::DataSource::selectedDragAndDropActionChanged ( )

signal

Emitted whenever the selected drag and drop action changes.

See also

selectedDragAndDropAction

Since

5.42

void KWayland::Client::DataSource::sendDataRequested ( const QString &  mimeType, qint32  fd  )

signal

Request for data from the client.

Send the data as the specified mimeType over the passed file descriptor fd, then close it.

void KWayland::Client::DataSource::setDragAndDropActions

(

DataDeviceManager::DnDActions

actions

)

Sets the actions that the source side client supports for this operation.

This request must be made once only, and can only be made on sources used in drag-and-drop, so it must be performed before DataDevice::startDrag}. Attempting to use the source other than for drag-and-drop will raise a protocol error.

Since

5.42

Definition at line 197 of file datasource.cpp.

void KWayland::Client::DataSource::setup

(

wl_data_source *

dataSource

)

Setup this DataSource to manage the dataSource.

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

Definition at line 169 of file datasource.cpp.

void KWayland::Client::DataSource::targetAccepts ( const QString &  mimeType )

signal

Emitted when a target accepts pointer_focus or motion events.

If a target does not accept any of the offered types, mimeType is empty.

---

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

• datasource.h
• datasource.cpp