← Back to branch summary

~ubuntu-branches/ubuntu/wily/qtbase-opensource-src/wily

« back to all changes in this revision

Viewing changes to src/gui/image/qicon.h

  • Committer: Package Import Robot
  • Author(s): Timo Jyrinki
  • Date: 2013-02-05 12:46:17 UTC
  • Revision ID: package-import@ubuntu.com-20130205124617-c8jouts182j002fx
Tags: upstream-5.0.1+dfsg
Import upstream version 5.0.1+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/gui/image/qicon.h
 
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 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 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
#ifndef QICON_H
 
43
#define QICON_H
 
44
 
 
45
#include <QtCore/qglobal.h>
 
46
#include <QtCore/qsize.h>
 
47
#include <QtCore/qlist.h>
 
48
#include <QtGui/qpixmap.h>
 
49
 
 
50
QT_BEGIN_HEADER
 
51
 
 
52
QT_BEGIN_NAMESPACE
 
53
 
 
54
 
 
55
class QIconPrivate;
 
56
class QIconEngine;
 
57
 
 
58
class Q_GUI_EXPORT QIcon
 
59
{
 
60
public:
 
61
    enum Mode { Normal, Disabled, Active, Selected };
 
62
    enum State { On, Off };
 
63
 
 
64
    QIcon();
 
65
    QIcon(const QPixmap &pixmap);
 
66
    QIcon(const QIcon &other);
 
67
    explicit QIcon(const QString &fileName); // file or resource name
 
68
    explicit QIcon(QIconEngine *engine);
 
69
    ~QIcon();
 
70
    QIcon &operator=(const QIcon &other);
 
71
#ifdef Q_COMPILER_RVALUE_REFS
 
72
    inline QIcon &operator=(QIcon &&other)
 
73
    { qSwap(d, other.d); return *this; }
 
74
#endif
 
75
    inline void swap(QIcon &other) { qSwap(d, other.d); }
 
76
 
 
77
    operator QVariant() const;
 
78
 
 
79
    QPixmap pixmap(const QSize &size, Mode mode = Normal, State state = Off) const;
 
80
    inline QPixmap pixmap(int w, int h, Mode mode = Normal, State state = Off) const
 
81
        { return pixmap(QSize(w, h), mode, state); }
 
82
    inline QPixmap pixmap(int extent, Mode mode = Normal, State state = Off) const
 
83
        { return pixmap(QSize(extent, extent), mode, state); }
 
84
 
 
85
    QSize actualSize(const QSize &size, Mode mode = Normal, State state = Off) const;
 
86
 
 
87
    QString name() const;
 
88
 
 
89
    void paint(QPainter *painter, const QRect &rect, Qt::Alignment alignment = Qt::AlignCenter, Mode mode = Normal, State state = Off) const;
 
90
    inline void paint(QPainter *painter, int x, int y, int w, int h, Qt::Alignment alignment = Qt::AlignCenter, Mode mode = Normal, State state = Off) const
 
91
        { paint(painter, QRect(x, y, w, h), alignment, mode, state); }
 
92
 
 
93
    bool isNull() const;
 
94
    bool isDetached() const;
 
95
    void detach();
 
96
 
 
97
#if QT_DEPRECATED_SINCE(5, 0)
 
98
    QT_DEPRECATED inline int serialNumber() const { return cacheKey() >> 32; }
 
99
#endif
 
100
    qint64 cacheKey() const;
 
101
 
 
102
    void addPixmap(const QPixmap &pixmap, Mode mode = Normal, State state = Off);
 
103
    void addFile(const QString &fileName, const QSize &size = QSize(), Mode mode = Normal, State state = Off);
 
104
 
 
105
    QList<QSize> availableSizes(Mode mode = Normal, State state = Off) const;
 
106
 
 
107
    static QIcon fromTheme(const QString &name, const QIcon &fallback = QIcon());
 
108
    static bool hasThemeIcon(const QString &name);
 
109
 
 
110
    static QStringList themeSearchPaths();
 
111
    static void setThemeSearchPaths(const QStringList &searchpath);
 
112
 
 
113
    static QString themeName();
 
114
    static void setThemeName(const QString &path);
 
115
 
 
116
    Q_DUMMY_COMPARISON_OPERATOR(QIcon)
 
117
 
 
118
private:
 
119
    QIconPrivate *d;
 
120
#if !defined(QT_NO_DATASTREAM)
 
121
    friend Q_GUI_EXPORT QDataStream &operator<<(QDataStream &, const QIcon &);
 
122
    friend Q_GUI_EXPORT QDataStream &operator>>(QDataStream &, QIcon &);
 
123
#endif
 
124
 
 
125
public:
 
126
    typedef QIconPrivate * DataPtr;
 
127
    inline DataPtr &data_ptr() { return d; }
 
128
};
 
129
 
 
130
Q_DECLARE_SHARED(QIcon)
 
131
 
 
132
#if !defined(QT_NO_DATASTREAM)
 
133
Q_GUI_EXPORT QDataStream &operator<<(QDataStream &, const QIcon &);
 
134
Q_GUI_EXPORT QDataStream &operator>>(QDataStream &, QIcon &);
 
135
#endif
 
136
 
 
137
#ifndef QT_NO_DEBUG_STREAM
 
138
Q_GUI_EXPORT QDebug operator<<(QDebug dbg, const QIcon &);
 
139
#endif
 
140
 
 
141
QT_END_NAMESPACE
 
142
 
 
143
QT_END_HEADER
 
144
 
 
145
#endif // QICON_H