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

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

trunk: Merged in qt 4.6.2 sources.
File size: 13.2 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4** All rights reserved.
5** Contact: Nokia Corporation (qt-info@nokia.com)
6**
7** This file is part of the QtGui module of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial Usage
11** Licensees holding valid Qt Commercial licenses may use this file in
12** accordance with the Qt Commercial License Agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and Nokia.
15**
16** GNU Lesser General Public License Usage
17** Alternatively, this file may be used under the terms of the GNU Lesser
18** General Public License version 2.1 as published by the Free Software
19** Foundation and appearing in the file LICENSE.LGPL included in the
20** packaging of this file. Please review the following information to
21** ensure the GNU Lesser General Public License version 2.1 requirements
22** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
23**
24** In addition, as a special exception, Nokia gives you certain additional
25** rights. These rights are described in the Nokia Qt LGPL Exception
26** version 1.1, included in the file LGPL_EXCEPTION.txt in this 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 have questions regarding the use of this file, please contact
37** Nokia at qt-info@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_BEGIN_INCLUDE_NAMESPACE
118
119#include "qwindowdefs_pm.h"
120typedef LHANDLE HSTR;
121typedef struct _DRAGINFO DRAGINFO;
122typedef struct _DRAGITEM DRAGITEM;
123
124QT_END_INCLUDE_NAMESPACE
125
126class QPMDragData;
127class QPMCoopDragWorker;
128
129class Q_GUI_EXPORT QPMMime
130{
131public:
132
133#if !defined(QT_NO_DRAGANDDROP)
134
135 typedef QList<QByteArray> QByteArrayList;
136
137 class DragWorker
138 {
139 public:
140 DragWorker() : src(0) {}
141 virtual ~DragWorker() {}
142
143 const QMimeData *source() const { return src; }
144
145 virtual void init() {}
146 // methods always implemented
147 virtual bool cleanup(bool isCancelled) = 0;
148 virtual bool isExclusive() const = 0;
149 virtual ULONG itemCount() const = 0;
150 virtual HWND hwnd() const = 0;
151 // methods implemented if isExclusive() == TRUE and itemCount() == 0
152 virtual DRAGINFO *createDragInfo(const QString &targetName, USHORT supportedOps)
153 { return 0; }
154 // methods implemented if itemCount() >= 0
155 virtual QByteArray composeFormatString() { return QByteArray(); }
156 virtual bool prepare(const char *drm, const char *drf, DRAGITEM *item,
157 ULONG itemIndex) { return false; }
158 virtual void defaultFileType(QString &type, QString &ext) {};
159
160 private:
161 const QMimeData *src;
162 friend class QPMCoopDragWorker;
163 friend class QDragManager;
164 };
165
166 class DefaultDragWorker : public DragWorker
167 {
168 private:
169 DefaultDragWorker(bool exclusive);
170 public:
171 virtual ~DefaultDragWorker();
172
173 // DragWorker interface
174 bool cleanup(bool isCancelled);
175 bool isExclusive() const;
176 ULONG itemCount() const;
177 HWND hwnd() const;
178 QByteArray composeFormatString();
179 bool prepare(const char *drm, const char *drf, DRAGITEM *item,
180 ULONG itemIndex);
181 void defaultFileType(QString &type, QString &ext);
182
183 class Provider
184 {
185 public:
186 virtual 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, QString &type, QString &ext) {};
190 };
191
192 bool addProvider(const QByteArray &drf, Provider *provider,
193 ULONG itemCount = 1);
194
195 static bool canRender(const char *drm);
196
197 private:
198 struct Data;
199 Data *d;
200 friend class QPMMime;
201 };
202
203 class DropWorker
204 {
205 public:
206 DropWorker() : nfo(0) {}
207 virtual ~DropWorker() {}
208
209 DRAGINFO *info() const { return nfo; }
210
211 virtual void init() {}
212 virtual void cleanup(bool isAccepted) {}
213 virtual bool isExclusive() const = 0;
214
215 virtual bool hasFormat(const QString &mimeType) const = 0;
216 virtual QStringList formats() const = 0;
217 virtual QVariant retrieveData(const QString &mimeType,
218 QVariant::Type preferredType) const = 0;
219
220 private:
221 DRAGINFO *nfo;
222 friend class QPMDragData;
223 };
224
225 class DefaultDropWorker : public DropWorker
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,
238 QVariant::Type preferredType) const;
239
240 class Provider
241 {
242 public:
243 virtual QByteArray drf(const QString &mimeType) const = 0;
244 virtual bool provide(const QString &mimeType, ULONG itemIndex,
245 const QByteArray &itemData,
246 QByteArray &allData) = 0;
247 };
248
249 bool addProvider(const QString &mimeType, Provider *provider);
250 bool addExclusiveProvider(const QString &mimeType, Provider *provider);
251
252 static bool canRender(DRAGITEM *item, const char *drf);
253 static bool getSupportedRMFs(DRAGITEM *item, QList<QByteArrayList> &list);
254
255 private:
256 struct Data;
257 Data *d;
258 friend class QPMMime;
259 };
260
261#endif // !QT_NO_DRAGANDDROP
262
263 QPMMime();
264 virtual ~QPMMime();
265
266 struct MimeCFPair
267 {
268 MimeCFPair(const QString &m, ULONG f) : mime(m), format(f) {}
269 QString mime;
270 ULONG format;
271 };
272
273 // for converting from Qt
274 virtual QList<MimeCFPair> formatsForMimeData(const QMimeData *mimeData) const = 0;
275 virtual bool convertFromMimeData(const QMimeData *mimeData, ULONG format,
276 ULONG &flags, ULONG *data) const = 0;
277 // for converting to Qt
278 virtual QList<MimeCFPair> mimesForFormats(const QList<ULONG> &formats) const = 0;
279 virtual QVariant convertFromFormat(ULONG format, ULONG flags, ULONG data,
280 const QString &mimeType,
281 QVariant::Type preferredType) const = 0;
282
283#if !defined(QT_NO_DRAGANDDROP)
284 // Direct Manipulation (DND) converter interface
285 virtual DragWorker *dragWorkerFor(const QString &mimeType,
286 QMimeData *mimeData) { return 0; }
287 virtual DropWorker *dropWorkerFor(DRAGINFO *info) { return 0; }
288#endif // !QT_NO_DRAGANDDROP
289
290protected:
291
292 static ULONG registerMimeType(const QString &mime);
293 static void unregisterMimeType(ULONG mimeId);
294
295 static QList<QPMMime*> all();
296
297 static ULONG allocateMemory(size_t size);
298 static void freeMemory(ULONG addr);
299
300 static QString formatName(ULONG format);
301
302#if !defined(QT_NO_DRAGANDDROP)
303 static QByteArray queryHSTR(HSTR hstr);
304 static QByteArray querySourceNameFull(DRAGITEM *item);
305 static bool canTargetRenderAsOS2File(DRAGITEM *item, QByteArray *fullName = 0);
306 static bool parseRMFs(HSTR rmfs, QList<QByteArrayList> &list);
307 static bool parseRMF(HSTR rmf, QByteArray &mechanism, QByteArray &format);
308
309 static DefaultDragWorker *defaultCoopDragWorker();
310 static DefaultDragWorker *defaultExclDragWorker();
311 static DefaultDropWorker *defaultDropWorker();
312#endif // !QT_NO_DRAGANDDROP
313
314private:
315 friend class QClipboardWatcher;
316 friend class QClipboardData;
317 friend class QClipboard;
318 friend class QPMDragData;
319 friend class QPMCoopDragWorker;
320
321 struct Match
322 {
323 Match(QPMMime *c, const QString f, ULONG cf, int p) :
324 converter(c), mime(f), format(cf), priority(p) {}
325
326 QPMMime *converter;
327 QString mime;
328 ULONG format;
329 int priority;
330 };
331
332 static QList<Match> allConvertersFromFormats(const QList<ULONG> &formats);
333 static QList<Match> allConvertersFromMimeData(const QMimeData *mimeData);
334};
335
336#endif
337#if defined(Q_WS_MAC)
338
339/*
340 Encapsulation of conversion between MIME and Mac flavor.
341 Not needed on X11, as the underlying protocol uses the MIME standard
342 directly.
343*/
344
345class Q_GUI_EXPORT QMacMime { //Obsolete
346 char type;
347public:
348 enum QMacMimeType { MIME_DND=0x01, MIME_CLIP=0x02, MIME_QT_CONVERTOR=0x04, MIME_ALL=MIME_DND|MIME_CLIP };
349 explicit QMacMime(char) { }
350 virtual ~QMacMime() { }
351
352 static void initialize() { }
353
354 static QList<QMacMime*> all(QMacMimeType) { return QList<QMacMime*>(); }
355 static QMacMime *convertor(QMacMimeType, const QString &, int) { return 0; }
356 static QString flavorToMime(QMacMimeType, int) { return QString(); }
357
358 virtual QString convertorName()=0;
359 virtual int countFlavors()=0;
360 virtual int flavor(int index)=0;
361 virtual bool canConvert(const QString &mime, int flav)=0;
362 virtual QString mimeFor(int flav)=0;
363 virtual int flavorFor(const QString &mime)=0;
364 virtual QVariant convertToMime(const QString &mime, QList<QByteArray> data, int flav)=0;
365 virtual QList<QByteArray> convertFromMime(const QString &mime, QVariant data, int flav)=0;
366};
367
368class Q_GUI_EXPORT QMacPasteboardMime {
369 char type;
370public:
371 enum QMacPasteboardMimeType { MIME_DND=0x01,
372 MIME_CLIP=0x02,
373 MIME_QT_CONVERTOR=0x04,
374 MIME_QT3_CONVERTOR=0x08,
375 MIME_ALL=MIME_DND|MIME_CLIP
376 };
377 explicit QMacPasteboardMime(char);
378 virtual ~QMacPasteboardMime();
379
380 static void initialize();
381
382 static QList<QMacPasteboardMime*> all(uchar);
383 static QMacPasteboardMime *convertor(uchar, const QString &mime, QString flav);
384 static QString flavorToMime(uchar, QString flav);
385
386 virtual QString convertorName() = 0;
387
388 virtual bool canConvert(const QString &mime, QString flav) = 0;
389 virtual QString mimeFor(QString flav) = 0;
390 virtual QString flavorFor(const QString &mime) = 0;
391 virtual QVariant convertToMime(const QString &mime, QList<QByteArray> data, QString flav) = 0;
392 virtual QList<QByteArray> convertFromMime(const QString &mime, QVariant data, QString flav) = 0;
393};
394
395// ### Qt 5: Add const QStringList& QMacPasteboardMime::supportedFlavours()
396Q_GUI_EXPORT void qRegisterDraggedTypes(const QStringList &types);
397#endif // Q_WS_MAC
398
399QT_END_NAMESPACE
400
401QT_END_HEADER
402
403#endif // QMIME_H
Note: See TracBrowser for help on using the repository browser.