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

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

gui: DnD: QPMAnyMime: Added fallback support for any mime type not supported by dedicated converters.
File size: 13.4 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(QString &type, QString &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 // DragWorker 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(QString &type, QString &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, QString &type, QString &ext) {};
191 };
192
193 bool addProvider(const QByteArray &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,
219 QVariant::Type preferredType) const = 0;
220
221 private:
222 DRAGINFO *nfo;
223 friend class QPMDragData;
224 };
225
226 class DefaultDropWorker : public DropWorker, public QPMObjectWindow
227 {
228 private:
229 DefaultDropWorker();
230 public:
231 virtual ~DefaultDropWorker();
232
233 // DropWorker interface
234 void cleanup(bool isAccepted);
235 bool isExclusive() const;
236 bool hasFormat(const QString &mimeType) const;
237 QStringList formats() const;
238 QVariant retrieveData(const QString &mimeType,
239 QVariant::Type preferredType) const;
240
241 // QPMObjectWindow interface
242 MRESULT message(ULONG msg, MPARAM mp1, MPARAM mp2);
243
244 class Provider
245 {
246 public:
247 virtual QByteArray drf(const QString &mimeType) const = 0;
248 virtual bool provide(const QString &mimeType, ULONG itemIndex,
249 const QByteArray &itemData,
250 QByteArray &allData) = 0;
251 };
252
253 bool addProvider(const QString &mimeType, Provider *provider);
254 bool addExclusiveProvider(const QString &mimeType, Provider *provider);
255
256 static bool canRender(DRAGITEM *item, const char *drf);
257 static bool getSupportedRMFs(DRAGITEM *item, QList<QByteArrayList> &list);
258
259 private:
260 struct Data;
261 Data *d;
262 friend class QPMMime;
263 };
264
265#endif // !QT_NO_DRAGANDDROP
266
267 QPMMime();
268 virtual ~QPMMime();
269
270 struct MimeCFPair
271 {
272 MimeCFPair(const QString &m, ULONG f) : mime(m), format(f) {}
273 QString mime;
274 ULONG format;
275 };
276
277 // for converting from Qt
278 virtual QList<MimeCFPair> formatsForMimeData(const QMimeData *mimeData) const = 0;
279 virtual bool convertFromMimeData(const QMimeData *mimeData, ULONG format,
280 ULONG &flags, ULONG *data) const = 0;
281 // for converting to Qt
282 virtual QList<MimeCFPair> mimesForFormats(const QList<ULONG> &formats) const = 0;
283 virtual QVariant convertFromFormat(ULONG format, ULONG flags, ULONG data,
284 const QString &mimeType,
285 QVariant::Type preferredType) const = 0;
286
287#if !defined(QT_NO_DRAGANDDROP)
288 // Direct Manipulation (DND) converter interface
289 virtual DragWorker *dragWorkerFor(const QString &mimeType,
290 QMimeData *mimeData) { return 0; }
291 virtual DropWorker *dropWorkerFor(DRAGINFO *info) { return 0; }
292#endif // !QT_NO_DRAGANDDROP
293
294protected:
295
296 static ULONG registerMimeType(const QString &mime);
297 static void unregisterMimeType(ULONG mimeId);
298
299 static QList<QPMMime*> all();
300
301 static ULONG allocateMemory(size_t size);
302 static void freeMemory(ULONG addr);
303
304 static QString formatName(ULONG format);
305
306#if !defined(QT_NO_DRAGANDDROP)
307 static QByteArray queryHSTR(HSTR hstr);
308 static QByteArray querySourceNameFull(DRAGITEM *item);
309 static bool canTargetRenderAsOS2File(DRAGITEM *item, QByteArray *fullName = 0);
310 static bool parseRMFs(HSTR rmfs, QList<QByteArrayList> &list);
311 static bool parseRMF(HSTR rmf, QByteArray &mechanism, QByteArray &format);
312
313 static DefaultDragWorker *defaultCoopDragWorker();
314 static DefaultDragWorker *defaultExclDragWorker();
315 static DefaultDropWorker *defaultDropWorker();
316#endif // !QT_NO_DRAGANDDROP
317
318private:
319 friend class QClipboardWatcher;
320 friend class QClipboardData;
321 friend class QClipboard;
322 friend class QPMDragData;
323 friend class QPMCoopDragWorker;
324
325 struct Match
326 {
327 Match(QPMMime *c, const QString f, ULONG cf, int p) :
328 converter(c), mime(f), format(cf), priority(p) {}
329
330 QPMMime *converter;
331 QString mime;
332 ULONG format;
333 int priority;
334 };
335
336 static QList<Match> allConvertersFromFormats(const QList<ULONG> &formats);
337 static QList<Match> allConvertersFromMimeData(const QMimeData *mimeData);
338};
339
340#endif
341#if defined(Q_WS_MAC)
342
343/*
344 Encapsulation of conversion between MIME and Mac flavor.
345 Not needed on X11, as the underlying protocol uses the MIME standard
346 directly.
347*/
348
349class Q_GUI_EXPORT QMacMime { //Obsolete
350 char type;
351public:
352 enum QMacMimeType { MIME_DND=0x01, MIME_CLIP=0x02, MIME_QT_CONVERTOR=0x04, MIME_ALL=MIME_DND|MIME_CLIP };
353 explicit QMacMime(char) { }
354 virtual ~QMacMime() { }
355
356 static void initialize() { }
357
358 static QList<QMacMime*> all(QMacMimeType) { return QList<QMacMime*>(); }
359 static QMacMime *convertor(QMacMimeType, const QString &, int) { return 0; }
360 static QString flavorToMime(QMacMimeType, int) { return QString(); }
361
362 virtual QString convertorName()=0;
363 virtual int countFlavors()=0;
364 virtual int flavor(int index)=0;
365 virtual bool canConvert(const QString &mime, int flav)=0;
366 virtual QString mimeFor(int flav)=0;
367 virtual int flavorFor(const QString &mime)=0;
368 virtual QVariant convertToMime(const QString &mime, QList<QByteArray> data, int flav)=0;
369 virtual QList<QByteArray> convertFromMime(const QString &mime, QVariant data, int flav)=0;
370};
371
372class Q_GUI_EXPORT QMacPasteboardMime {
373 char type;
374public:
375 enum QMacPasteboardMimeType { MIME_DND=0x01,
376 MIME_CLIP=0x02,
377 MIME_QT_CONVERTOR=0x04,
378 MIME_QT3_CONVERTOR=0x08,
379 MIME_ALL=MIME_DND|MIME_CLIP
380 };
381 explicit QMacPasteboardMime(char);
382 virtual ~QMacPasteboardMime();
383
384 static void initialize();
385
386 static QList<QMacPasteboardMime*> all(uchar);
387 static QMacPasteboardMime *convertor(uchar, const QString &mime, QString flav);
388 static QString flavorToMime(uchar, QString flav);
389
390 virtual QString convertorName() = 0;
391
392 virtual bool canConvert(const QString &mime, QString flav) = 0;
393 virtual QString mimeFor(QString flav) = 0;
394 virtual QString flavorFor(const QString &mime) = 0;
395 virtual QVariant convertToMime(const QString &mime, QList<QByteArray> data, QString flav) = 0;
396 virtual QList<QByteArray> convertFromMime(const QString &mime, QVariant data, QString flav) = 0;
397};
398
399// ### Qt 5: Add const QStringList& QMacPasteboardMime::supportedFlavours()
400Q_GUI_EXPORT void qRegisterDraggedTypes(const QStringList &types);
401#endif // Q_WS_MAC
402
403QT_END_NAMESPACE
404
405QT_END_HEADER
406
407#endif // QMIME_H
Note: See TracBrowser for help on using the repository browser.