Differential D9136 Diff 24382 src/client/datasource.h

Changeset View

Standalone View

View Options

src/client/datasource.h

Show All 15 Lines
16 16​
17You should have received a copy of the GNU Lesser General Public 17​You should have received a copy of the GNU Lesser General Public
18License along with this library. If not, see <http://www.gnu.org/licenses/>. 18​License along with this library. If not, see <http://www.gnu.org/licenses/>.
19*********************************************************************/ 19​*********************************************************************/
20#ifndef WAYLAND_DATASOURCE_H 20​#ifndef WAYLAND_DATASOURCE_H
21#define WAYLAND_DATASOURCE_H 21​#define WAYLAND_DATASOURCE_H
22 22​
23#include "buffer.h" 23​#include "buffer.h"
24​#include "datadevicemanager.h"
24 25​
25#include <QObject> 26​#include <QObject>
26 27​
27#include <KWayland/Client/kwaylandclient_export.h> 28​#include <KWayland/Client/kwaylandclient_export.h>
28 29​
29struct wl_data_source; 30​struct wl_data_source;
30class QMimeType; 31​class QMimeType;
31 32​
▲ Show 20 Lines • Show All 48 Lines • ▼ Show 20 Line(s)50public:
80 /** 81​ /**
81 * @returns @c true if managing a wl_data_source. 82​ * @returns @c true if managing a wl_data_source.
82 **/ 83​ **/
83 bool isValid() const; 84​ bool isValid() const;
84 85​
85 void offer(const QString &mimeType); 86​ void offer(const QString &mimeType);
86 void offer(const QMimeType &mimeType); 87​ void offer(const QMimeType &mimeType);
87 88​
89​ /**
90​ * Sets the actions that the source side client supports for this
91​ * operation.
92​ *
93​ * This request must be made once only, and can only be made on sources
94​ * used in drag-and-drop, so it must be performed before
95​ * @link{DataDevice::startDrag}. Attempting to use the source other than
96​ * for drag-and-drop will raise a protocol error.
97​ * @since 5.42
98​ **/
99​ void setDragAndDropActions(DataDeviceManager::DnDActions actions);
100​
101​ /**
102​ * The currently selected drag and drop action by the compositor.
103​ * @see selectedDragAndDropActionChanged
104​ * @since 5.42
105​ **/
106​ DataDeviceManager::DnDAction selectedDragAndDropAction() const;
107​
88 operator wl_data_source*(); 108​ operator wl_data_source*();
89 operator wl_data_source*() const; 109​ operator wl_data_source*() const;
90 110​
91Q_SIGNALS: 111​Q_SIGNALS:
92 /** 112​ /**
93 * Emitted when a target accepts pointer_focus or motion events. If 113​ * Emitted when a target accepts pointer_focus or motion events. If
94 * a target does not accept any of the offered types, @p mimeType is empty. 114​ * a target does not accept any of the offered types, @p mimeType is empty.
95 **/ 115​ **/
96 void targetAccepts(const QString &mimeType); 116​ void targetAccepts(const QString &mimeType);
97 /** 117​ /**
98 * Request for data from the client. Send the data as the 118​ * Request for data from the client. Send the data as the
99 * specified @p mimeType over the passed file descriptor @p fd, then close 119​ * specified @p mimeType over the passed file descriptor @p fd, then close
100 * it. 120​ * it.
101 **/ 121​ **/
102 void sendDataRequested(const QString &mimeType, qint32 fd); 122​ void sendDataRequested(const QString &mimeType, qint32 fd);
103 /** 123​ /**
104 * This DataSource has been replaced by another DataSource. 124​ * This DataSource has been replaced by another DataSource.
105 * The client should clean up and destroy this DataSource. 125​ * The client should clean up and destroy this DataSource.
106 **/ 126​ **/
107 void cancelled(); 127​ void cancelled();
108 128​
129​ /**
130​ * The drag-and-drop operation physically finished.
131​ *
132​ * The user performed the drop action. This signal does not
133​ * indicate acceptance, @link{cancelled} may still be
134​ * emitted afterwards if the drop destination does not accept any
135​ * mime type.
136​ *
137​ * However, this signal might not be received if the
138​ * compositor cancelled the drag-and-drop operation before this
139​ * signal could happen.
140​ *
141​ * Note that the DataSource may still be used in the future and
142​ * should not be destroyed here.
143​ * @since 5.42
144​ **/
145​ void dragAndDropPerformed();
146​
147​ /**
148​ * The drag-and-drop operation concluded.
149​ *
150​ * The drop destination finished interoperating with this DataSource,
151​ * so the client is now free to destroy this DataSource.
152​ *
153​ * If the action used to perform the operation was "move", the
154​ * source can now delete the transferred data.
155​ * @since 5.42
156​ */
157​ void dragAndDropFinished();
158​
159​ /**
160​ * Emitted whenever the selected drag and drop action changes.
161​ * @see selectedDragAndDropAction
162​ * @since 5.42
163​ **/
164​ void selectedDragAndDropActionChanged();
165​
109private: 166​private:
110 class Private; 167​ class Private;
111 QScopedPointer<Private> d; 168​ QScopedPointer<Private> d;
112}; 169​};
113 170​
114} 171​}
115} 172​}
116 173​
117#endif 174​#endif