source: trunk/src/gui/kernel/qmime.h@ 442

Last change on this file since 442 was 442, checked in by Dmitry A. Kuminov, 16 years ago

gui: A bunch of updates to the DND code (the drop site party).
File size: 13.3 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information (qt-info@nokia.com)
5**
6** This file is part of the QtGui module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file. Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at qt-sales@nokia.com.
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QMIME_H
43#define QMIME_H
44
45#include <QtCore/qmimedata.h>
46
47QT_BEGIN_HEADER
48
49QT_BEGIN_NAMESPACE
50
51QT_MODULE(Gui)
52
53class Q_GUI_EXPORT QMimeSource
54{
55public:
56 virtual ~QMimeSource();
57 virtual const char* format(int n = 0) const = 0;
58 virtual bool provides(const char*) const;
59 virtual QByteArray encodedData(const char*) const = 0;
60};
61
62
63#if defined(Q_WS_WIN)
64
65QT_BEGIN_INCLUDE_NAMESPACE
66typedef struct tagFORMATETC FORMATETC;
67typedef struct tagSTGMEDIUM STGMEDIUM;
68struct IDataObject;
69
70#include <QtCore/qvariant.h>
71QT_END_INCLUDE_NAMESPACE
72
73/*
74 Encapsulation of conversion between MIME and Windows CLIPFORMAT.
75 Not need on X11, as the underlying protocol uses the MIME standard
76 directly.
77*/
78
79class Q_GUI_EXPORT QWindowsMime
80{
81public:
82 QWindowsMime();
83 virtual ~QWindowsMime();
84
85 // for converting from Qt
86 virtual bool canConvertFromMime(const FORMATETC &formatetc, const QMimeData *mimeData) const = 0;
87 virtual bool convertFromMime(const FORMATETC &formatetc, const QMimeData *mimeData, STGMEDIUM * pmedium) const = 0;
88 virtual QVector<FORMATETC> formatsForMime(const QString &mimeType, const QMimeData *mimeData) const = 0;
89
90 // for converting to Qt
91 virtual bool canConvertToMime(const QString &mimeType, IDataObject *pDataObj) const = 0;
92 virtual QVariant convertToMime(const QString &mimeType, IDataObject *pDataObj, QVariant::Type preferredType) const = 0;
93 virtual QString mimeForFormat(const FORMATETC &formatetc) const = 0;
94
95 static int registerMimeType(const QString &mime);
96
97private:
98 friend class QClipboardWatcher;
99 friend class QDragManager;
100 friend class QDropData;
101 friend class QOleDataObject;
102
103 static QWindowsMime *converterToMime(const QString &mimeType, IDataObject *pDataObj);
104 static QStringList allMimesForFormats(IDataObject *pDataObj);
105 static QWindowsMime *converterFromMime(const FORMATETC &formatetc, const QMimeData *mimeData);
106 static QVector<FORMATETC> allFormatsForMime(const QMimeData *mimeData);
107};
108
109#endif
110#if defined(Q_WS_PM)
111
112/*
113 Encapsulation of conversion between MIME and OS/2 PM clipboard formats and
114 between MIME and Direct Manipulation (DND) objects.
115*/
116
117#if !defined(QT_NO_DRAGANDDROP)
118QT_END_NAMESPACE
119#include "private/qpmobjectwindow_pm_p.h"
120QT_BEGIN_NAMESPACE
121#endif
122
123class QPMDragData;
124class QPMCoopDragWorker;
125
126class Q_GUI_EXPORT QPMMime
127{
128public:
129
130#if !defined(QT_NO_DRAGANDDROP)
131
132 typedef QList<QByteArray> QByteArrayList;
133
134 class DragWorker
135 {
136 public:
137 DragWorker() : src(0) {}
138 virtual ~DragWorker() {}
139
140 const QMimeData *source() const { return src; }
141
142 virtual void init() {}
143 // methods always implemented
144 virtual bool cleanup(bool isCancelled) = 0;
145 virtual bool isExclusive() const = 0;
146 virtual ULONG itemCount() const = 0;
147 virtual HWND hwnd() const = 0;
148 // methods implemented if isExclusive() == TRUE and itemCount() == 0
149 virtual DRAGINFO *createDragInfo(const char *name, USHORT supportedOps)
150 { return NULL; }
151 // methods implemented if itemCount() >= 0
152 virtual QByteArray composeFormatString() { return QByteArray(); }
153 virtual bool prepare(const char *drm, const char *drf, DRAGITEM *item,
154 ULONG itemIndex) { return FALSE; }
155 virtual void defaultFileType(const char *&type, const char *&ext) {};
156
157 private:
158 const QMimeData *src;
159 friend class QPMCoopDragWorker;
160 friend class QDragManager;
161 };
162
163 class DefaultDragWorker : public DragWorker, public QPMObjectWindow
164 {
165 private:
166 DefaultDragWorker(bool exclusive);
167 public:
168 virtual ~DefaultDragWorker();
169
170 // DragpWorker interface
171 bool cleanup(bool isCancelled);
172 bool isExclusive() const;
173 ULONG itemCount() const;
174 HWND hwnd() const { return QPMObjectWindow::hwnd(); }
175 QByteArray composeFormatString();
176 bool prepare(const char *drm, const char *drf, DRAGITEM *item,
177 ULONG itemIndex);
178 void defaultFileType(const char *&type, const char *&ext);
179
180 // QPMObjectWindow interface
181 MRESULT message(ULONG msg, MPARAM mp1, MPARAM mp2);
182
183 class Provider
184 {
185 public:
186 virtual const QString &format(const char *drf) const = 0;
187 virtual bool provide(const char *drf, const QByteArray &allData,
188 ULONG itemIndex, QByteArray &itemData) = 0;
189 virtual void fileType(const char *drf, const char *&type,
190 const char *&ext) {};
191 };
192
193 bool addProvider(const char *drf, Provider *provider,
194 ULONG itemCount = 1);
195
196 static bool canRender(const char *drm);
197
198 private:
199 struct Data;
200 Data *d;
201 friend class QPMMime;
202 };
203
204 class DropWorker
205 {
206 public:
207 DropWorker() : nfo(0) {}
208 virtual ~DropWorker() {}
209
210 DRAGINFO *info() const { return nfo; }
211
212 virtual void init() {}
213 virtual void cleanup(bool isAccepted) {}
214 virtual bool isExclusive() const = 0;
215
216 virtual bool hasFormat(const QString &mimeType) const = 0;
217 virtual QStringList formats() const = 0;
218 virtual QVariant retrieveData(const QString &mimeType, QVariant::Type type) const = 0;
219
220 private:
221 DRAGINFO *nfo;
222 friend class QPMDragData;
223 };
224
225 class DefaultDropWorker : public DropWorker, public QPMObjectWindow
226 {
227 private:
228 DefaultDropWorker();
229 public:
230 virtual ~DefaultDropWorker();
231
232 // DropWorker interface
233 void cleanup(bool isAccepted);
234 bool isExclusive() const;
235 bool hasFormat(const QString &mimeType) const;
236 QStringList formats() const;
237 QVariant retrieveData(const QString &mimeType, QVariant::Type type) const;
238
239 // QPMObjectWindow interface
240 MRESULT message(ULONG msg, MPARAM mp1, MPARAM mp2);
241
242 class Provider
243 {
244 public:
245 virtual const char *drf(const QString &mimeType) const = 0;
246 virtual bool provide(const QString &mimeType, ULONG itemIndex,
247 const QByteArray &itemData,
248 QByteArray &allData) = 0;
249 };
250
251 bool addProvider(const QString &mimeType, Provider *provider);
252 bool addExclusiveProvider(const QString &mimeType, Provider *provider);
253
254 static bool canRender(DRAGITEM *item, const char *drf );
255 static bool getSupportedRMFs(DRAGITEM *item, QList<QByteArrayList> &list);
256
257 private:
258 struct Data;
259 Data *d;
260 friend class QPMMime;
261 };
262
263#endif // !QT_NO_DRAGANDDROP
264
265 QPMMime();
266 virtual ~QPMMime();
267
268 struct MimeCFPair
269 {
270 MimeCFPair(const QString &m, ULONG f) : mime(m), format(f) {}
271 QString mime;
272 ULONG format;
273 };
274
275 // for converting from Qt
276 virtual QList<MimeCFPair> formatsForMimeData(const QMimeData *mimeData) const = 0;
277 virtual bool convertFromMimeData(const QMimeData *mimeData, ULONG format,
278 ULONG &flags, ULONG *data) const = 0;
279 // for converting to Qt
280 virtual QList<MimeCFPair> mimesForFormats(const QList<ULONG> &formats) const = 0;
281 virtual QVariant convertFromFormat(ULONG format, ULONG flags, ULONG data,
282 const QString &mimeType,
283 QVariant::Type preferredType) const = 0;
284
285#if !defined(QT_NO_DRAGANDDROP)
286 // Direct Manipulation (DND) converter interface
287 virtual DragWorker *dragWorkerFor(const QString &mimeType,
288 QMimeData *mimeData) { return 0; }
289 virtual DropWorker *dropWorkerFor(DRAGINFO *info) { return 0; }
290#endif // !QT_NO_DRAGANDDROP
291
292protected:
293
294 static ULONG registerMimeType(const QString &mime);
295 static void unregisterMimeType(ULONG mimeId);
296
297 static QList<QPMMime*> all();
298
299 static ULONG allocateMemory(size_t size);
300 static void freeMemory(ULONG addr);
301
302 static QString formatName(ULONG format);
303
304#if !defined(QT_NO_DRAGANDDROP)
305 static QByteArray queryHSTR(HSTR hstr);
306 static QByteArray querySourceNameFull(DRAGITEM *item);
307 static bool canTargetRenderAsOS2File(DRAGITEM *item, QByteArray *fullName = 0);
308 static bool parseRMFs(HSTR rmfs, QList<QByteArrayList> &list);
309 static bool parseRMF(HSTR rmf, QByteArray &mechanism, QByteArray &format);
310
311 static DefaultDragWorker *defaultCoopDragWorker();
312 static DefaultDragWorker *defaultExclDragWorker();
313 static DefaultDropWorker *defaultDropWorker();
314#endif // !QT_NO_DRAGANDDROP
315
316private:
317 friend class QClipboardWatcher;
318 friend class QClipboardData;
319 friend class QClipboard;
320 friend class QPMDragData;
321
322 struct Match
323 {
324 Match(QPMMime *c, const QString f, ULONG cf, int p) :
325 converter(c), mime(f), format(cf), priority(p) {}
326
327 QPMMime *converter;
328 QString mime;
329 ULONG format;
330 int priority;
331 };
332
333 static QList<Match> allConvertersFromFormats(const QList<ULONG> &formats);
334 static QList<Match> allConvertersFromMimeData(const QMimeData *mimeData);
335};
336
337#endif
338#if defined(Q_WS_MAC)
339
340/*
341 Encapsulation of conversion between MIME and Mac flavor.
342 Not needed on X11, as the underlying protocol uses the MIME standard
343 directly.
344*/
345
346class Q_GUI_EXPORT QMacMime { //Obsolete
347 char type;
348public:
349 enum QMacMimeType { MIME_DND=0x01, MIME_CLIP=0x02, MIME_QT_CONVERTOR=0x04, MIME_ALL=MIME_DND|MIME_CLIP };
350 explicit QMacMime(char) { }
351 virtual ~QMacMime() { }
352
353 static void initialize() { }
354
355 static QList<QMacMime*> all(QMacMimeType) { return QList<QMacMime*>(); }
356 static QMacMime *convertor(QMacMimeType, const QString &, int) { return 0; }
357 static QString flavorToMime(QMacMimeType, int) { return QString(); }
358
359 virtual QString convertorName()=0;
360 virtual int countFlavors()=0;
361 virtual int flavor(int index)=0;
362 virtual bool canConvert(const QString &mime, int flav)=0;
363 virtual QString mimeFor(int flav)=0;
364 virtual int flavorFor(const QString &mime)=0;
365 virtual QVariant convertToMime(const QString &mime, QList<QByteArray> data, int flav)=0;
366 virtual QList<QByteArray> convertFromMime(const QString &mime, QVariant data, int flav)=0;
367};
368
369class Q_GUI_EXPORT QMacPasteboardMime {
370 char type;
371public:
372 enum QMacPasteboardMimeType { MIME_DND=0x01,
373 MIME_CLIP=0x02,
374 MIME_QT_CONVERTOR=0x04,
375 MIME_QT3_CONVERTOR=0x08,
376 MIME_ALL=MIME_DND|MIME_CLIP
377 };
378 explicit QMacPasteboardMime(char);
379 virtual ~QMacPasteboardMime();
380
381 static void initialize();
382
383 static QList<QMacPasteboardMime*> all(uchar);
384 static QMacPasteboardMime *convertor(uchar, const QString &mime, QString flav);
385 static QString flavorToMime(uchar, QString flav);
386
387 virtual QString convertorName() = 0;
388
389 virtual bool canConvert(const QString &mime, QString flav) = 0;
390 virtual QString mimeFor(QString flav) = 0;
391 virtual QString flavorFor(const QString &mime) = 0;
392 virtual QVariant convertToMime(const QString &mime, QList<QByteArray> data, QString flav) = 0;
393 virtual QList<QByteArray> convertFromMime(const QString &mime, QVariant data, QString flav) = 0;
394};
395
396// ### Qt 5: Add const QStringList& QMacPasteboardMime::supportedFlavours()
397Q_GUI_EXPORT void qRegisterDraggedTypes(const QStringList &types);
398#endif // Q_WS_MAC
399
400QT_END_NAMESPACE
401
402QT_END_HEADER
403
404#endif // QMIME_H
Note: See TracBrowser for help on using the repository browser.