Qt 4.8
qmime.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
5 **
6 ** This file is part of the QtGui module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QMIME_H
43 #define QMIME_H
44 
45 #include <QtCore/qmimedata.h>
46 
47 QT_BEGIN_HEADER
48 
49 QT_BEGIN_NAMESPACE
50 
51 QT_MODULE(Gui)
52 
53 class Q_GUI_EXPORT QMimeSource
54 {
55 public:
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 
65 QT_BEGIN_INCLUDE_NAMESPACE
66 typedef struct tagFORMATETC FORMATETC;
67 typedef struct tagSTGMEDIUM STGMEDIUM;
68 struct IDataObject;
69 
70 #include <QtCore/qvariant.h>
71 QT_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 
79 class Q_GUI_EXPORT QWindowsMime
80 {
81 public:
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 
97 private:
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_MAC)
111 
112 /*
113  Encapsulation of conversion between MIME and Mac flavor.
114  Not needed on X11, as the underlying protocol uses the MIME standard
115  directly.
116 */
117 
118 class Q_GUI_EXPORT QMacMime { //Obsolete
119  char type;
120 public:
121  enum QMacMimeType { MIME_DND=0x01, MIME_CLIP=0x02, MIME_QT_CONVERTOR=0x04, MIME_ALL=MIME_DND|MIME_CLIP };
122  explicit QMacMime(char) { Q_UNUSED(type); }
123  virtual ~QMacMime() { }
124 
125  static void initialize() { }
126 
127  static QList<QMacMime*> all(QMacMimeType) { return QList<QMacMime*>(); }
128  static QMacMime *convertor(QMacMimeType, const QString &, int) { return 0; }
129  static QString flavorToMime(QMacMimeType, int) { return QString(); }
130 
131  virtual QString convertorName()=0;
132  virtual int countFlavors()=0;
133  virtual int flavor(int index)=0;
134  virtual bool canConvert(const QString &mime, int flav)=0;
135  virtual QString mimeFor(int flav)=0;
136  virtual int flavorFor(const QString &mime)=0;
137  virtual QVariant convertToMime(const QString &mime, QList<QByteArray> data, int flav)=0;
138  virtual QList<QByteArray> convertFromMime(const QString &mime, QVariant data, int flav)=0;
139 };
140 
141 class Q_GUI_EXPORT QMacPasteboardMime {
142  char type;
143 public:
144  enum QMacPasteboardMimeType { MIME_DND=0x01,
145  MIME_CLIP=0x02,
146  MIME_QT_CONVERTOR=0x04,
147  MIME_QT3_CONVERTOR=0x08,
148  MIME_ALL=MIME_DND|MIME_CLIP
149  };
150  explicit QMacPasteboardMime(char);
151  virtual ~QMacPasteboardMime();
152 
153  static void initialize();
154 
155  static QList<QMacPasteboardMime*> all(uchar);
156  static QMacPasteboardMime *convertor(uchar, const QString &mime, QString flav);
157  static QString flavorToMime(uchar, QString flav);
158 
159  virtual QString convertorName() = 0;
160 
161  virtual bool canConvert(const QString &mime, QString flav) = 0;
162  virtual QString mimeFor(QString flav) = 0;
163  virtual QString flavorFor(const QString &mime) = 0;
164  virtual QVariant convertToMime(const QString &mime, QList<QByteArray> data, QString flav) = 0;
165  virtual QList<QByteArray> convertFromMime(const QString &mime, QVariant data, QString flav) = 0;
166 };
167 
168 // ### Qt 5: Add const QStringList& QMacPasteboardMime::supportedFlavours()
169 Q_GUI_EXPORT void qRegisterDraggedTypes(const QStringList &types);
170 #endif // Q_WS_MAC
171 
172 QT_END_NAMESPACE
173 
174 QT_END_HEADER
175 
176 #endif // QMIME_H
QVariant
The QVariant class acts like a union for the most common Qt data types.
Definition: qvariant.h:92
QWindowsMime
The QWindowsMime class maps open-standard MIME to Window Clipboard formats.
Definition: qmime.h:79
QT_END_NAMESPACE
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
QT_MODULE
#define QT_MODULE(x)
Definition: qglobal.h:2783
QT_BEGIN_HEADER
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
qRegisterDraggedTypes
Q_GUI_EXPORT void qRegisterDraggedTypes(const QStringList &types)
Definition: qmime_mac.cpp:109
Q_GUI_EXPORT
#define Q_GUI_EXPORT
Definition: qglobal.h:1450
QByteArray
The QByteArray class provides an array of bytes.
Definition: qbytearray.h:135
mime
const char * mime
Definition: qsimplecodec.cpp:52
QT_END_INCLUDE_NAMESPACE
#define QT_END_INCLUDE_NAMESPACE
This macro is equivalent to QT_BEGIN_NAMESPACE.
Definition: qglobal.h:92
FORMATETC
struct tagFORMATETC FORMATETC
Definition: qmime.h:66
QString
The QString class provides a Unicode character string.
Definition: qstring.h:83
QVector
The QVector class is a template class that provides a dynamic array.
Definition: qdatastream.h:64
QMimeSource
The QMimeSource class is an abstraction of objects that provided formatted data of a certain MIME typ...
Definition: qmime.h:53
QMacMime::flavorToMime
static QString flavorToMime(QMacMimeType, int)
Definition: qmime.h:129
uchar
unsigned char uchar
Definition: qglobal.h:994
QT_BEGIN_NAMESPACE
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
QMacMime::all
static QList< QMacMime * > all(QMacMimeType)
Definition: qmime.h:127
QStringList
The QStringList class provides a list of strings.
Definition: qstringlist.h:66
data
static const char * data(const QByteArray &arr)
Definition: qdbusmessage.cpp:60
QMacMime::initialize
static void initialize()
Definition: qmime.h:125
QVariant::Type
Type
This enum type defines the types of variable that a QVariant can contain.
Definition: qvariant.h:95
STGMEDIUM
struct tagSTGMEDIUM STGMEDIUM
Definition: qmime.h:67
QMimeData
The QMimeData class provides a container for data that records information about its MIME type...
Definition: qmimedata.h:57
QMacMime::convertor
static QMacMime * convertor(QMacMimeType, const QString &, int)
Definition: qmime.h:128
QMacMime::QMacMime
QMacMime(char)
Definition: qmime.h:122
format
format
Definition: qprintengine_ps.cpp:286
types
static const struct @32 types[]
QMacMime::type
char type
Definition: qmime.h:119
all
bool all
Definition: qcocoasharedwindowmethods_mac_p.h:227
index
quint16 index
Definition: qfontsubset.cpp:116
QT_BEGIN_INCLUDE_NAMESPACE
#define QT_BEGIN_INCLUDE_NAMESPACE
This macro is equivalent to QT_END_NAMESPACE.
Definition: qglobal.h:91
class
#define class
Definition: qapplication_x11.cpp:92
QT_END_HEADER
#define QT_END_HEADER
Definition: qglobal.h:137
Q_UNUSED
#define Q_UNUSED(x)
Indicates to the compiler that the parameter with the specified name is not used in the body of a fun...
Definition: qglobal.h:1729
QMacPasteboardMime
The QMacPasteboardMime class converts between a MIME type and a.
Definition: qmime.h:141
QMacMime::~QMacMime
virtual ~QMacMime()
Definition: qmime.h:123
QList
The QList class is a template class that provides lists.
Definition: qdatastream.h:62
QMacMime::QMacMimeType
QMacMimeType
Definition: qmime.h:121
Qt 4.8 Source Code Browser