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 virtual ~QIconEngine();
55 virtual void paint(QPainter *painter, const QRect &rect, QIcon::Mode mode, QIcon::State state) = 0;
56 virtual QSize actualSize(const QSize &size, QIcon::Mode mode, QIcon::State state);
57 virtual QPixmap pixmap(const QSize &size, QIcon::Mode mode, QIcon::State state);
58
59 virtual void addPixmap(const QPixmap &pixmap, QIcon::Mode mode, QIcon::State state);
60 virtual void addFile(const QString &fileName, const QSize &size, QIcon::Mode mode, QIcon::State state);
61
62 virtual QString key() const;
63 virtual QIconEngine *clone() const = 0;
64 virtual bool read(QDataStream &in);
65 virtual bool write(QDataStream &out) const;
66
67 virtual QList<QSize> availableSizes(QIcon::Mode mode = QIcon::Normal,
68 QIcon::State state = QIcon::Off);
69
70 virtual QString iconName();
71 virtual bool isNull();
72 virtual QPixmap scaledPixmap(const QSize &size, QIcon::Mode mode, QIcon::State state, qreal scale);
73
74 enum IconEngineHook { IsNullHook = 3, ScaledPixmapHook };
75
76 struct ScaledPixmapArgument
77 {
78 QSize size;
79 QIcon::Mode mode;
80 QIcon::State state;
81 qreal scale;
82 QPixmap pixmap;
83 };
84
85 virtual void virtual_hook(int id, void *data);
86
87protected:
88 QIconEngine(const QIconEngine &other);
89
90private:
91 QIconEngine &operator=(const QIconEngine &other) = delete;
92};
93
94QT_END_NAMESPACE
95
96#endif // QICONENGINE_H
97