1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
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 The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/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 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QPIXMAPCACHE_H
41 #define QPIXMAPCACHE_H
42 
43 #include <QtGui/qtguiglobal.h>
44 #include <QtGui/qpixmap.h>
45 
46 QT_BEGIN_NAMESPACE
47 
48 
49 class Q_GUI_EXPORT QPixmapCache
50 {
51 public:
52     class KeyData;
53     class Q_GUI_EXPORT Key
54     {
55     public:
56         Key();
57         Key(const Key &other);
Key(Key && other)58         Key(Key &&other) noexcept : d(other.d) { other.d = nullptr; }
59         Key &operator =(Key &&other) noexcept { swap(other); return *this; }
60         ~Key();
61         bool operator ==(const Key &key) const;
62         inline bool operator !=(const Key &key) const
63         { return !operator==(key); }
64         Key &operator =(const Key &other);
65 
swap(Key & other)66         void swap(Key &other) noexcept { qSwap(d, other.d); }
67         bool isValid() const noexcept;
68 
69     private:
70         KeyData *d;
71         friend class QPMCache;
72         friend class QPixmapCache;
73     };
74 
75     static int cacheLimit();
76     static void setCacheLimit(int);
77 #if QT_DEPRECATED_SINCE(5, 13)
78     QT_DEPRECATED_X("Use bool find(const QString &, QPixmap *) instead")
79     static QPixmap *find(const QString &key);
80     QT_DEPRECATED_X("Use bool find(const QString &, QPixmap *) instead")
81     static bool find(const QString &key, QPixmap &pixmap);
82 #endif
83     static bool find(const QString &key, QPixmap *pixmap);
84     static bool find(const Key &key, QPixmap *pixmap);
85     static bool insert(const QString &key, const QPixmap &pixmap);
86     static Key insert(const QPixmap &pixmap);
87     static bool replace(const Key &key, const QPixmap &pixmap);
88     static void remove(const QString &key);
89     static void remove(const Key &key);
90     static void clear();
91 
92 #ifdef Q_TEST_QPIXMAPCACHE
93     static void flushDetachedPixmaps();
94     static int totalUsed();
95 #endif
96 };
97 Q_DECLARE_SHARED_NOT_MOVABLE_UNTIL_QT6(QPixmapCache::Key)
98 
99 QT_END_NAMESPACE
100 
101 #endif // QPIXMAPCACHE_H
102