src/gui/painting/qpen.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtGui module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  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
  48 QT_BEGIN_HEADER
  49
  50 QT_BEGIN_NAMESPACE
  51
  52 QT_MODULE(Gui)
  53
  54 class QVariant;
  55 class QPenPrivate;
  56 class QBrush;
  57 class QPen;
  58
  59 #ifndef QT_NO_DATASTREAM
  60 Q_GUI_EXPORT QDataStream &operator<<(QDataStream &, const QPen &);
  61 Q_GUI_EXPORT QDataStream &operator>>(QDataStream &, QPen &);
  62 #endif
  63
  64 class Q_GUI_EXPORT QPen
  65 {
  66 public:
  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();
 123 private:
 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
 130 public:
 131     typedef QPenPrivate * DataPtr;
 132     inline DataPtr &data_ptr() { return d; }
 133 };
 134 Q_DECLARE_TYPEINFO(QPen, Q_MOVABLE_TYPE);
 135 Q_DECLARE_SHARED(QPen)
 136
 137 #ifndef QT_NO_DEBUG_STREAM
 138 Q_GUI_EXPORT QDebug operator<<(QDebug, const QPen &);
 139 #endif
 140
 141 QT_END_NAMESPACE
 142
 143 QT_END_HEADER
 144
 145 #endif // QPEN_H