1/****************************************************************************
2**
3** Copyright (C) 2014 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 QPEN_H
43#define QPEN_H
44
45#include <QtGui/qcolor.h>
46#include <QtGui/qbrush.h>
47
48QT_BEGIN_HEADER
49
50QT_BEGIN_NAMESPACE
51
52QT_MODULE(Gui)
53
54class QVariant;
55class QPenPrivate;
56class QBrush;
57class QPen;
58
59#ifndef QT_NO_DATASTREAM
60Q_GUI_EXPORT QDataStream &operator<<(QDataStream &, const QPen &);
61Q_GUI_EXPORT QDataStream &operator>>(QDataStream &, QPen &);
62#endif
63
64class Q_GUI_EXPORT QPen
65{
66public:
67 QPen();
68 QPen(Qt::PenStyle);
69 QPen(const QColor &color);
70 QPen(const QBrush &brush, qreal width, Qt::PenStyle s = Qt::SolidLine,
71 Qt::PenCapStyle c = Qt::SquareCap, Qt::PenJoinStyle j = Qt::BevelJoin);
72 QPen(const QPen &pen);
73
74 ~QPen();
75
76 QPen &operator=(const QPen &pen);
77#ifdef Q_COMPILER_RVALUE_REFS
78 inline QPen &operator=(QPen &&other)
79 { qSwap(d, other.d); return *this; }
80#endif
81 inline void swap(QPen &other) { qSwap(d, other.d); }
82
83 Qt::PenStyle style() const;
84 void setStyle(Qt::PenStyle);
85
86 QVector<qreal> dashPattern() const;
87 void setDashPattern(const QVector<qreal> &pattern);
88
89 qreal dashOffset() const;
90 void setDashOffset(qreal doffset);
91
92 qreal miterLimit() const;
93 void setMiterLimit(qreal limit);
94
95 qreal widthF() const;
96 void setWidthF(qreal width);
97
98 int width() const;
99 void setWidth(int width);
100
101 QColor color() const;
102 void setColor(const QColor &color);
103
104 QBrush brush() const;
105 void setBrush(const QBrush &brush);
106
107 bool isSolid() const;
108
109 Qt::PenCapStyle capStyle() const;
110 void setCapStyle(Qt::PenCapStyle pcs);
111
112 Qt::PenJoinStyle joinStyle() const;
113 void setJoinStyle(Qt::PenJoinStyle pcs);
114
115 bool isCosmetic() const;
116 void setCosmetic(bool cosmetic);
117
118 bool operator==(const QPen &p) const;
119 inline bool operator!=(const QPen &p) const { return !(operator==(p)); }
120 operator QVariant() const;
121
122 bool isDetached();
123private:
124 friend Q_GUI_EXPORT QDataStream &operator>>(QDataStream &, QPen &);
125 friend Q_GUI_EXPORT QDataStream &operator<<(QDataStream &, const QPen &);
126
127 void detach();
128 class QPenPrivate *d;
129
130public:
131 typedef QPenPrivate * DataPtr;
132 inline DataPtr &data_ptr() { return d; }
133};
134Q_DECLARE_TYPEINFO(QPen, Q_MOVABLE_TYPE);
135Q_DECLARE_SHARED(QPen)
136
137#ifndef QT_NO_DEBUG_STREAM
138Q_GUI_EXPORT QDebug operator<<(QDebug, const QPen &);
139#endif
140
141QT_END_NAMESPACE
142
143QT_END_HEADER
144
145#endif // QPEN_H
146