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

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

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