KWayland::Client::DataDevice

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 ()
 
DataOfferdragOffer () const
 
QPointer< SurfacedragSurface () const
 
bool isValid () const
 
DataOfferofferedSelection () 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 QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const 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)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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 const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const 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 32 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 169 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
serialThe serial for this enter
relativeToSurfaceCoordinates 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
relativeToSurfaceCoordinates relative to the upper-left corner of the entered Surface.
timetimestamp 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 233 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 228 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 179 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 174 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 184 of file datadevice.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 1 2020 22:51:44 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.