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

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

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