|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the QtDeclarative module of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 #include "qdeclarativeimageprovider.h" |
|
43 |
|
44 QT_BEGIN_NAMESPACE |
|
45 |
|
46 /*! |
|
47 \class QDeclarativeImageProvider |
|
48 \since 4.7 |
|
49 \brief The QDeclarativeImageProvider class provides an interface for threaded image requests in QML. |
|
50 |
|
51 QDeclarativeImageProvider can be used by a QDeclarativeEngine to provide images to QML asynchronously. |
|
52 The image request will be run in a low priority thread, allowing potentially costly image |
|
53 loading to be done in the background, without affecting the performance of the UI. |
|
54 |
|
55 See the QDeclarativeEngine::addImageProvider() documentation for an |
|
56 example of how a custom QDeclarativeImageProvider can be constructed and used. |
|
57 |
|
58 \note the request() method may be called by multiple threads, so ensure the |
|
59 implementation of this method is reentrant. |
|
60 |
|
61 \sa QDeclarativeEngine::addImageProvider() |
|
62 */ |
|
63 |
|
64 /*! |
|
65 Destroys the image provider. |
|
66 */ |
|
67 QDeclarativeImageProvider::~QDeclarativeImageProvider() |
|
68 { |
|
69 } |
|
70 |
|
71 /*! |
|
72 \fn QImage QDeclarativeImageProvider::request(const QString &id, QSize *size, const QSize& requestedSize) |
|
73 |
|
74 Implement this method to return the image with \a id. |
|
75 |
|
76 If \a requestedSize is a valid size, the image returned should be of that size. |
|
77 |
|
78 In all cases, \a size must be set to the original size of the image. |
|
79 |
|
80 \note this method may be called by multiple threads, so ensure the |
|
81 implementation of this method is reentrant. |
|
82 */ |
|
83 |
|
84 QT_END_NAMESPACE |