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

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

gui: DnD: Drag party code in progress.
File size: 13.5 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
117QT_END_NAMESPACE
118#include "qt_os2.h"
119#if !defined(QT_NO_DRAGANDDROP)
120# include "private/qpmobjectwindow_pm_p.h"
121#endif
122QT_BEGIN_NAMESPACE
123
124class QPMDragData;
125class QPMCoopDragWorker;
126
127class Q_GUI_EXPORT QPMMime
128{
129public:
130
131#if !defined(QT_NO_DRAGANDDROP)
132
133 typedef QList<QByteArray> QByteArrayList;
134
135 class DragWorker
136 {
137 public:
138 DragWorker() : src(0) {}
139 virtual ~DragWorker() {}
140
141 const QMimeData *source() const { return src; }
142
143 virtual void init() {}
144 // methods always implemented
145 virtual bool cleanup(bool isCancelled) = 0;
146 virtual bool isExclusive() const = 0;
147 virtual ULONG itemCount() const = 0;
148 virtual HWND hwnd() const = 0;
149 // methods implemented if isExclusive() == TRUE and itemCount() == 0
150 virtual DRAGINFO *createDragInfo(const QString &targetName, USHORT supportedOps)
151 { return 0; }
152 // methods implemented if itemCount() >= 0
153 virtual QByteArray composeFormatString() { return QByteArray(); }
154 virtual bool prepare(const char *drm, const char *drf, DRAGITEM *item,
155 ULONG itemIndex) { return false; }
156 virtual void defaultFileType(const char *&type, const char *&ext) {};
157
158 private:
159 const QMimeData *src;
160 friend class QPMCoopDragWorker;
161 friend class QDragManager;
162 };
163
164 class DefaultDragWorker : public DragWorker, public QPMObjectWindow
165 {
166 private:
167 DefaultDragWorker(bool exclusive);
168 public:
169 virtual ~DefaultDragWorker();
170
171 // DragpWorker interface
172 bool cleanup(bool isCancelled);
173 bool isExclusive() const;
174 ULONG itemCount() const;
175 HWND hwnd() const { return QPMObjectWindow::hwnd(); }
176 QByteArray composeFormatString();
177 bool prepare(const char *drm, const char *drf, DRAGITEM *item,
178 ULONG itemIndex);
179 void defaultFileType(const char *&type, const char *&ext);
180
181 // QPMObjectWindow interface
182 MRESULT message(ULONG msg, MPARAM mp1, MPARAM mp2);
183
184 class Provider
185 {
186 public:
187 virtual QString format(const char *drf) const = 0;
188 virtual bool provide(const char *drf, const QByteArray &allData,
189 ULONG itemIndex, QByteArray &itemData) = 0;
190 virtual void fileType(const char *drf, const char *&type,
191 const char *&ext) {};
192 };
193
194 bool addProvider(const char *drf, Provider *provider,
195 ULONG itemCount = 1);
196
197 static bool canRender(const char *drm);
198
199 private:
200 struct Data;
201 Data *d;
202 friend class QPMMime;
203 };
204
205 class DropWorker
206 {
207 public:
208 DropWorker() : nfo(0) {}
209 virtual ~DropWorker() {}
210
211 DRAGINFO *info() const { return nfo; }
212
213 virtual void init() {}
214 virtual void cleanup(bool isAccepted) {}
215 virtual bool isExclusive() const = 0;
216
217 virtual bool hasFormat(const QString &mimeType) const = 0;
218 virtual QStringList formats() const = 0;
219 virtual QVariant retrieveData(const QString &mimeType,
220 QVariant::Type preferredType) const = 0;
221
222 private:
223 DRAGINFO *nfo;
224 friend class QPMDragData;
225 };
226
227 class DefaultDropWorker : public DropWorker, public QPMObjectWindow
228 {
229 private:
230 DefaultDropWorker();
231 public:
232 virtual ~DefaultDropWorker();
233
234 // DropWorker interface
235 void cleanup(bool isAccepted);
236 bool isExclusive() const;
237 bool hasFormat(const QString &mimeType) const;
238 QStringList formats() const;
239 QVariant retrieveData(const QString &mimeType,
240 QVariant::Type preferredType) const;
241
242 // QPMObjectWindow interface
243 MRESULT message(ULONG msg, MPARAM mp1, MPARAM mp2);
244
245 class Provider
246 {
247 public:
248 virtual const char *drf(const QString &mimeType) const = 0;
249 virtual bool provide(const QString &mimeType, ULONG itemIndex,
250 const QByteArray &itemData,
251 QByteArray &allData) = 0;
252 };
253
254 bool addProvider(const QString &mimeType, Provider *provider);
255 bool addExclusiveProvider(const QString &mimeType, Provider *provider);
256
257 static bool canRender(DRAGITEM *item, const char *drf );
258 static bool getSupportedRMFs(DRAGITEM *item, QList<QByteArrayList> &list);
259
260 private:
261 struct Data;
262 Data *d;
263 friend class QPMMime;
264 };
265
266#endif // !QT_NO_DRAGANDDROP
267
268 QPMMime();
269 virtual ~QPMMime();
270
271 struct MimeCFPair
272 {
273 MimeCFPair(const QString &m, ULONG f) : mime(m), format(f) {}
274 QString mime;
275 ULONG format;
276 };
277
278 // for converting from Qt
279 virtual QList<MimeCFPair> formatsForMimeData(const QMimeData *mimeData) const = 0;
280 virtual bool convertFromMimeData(const QMimeData *mimeData, ULONG format,
281 ULONG &flags, ULONG *data) const = 0;
282 // for converting to Qt
283 virtual QList<MimeCFPair> mimesForFormats(const QList<ULONG> &formats) const = 0;
284 virtual QVariant convertFromFormat(ULONG format, ULONG flags, ULONG data,
285 const QString &mimeType,
286 QVariant::Type preferredType) const = 0;
287
288#if !defined(QT_NO_DRAGANDDROP)
289 // Direct Manipulation (DND) converter interface
290 virtual DragWorker *dragWorkerFor(const QString &mimeType,
291 QMimeData *mimeData) { return 0; }
292 virtual DropWorker *dropWorkerFor(DRAGINFO *info) { return 0; }
293#endif // !QT_NO_DRAGANDDROP
294
295protected:
296
297 static ULONG registerMimeType(const QString &mime);
298 static void unregisterMimeType(ULONG mimeId);
299
300 static QList<QPMMime*> all();
301
302 static ULONG allocateMemory(size_t size);
303 static void freeMemory(ULONG addr);
304
305 static QString formatName(ULONG format);
306
307#if !defined(QT_NO_DRAGANDDROP)
308 static QByteArray queryHSTR(HSTR hstr);
309 static QByteArray querySourceNameFull(DRAGITEM *item);
310 static bool canTargetRenderAsOS2File(DRAGITEM *item, QByteArray *fullName = 0);
311 static bool parseRMFs(HSTR rmfs, QList<QByteArrayList> &list);
312 static bool parseRMF(HSTR rmf, QByteArray &mechanism, QByteArray &format);
313
314 static DefaultDragWorker *defaultCoopDragWorker();
315 static DefaultDragWorker *defaultExclDragWorker();
316 static DefaultDropWorker *defaultDropWorker();
317#endif // !QT_NO_DRAGANDDROP
318
319private:
320 friend class QClipboardWatcher;
321 friend class QClipboardData;
322 friend class QClipboard;
323 friend class QPMDragData;
324 friend class QPMCoopDragWorker;
325
326 struct Match
327 {
328 Match(QPMMime *c, const QString f, ULONG cf, int p) :
329 converter(c), mime(f), format(cf), priority(p) {}
330
331 QPMMime *converter;
332 QString mime;
333 ULONG format;
334 int priority;
335 };
336
337 static QList<Match> allConvertersFromFormats(const QList<ULONG> &formats);
338 static QList<Match> allConvertersFromMimeData(const QMimeData *mimeData);
339};
340
341#endif
342#if defined(Q_WS_MAC)
343
344/*
345 Encapsulation of conversion between MIME and Mac flavor.
346 Not needed on X11, as the underlying protocol uses the MIME standard
347 directly.
348*/
349
350class Q_GUI_EXPORT QMacMime { //Obsolete
351 char type;
352public:
353 enum QMacMimeType { MIME_DND=0x01, MIME_CLIP=0x02, MIME_QT_CONVERTOR=0x04, MIME_ALL=MIME_DND|MIME_CLIP };
354 explicit QMacMime(char) { }
355 virtual ~QMacMime() { }
356
357 static void initialize() { }
358
359 static QList<QMacMime*> all(QMacMimeType) { return QList<QMacMime*>(); }
360 static QMacMime *convertor(QMacMimeType, const QString &, int) { return 0; }
361 static QString flavorToMime(QMacMimeType, int) { return QString(); }
362
363 virtual QString convertorName()=0;
364 virtual int countFlavors()=0;
365 virtual int flavor(int index)=0;
366 virtual bool canConvert(const QString &mime, int flav)=0;
367 virtual QString mimeFor(int flav)=0;
368 virtual int flavorFor(const QString &mime)=0;
369 virtual QVariant convertToMime(const QString &mime, QList<QByteArray> data, int flav)=0;
370 virtual QList<QByteArray> convertFromMime(const QString &mime, QVariant data, int flav)=0;
371};
372
373class Q_GUI_EXPORT QMacPasteboardMime {
374 char type;
375public:
376 enum QMacPasteboardMimeType { MIME_DND=0x01,
377 MIME_CLIP=0x02,
378 MIME_QT_CONVERTOR=0x04,
379 MIME_QT3_CONVERTOR=0x08,
380 MIME_ALL=MIME_DND|MIME_CLIP
381 };
382 explicit QMacPasteboardMime(char);
383 virtual ~QMacPasteboardMime();
384
385 static void initialize();
386
387 static QList<QMacPasteboardMime*> all(uchar);
388 static QMacPasteboardMime *convertor(uchar, const QString &mime, QString flav);
389 static QString flavorToMime(uchar, QString flav);
390
391 virtual QString convertorName() = 0;
392
393 virtual bool canConvert(const QString &mime, QString flav) = 0;
394 virtual QString mimeFor(QString flav) = 0;
395 virtual QString flavorFor(const QString &mime) = 0;
396 virtual QVariant convertToMime(const QString &mime, QList<QByteArray> data, QString flav) = 0;
397 virtual QList<QByteArray> convertFromMime(const QString &mime, QVariant data, QString flav) = 0;
398};
399
400// ### Qt 5: Add const QStringList& QMacPasteboardMime::supportedFlavours()
401Q_GUI_EXPORT void qRegisterDraggedTypes(const QStringList &types);
402#endif // Q_WS_MAC
403
404QT_END_NAMESPACE
405
406QT_END_HEADER
407
408#endif // QMIME_H
Note: See TracBrowser for help on using the repository browser.