1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies). |
4 | ** Contact: http://www.qt-project.org/legal |
5 | ** |
6 | ** This file is part of the QtDocGallery 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 QGALLERYRESULTSET_H |
43 | #define QGALLERYRESULTSET_H |
44 | |
45 | #include <qgalleryabstractresponse.h> |
46 | #include <qgalleryproperty.h> |
47 | |
48 | #include <QtCore/qmap.h> |
49 | #include <QtCore/qobject.h> |
50 | #include <QtCore/qurl.h> |
51 | #include <QtCore/qvariant.h> |
52 | |
53 | QT_BEGIN_NAMESPACE_DOCGALLERY |
54 | |
55 | class QGalleryResource; |
56 | |
57 | class QGalleryResultSetPrivate; |
58 | |
59 | class Q_GALLERY_EXPORT QGalleryResultSet : public QGalleryAbstractResponse |
60 | { |
61 | Q_OBJECT |
62 | Q_DECLARE_PRIVATE(QGalleryResultSet) |
63 | public: |
64 | QGalleryResultSet(QObject *parent = Q_NULLPTR); |
65 | ~QGalleryResultSet(); |
66 | |
67 | virtual int propertyKey(const QString &property) const = 0; |
68 | virtual QGalleryProperty::Attributes propertyAttributes(int key) const = 0; |
69 | virtual QVariant::Type propertyType(int key) const = 0; |
70 | |
71 | virtual int itemCount() const = 0; |
72 | |
73 | virtual bool isValid() const; |
74 | |
75 | virtual QVariant itemId() const = 0; |
76 | virtual QUrl itemUrl() const = 0; |
77 | virtual QString itemType() const = 0; |
78 | virtual QList<QGalleryResource> resources() const; |
79 | |
80 | virtual QVariant metaData(int key) const = 0; |
81 | virtual bool setMetaData(int key, const QVariant &value) = 0; |
82 | |
83 | virtual int currentIndex() const = 0; |
84 | virtual bool fetch(int index) = 0; |
85 | virtual bool fetchNext(); |
86 | virtual bool fetchPrevious(); |
87 | virtual bool fetchFirst(); |
88 | virtual bool fetchLast(); |
89 | |
90 | Q_SIGNALS: |
91 | void currentItemChanged(); |
92 | void currentIndexChanged(int index); |
93 | void itemsInserted(int index, int count); |
94 | void itemsRemoved(int index, int count); |
95 | void itemsMoved(int from, int to, int count); |
96 | |
97 | void metaDataChanged(int index, int count, const QList<int> &keys); |
98 | |
99 | protected: |
100 | QGalleryResultSet(QGalleryResultSetPrivate &dd, QObject *parent); |
101 | }; |
102 | |
103 | QT_END_NAMESPACE_DOCGALLERY |
104 | |
105 | #endif |
106 | |