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 | #include "qabstractgallery.h" |
43 | #include "qabstractgallery_p.h" |
44 | |
45 | QT_BEGIN_NAMESPACE_DOCGALLERY |
46 | |
47 | /*! |
48 | \class QAbstractGallery |
49 | |
50 | \ingroup gallery |
51 | \ingroup gallery-galleries |
52 | |
53 | \inmodule QtDocGallery |
54 | |
55 | \brief The QAbstractGallery class provides a base class for gallery |
56 | implementations. |
57 | |
58 | Classes implementing the QAbstractGallery interface allow |
59 | QGalleryAbstractRequest implementations to connect to a gallery and |
60 | execute a query or perform an action. |
61 | |
62 | The types of request that can be executed by a gallery are defined in |
63 | QGalleryAbstractRequest::RequestType. If a gallery supports a request the |
64 | isRequestSupportedFunction() will return true when given the type of the |
65 | request, and false if it is not supported. |
66 | |
67 | When a QGalleryAbstractRequest is executed it will call createResponse() on |
68 | its gallery and pass a pointer to itself. The gallery will then use the |
69 | \l {QGalleryAbstractRequest::type()}{type} property of the request to |
70 | determine its type and cast to the correct class. Using the properties of |
71 | the request a gallery can then create a QGalleryAbstractResponse which |
72 | executes the requested task and returns any results. Some requests will |
73 | require the response to implement additional interfaces such as |
74 | QGalleryResultSet to access the data produced in the response. |
75 | |
76 | \sa QGalleryAbstractRequest |
77 | */ |
78 | |
79 | /*! |
80 | Constructs a new gallery. |
81 | |
82 | The \a parent is passed to QObject. |
83 | */ |
84 | |
85 | QAbstractGallery::QAbstractGallery(QObject *parent ) |
86 | : QObject(parent) |
87 | , d_ptr(0) |
88 | { |
89 | |
90 | } |
91 | |
92 | /*! |
93 | \internal |
94 | */ |
95 | |
96 | QAbstractGallery::QAbstractGallery(QAbstractGalleryPrivate &dd, QObject *parent) |
97 | : QObject(parent) |
98 | , d_ptr(&dd) |
99 | { |
100 | d_ptr->q_ptr = this; |
101 | } |
102 | |
103 | /*! |
104 | Destroys a gallery. |
105 | */ |
106 | |
107 | QAbstractGallery::~QAbstractGallery() |
108 | { |
109 | } |
110 | |
111 | /*! |
112 | \fn QAbstractGallery::isRequestSupported(QGalleryAbstractRequest::RequestType type) const |
113 | |
114 | Identifies if a gallery supports a request \a type. |
115 | |
116 | Returns true if the request is supported, and false otherwise. |
117 | */ |
118 | |
119 | /*! |
120 | \fn QAbstractGallery::createResponse(QGalleryAbstractRequest *request) |
121 | |
122 | Creates a response to a gallery \a request. |
123 | */ |
124 | |
125 | #include "moc_qabstractgallery.cpp" |
126 | |
127 | QT_END_NAMESPACE_DOCGALLERY |
128 | |