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 QICONENGINE_H
41#define QICONENGINE_H
42
43#include <QtGui/qtguiglobal.h>
44#include <QtCore/qlist.h>
45#include <QtGui/qicon.h>
46
47QT_BEGIN_NAMESPACE
48
49
50class Q_GUI_EXPORT QIconEngine
51{
52public:
53 QIconEngine();
54 QIconEngine(const QIconEngine &other); // ### Qt6: make protected
55 virtual ~QIconEngine();
56 virtual void paint(QPainter *painter, const QRect &rect, QIcon::Mode mode, QIcon::State state) = 0;
57 virtual QSize actualSize(const QSize &size, QIcon::Mode mode, QIcon::State state);
58 virtual QPixmap pixmap(const QSize &size, QIcon::Mode mode, QIcon::State state);
59
60 virtual void addPixmap(const QPixmap &pixmap, QIcon::Mode mode, QIcon::State state);
61 virtual void addFile(const QString &fileName, const QSize &size, QIcon::Mode mode, QIcon::State state);
62
63 virtual QString key() const;
64 virtual QIconEngine *clone() const = 0;
65 virtual bool read(QDataStream &in);
66 virtual bool write(QDataStream &out) const;
67
68 enum IconEngineHook { AvailableSizesHook = 1, IconNameHook, IsNullHook, ScaledPixmapHook };
69
70 struct AvailableSizesArgument
71 {
72 QIcon::Mode mode;
73 QIcon::State state;
74 QList<QSize> sizes;
75 };
76
77 virtual QList<QSize> availableSizes(QIcon::Mode mode = QIcon::Normal,
78 QIcon::State state = QIcon::Off) const;
79
80 virtual QString iconName() const;
81 bool isNull() const; // ### Qt6 make virtual
82 QPixmap scaledPixmap(const QSize &size, QIcon::Mode mode, QIcon::State state, qreal scale); // ### Qt6 make virtual
83
84 struct ScaledPixmapArgument
85 {
86 QSize size;
87 QIcon::Mode mode;
88 QIcon::State state;
89 qreal scale;
90 QPixmap pixmap;
91 };
92
93 // ### Qt6: move content to proper virtual functions
94 virtual void virtual_hook(int id, void *data);
95
96private:
97 QIconEngine &operator=(const QIconEngine &other) Q_DECL_EQ_DELETE;
98};
99
100#if QT_DEPRECATED_SINCE(5, 0)
101typedef QIconEngine QIconEngineV2;
102#endif
103
104QT_END_NAMESPACE
105
106#endif // QICONENGINE_H
107