summaryrefslogtreecommitdiffstats
path: root/src/imports/mimetypes/qdeclarativemimedatabase.cpp
blob: 51ea78453f9241b3ad868c0773270dba9a5d277d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/****************************************************************************
**
** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtMimeTypes addon of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this
** file. Please review the following information to ensure the GNU Lesser
** General Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU General
** Public License version 3.0 as published by the Free Software Foundation
** and appearing in the file LICENSE.GPL included in the packaging of this
** file. Please review the following information to ensure the GNU General
** Public License version 3.0 requirements will be met:
** http://www.gnu.org/copyleft/gpl.html.
**
** Other Usage
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qdeclarativemimedatabase_p.h"   // Basis

#include "qdeclarativemimetype_p.h"

#include <QtCore/QDebug>

// ------------------------------------------------------------------------------------------------

extern bool isQMimeDatabaseDebuggingActivated;

#ifndef QT_NO_DEBUG_OUTPUT
#define DBG() if (isQMimeDatabaseDebuggingActivated) qDebug() << Q_FUNC_INFO
#else
#define DBG() if (0) qDebug() << Q_FUNC_INFO
#endif

// ------------------------------------------------------------------------------------------------

/*!
    \qmlclass MimeDatabase QDeclarativeMimeDatabase
    \brief The QML MimeDatabase element maintains a database of MIME types.
 */

// ------------------------------------------------------------------------------------------------

/*!
    \class QDeclarativeMimeDatabase
    \brief The QDeclarativeMimeDatabase class is the QML wrapper for the class QMimeDatabase which maintains a database of MIME types.
    \inherits QObject
 */

// ------------------------------------------------------------------------------------------------

/*!
    \fn QDeclarativeMimeDatabase::QDeclarativeMimeDatabase(QObject *theParent);
    \brief Performs default initialization of the contained MimeDatabase, and attaches the object to the specified \a theParent for destruction.
 */
QDeclarativeMimeDatabase::QDeclarativeMimeDatabase(QObject *theParent) :
        QObject(theParent),
        m_MimeDatabase()
{
    DBG() << "mimeTypeNames():" << mimeTypeNames();
}

// ------------------------------------------------------------------------------------------------

/*!
    \fn QDeclarativeMimeDatabase::~QDeclarativeMimeDatabase();
    \brief Destroys the the contained MimeDatabase.
 */
QDeclarativeMimeDatabase::~QDeclarativeMimeDatabase()
{
    DBG() << "mimeTypeNames():" << mimeTypeNames();
}

// ------------------------------------------------------------------------------------------------

/*!
    \fn QMimeDatabase &QDeclarativeMimeDatabase::mimeDatabase()
    \brief Returns the contained MimeDatabase.
 */
QMimeDatabase &QDeclarativeMimeDatabase::mimeDatabase()
{
    return m_MimeDatabase;
}

// ------------------------------------------------------------------------------------------------

/*!
    \qmlproperty QVariantList MimeDatabase::mimeTypeNames
    list of registered MIME types
 */

// ------------------------------------------------------------------------------------------------

QVariantList QDeclarativeMimeDatabase::mimeTypeNames() const
{
    QVariantList result;

    foreach (const QMimeType &mimeType, m_MimeDatabase.allMimeTypes()) {
        result << mimeType.name();
    }

    return result;
}

// ------------------------------------------------------------------------------------------------

/*!
    \qmlmethod MimeType MimeDatabase::mimeTypeForName(string nameOrAlias)
    \brief Returns a MIME type for \a nameOrAlias or an invalid one if none found.
 */

// ------------------------------------------------------------------------------------------------

/*!
    \property QDeclarativeMimeDatabase::mimeTypeNames
    \brief the list of registered MIME types
 */

// ------------------------------------------------------------------------------------------------

QDeclarativeMimeType *QDeclarativeMimeDatabase::mimeTypeForName (
                                                    const QString &nameOrAlias
                                                )
{
    return new QDeclarativeMimeType (
                   m_MimeDatabase.mimeTypeForName(nameOrAlias),
                   this   // <- The new object will be released later
                          //    when this registry is released.
               );
}

// ------------------------------------------------------------------------------------------------

/*!
    \qmlmethod MimeType MimeDatabase::findByFileName(string fileName)
    \brief Returns a MIME type for the file \a fileName.

    A valid MIME type is always returned. If the file name doesn't match any
    known pattern, the default MIME type (application/octet-stream)
    is returned.

    This function does not try to open the file. To also use the content
    when determining the MIME type, use findByFile().
*/
QDeclarativeMimeType *QDeclarativeMimeDatabase::findByFileName (
                                                    const QString &fileName
                                                )
{
    return new QDeclarativeMimeType (
                   m_MimeDatabase.findByFileName(fileName),
                   this   // <- The new object will be released later
                          //    when this registry is released.
               );
}

// ------------------------------------------------------------------------------------------------

/*!
    \qmlmethod MimeType MimeDatabase::findByFile(string fileName)
    \brief Returns a MIME type for \a fileName.

    This method looks at both the file name and the file contents,
    if necessary. The file extension has priority over the contents,
    but the contents will be used if the file extension is unknown, or
    matches multiple MIME types.

    A valid MIME type is always returned. If the file doesn't match any
    known pattern or data, the default MIME type (application/octet-stream)
    is returned.

    The \a fileName can also include an absolute or relative path.
*/
QDeclarativeMimeType *QDeclarativeMimeDatabase::findByFile (
                                                    const QString &fileName
                                                )
{
    return new QDeclarativeMimeType (
                   m_MimeDatabase.findByFile(fileName),
                   this   // <- The new object will be released later
                          //    when this registry is released.
               );
}

// ------------------------------------------------------------------------------------------------

#undef DBG