kwin/src/wayland/abstract_data_source.h

80 lines
2.2 KiB
C
Raw Normal View History

/*
SPDX-FileCopyrightText: 2020 David Edmundson <davidedmundson@kde.org>
SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#pragma once
#include "resource.h"
#include "clientconnection.h"
#include "datadevicemanager_interface.h"
#include <KWaylandServer/kwaylandserver_export.h>
struct wl_client;
namespace KWaylandServer {
/**
* @brief The AbstractDataSource class abstracts the data that
* can be transferred to another client.
*
* It loosely maps to DataDeviceInterface
*/
// Anything related to selections are pure virtual, content relating
// to drag and drop has a default implementation
// TODO ideally this shouldn't inherit from resource as it provides some misleading public methods
// This can be resolved once DataSource is ported to the new system
class KWAYLANDSERVER_EXPORT AbstractDataSource : public Resource
{
Q_OBJECT
public:
virtual void accept(const QString &mimeType) {
Q_UNUSED(mimeType);
};
virtual void requestData(const QString &mimeType, qint32 fd) = 0;
virtual void cancel() = 0;
virtual QStringList mimeTypes() const = 0;
/**
* @returns The Drag and Drop actions supported by this DataSourceInterface.
**/
virtual DataDeviceManagerInterface::DnDActions supportedDragAndDropActions() const {
return {};
};
/**
* The user performed the drop action during a drag and drop operation.
**/
virtual void dropPerformed() {};
/**
* The drop destination finished interoperating with this data source.
**/
virtual void dndFinished() {};
/**
* This event indicates the @p action selected by the compositor after matching the
* source/destination side actions. Only one action (or none) will be offered here.
**/
virtual void dndAction(DataDeviceManagerInterface::DnDAction action) {
Q_UNUSED(action);
};
virtual wl_client* client() {
return Resource::client()->client();
}
Q_SIGNALS:
void mimeTypeOffered(const QString&);
void supportedDragAndDropActionsChanged();
protected:
explicit AbstractDataSource(Resource::Private *d, QObject *parent = nullptr);
};
}