 |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
|
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
\inmodule QtGui More...
#include <qpen.h>
Public Types | |
| using | DataPtr = QExplicitlySharedDataPointer<QPenPrivate> |
Public Member Functions | |
| QPen () | |
| Constructs a default black solid line pen with 1 width. | |
| QPen (Qt::PenStyle) | |
| Constructs a black pen with 1 width and the given style. | |
| QPen (const QColor &color) | |
| Constructs a solid line pen with 1 width and the given color. | |
| QPen (const QBrush &brush, qreal width, Qt::PenStyle s=Qt::SolidLine, Qt::PenCapStyle c=Qt::SquareCap, Qt::PenJoinStyle j=Qt::BevelJoin) | |
| Constructs a pen with the specified brush, width, pen style, cap style and join style. | |
| QPen (const QPen &pen) noexcept | |
| Constructs a pen that is a copy of the given pen. | |
| ~QPen () | |
| Destroys the pen. | |
| QPen & | operator= (const QPen &pen) noexcept |
| Assigns the given pen to this pen and returns a reference to this pen. | |
| QPen (QPen &&other) noexcept=default | |
| void | swap (QPen &other) noexcept |
| QPen & | operator= (QColor color) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| QPen & | operator= (Qt::PenStyle style) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
| Qt::PenStyle | style () const |
| Returns the pen style. | |
| void | setStyle (Qt::PenStyle) |
| Sets the pen style to the given style. | |
| QList< qreal > | dashPattern () const |
| Returns the dash pattern of this pen. | |
| void | setDashPattern (const QList< qreal > &pattern) |
| Sets the dash pattern for this pen to the given pattern. | |
| qreal | dashOffset () const |
| Returns the dash offset for the pen. | |
| void | setDashOffset (qreal doffset) |
| Sets the dash offset (the starting point on the dash pattern) for this pen to the offset specified. | |
| qreal | miterLimit () const |
| Returns the miter limit of the pen. | |
| void | setMiterLimit (qreal limit) |
| Sets the miter limit of this pen to the given limit. | |
| qreal | widthF () const |
| Returns the pen width with floating point precision. | |
| void | setWidthF (qreal width) |
| Sets the pen width to the given width in pixels with floating point precision. | |
| int | width () const |
| Returns the pen width with integer precision. | |
| void | setWidth (int width) |
| Sets the pen width to the given width in pixels with integer precision. | |
| QColor | color () const |
| Returns the color of this pen's brush. | |
| void | setColor (const QColor &color) |
| Sets the color of this pen's brush to the given color. | |
| QBrush | brush () const |
| Returns the brush used to fill strokes generated with this pen. | |
| void | setBrush (const QBrush &brush) |
| Sets the brush used to fill strokes generated with this pen to the given brush. | |
| bool | isSolid () const |
Returns true if the pen has a solid fill, otherwise false. | |
| Qt::PenCapStyle | capStyle () const |
| Returns the pen's cap style. | |
| void | setCapStyle (Qt::PenCapStyle pcs) |
| Sets the pen's cap style to the given style. | |
| Qt::PenJoinStyle | joinStyle () const |
| Returns the pen's join style. | |
| void | setJoinStyle (Qt::PenJoinStyle pcs) |
| Sets the pen's join style to the given style. | |
| bool | isCosmetic () const |
Returns true if the pen is cosmetic; otherwise returns false. | |
| void | setCosmetic (bool cosmetic) |
| Sets this pen to cosmetic or non-cosmetic, depending on the value of cosmetic. | |
| bool | operator== (const QPen &p) const |
Returns true if the pen is equal to the given pen; otherwise false. | |
| bool | operator!= (const QPen &p) const |
Returns true if the pen is different from the given pen; otherwise false. | |
| operator QVariant () const | |
| Returns the pen as a QVariant. | |
| bool | isDetached () |
| DataPtr & | data_ptr () |
Friends | |
| Q_GUI_EXPORT QDataStream & | operator>> (QDataStream &s, QPen &p) |
| Reads a pen from the given stream into the given pen and returns a reference to the stream. | |
| Q_GUI_EXPORT QDataStream & | operator<< (QDataStream &s, const QPen &p) |
| Writes the given pen to the given stream and returns a reference to the stream. | |
| bool | comparesEqual (const QPen &lhs, QColor rhs) noexcept |
| bool | comparesEqual (const QPen &lhs, Qt::PenStyle rhs) |
\inmodule QtGui
The QPen class defines how a QPainter should draw lines and outlines of shapes.
A pen has a style(), width(), brush(), capStyle() and joinStyle().
The pen style defines the line type. The brush is used to fill strokes generated with the pen. Use the QBrush class to specify fill styles. The cap style determines the line end caps that can be drawn using QPainter, while the join style describes how joins between two lines are drawn. The pen width can be specified in both integer (width()) and floating point (widthF()) precision. A line width of zero indicates a cosmetic pen. This means that the pen width is always drawn one pixel wide, independent of the \l {QPainter#Coordinate Transformations}{transformation} set on the painter.
The various settings can easily be modified using the corresponding setStyle(), setWidth(), setBrush(), setCapStyle() and setJoinStyle() functions (note that the painter's pen must be reset when altering the pen's properties).
For example:
which is equivalent to
The default pen is a solid black brush with 1 width, square cap style (Qt::SquareCap), and bevel join style (Qt::BevelJoin).
In addition QPen provides the color() and setColor() convenience functions to extract and set the color of the pen's brush, respectively. Pens may also be compared and streamed.
For more information about painting in general, see the \l{Paint System} documentation.
| qpen_default_join QPen::QPen | ( | ) |
| QPen::QPen | ( | Qt::PenStyle | style | ) |
Constructs a black pen with 1 width and the given style.
| QPen::QPen | ( | const QColor & | color | ) |
Constructs a solid line pen with 1 width and the given color.
| QPen::QPen | ( | const QBrush & | brush, |
| qreal | width, | ||
| Qt::PenStyle | style = Qt::SolidLine, | ||
| Qt::PenCapStyle | cap = Qt::SquareCap, | ||
| Qt::PenJoinStyle | join = Qt::BevelJoin ) |
Constructs a pen with the specified brush, width, pen style, cap style and join style.
|
noexcept |
|
default |
Destroys the pen.
|
defaultnoexcept |
Constructs a pen that is moved from the given pen.
The moved-from pen can only be assigned to, copied, or destroyed. Any other operation (prior to assignment) leads to undefined behavior.
| QBrush QPen::brush | ( | ) | const |
| Qt::PenCapStyle QPen::capStyle | ( | ) | const |
Returns the pen's cap style.
| QColor QPen::color | ( | ) | const |
Returns the color of this pen's brush.
| qreal QPen::dashOffset | ( | ) | const |
Returns the dash offset for the pen.
| bool QPen::isCosmetic | ( | ) | const |
Returns true if the pen is cosmetic; otherwise returns false.
Cosmetic pens are used to draw strokes that have a constant width regardless of any transformations applied to the QPainter they are used with. Drawing a shape with a cosmetic pen ensures that its outline will have the same thickness at different scale factors.
A zero width pen is cosmetic by default.
| bool QPen::isSolid | ( | ) | const |
Returns true if the pen has a solid fill, otherwise false.
| Qt::PenJoinStyle QPen::joinStyle | ( | ) | const |
Returns the pen's join style.
| qreal QPen::miterLimit | ( | ) | const |
Returns the miter limit of the pen.
The miter limit is only relevant when the join style is set to Qt::MiterJoin.
| QPen::operator QVariant | ( | ) | const |
|
inline |
Returns true if the pen is different from the given pen; otherwise false.
Two pens are different if they have different styles, widths or colors.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Makes this pen a solid pen with the given color, and default cap and join styles, and returns a reference to this pen.
| QPen & QPen::operator= | ( | Qt::PenStyle | style | ) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Makes this pen a solid, black pen with default cap and join styles, and returns a reference to this pen.
| bool QPen::operator== | ( | const QPen & | pen | ) | const |
Returns true if the pen is equal to the given pen; otherwise false.
Two pens are equal if they have equal styles, widths and colors.
Sets the brush used to fill strokes generated with this pen to the given brush.
| void QPen::setCapStyle | ( | Qt::PenCapStyle | style | ) |
Sets the pen's cap style to the given style.
The default value is Qt::SquareCap.
Sets the color of this pen's brush to the given color.
| void QPen::setCosmetic | ( | bool | cosmetic | ) |
Sets this pen to cosmetic or non-cosmetic, depending on the value of cosmetic.
Sets the dash offset (the starting point on the dash pattern) for this pen to the offset specified.
The offset is measured in terms of the units used to specify the dash pattern.
\table \row
However, if the dash offset is set to 4.0, any line drawn will begin with the gap. Values of the offset up to 4.0 will cause part of the stroke to be drawn first, and values of the offset between 4.0 and 6.0 will cause the line to begin with part of the gap. \endtable
Sets the dash pattern for this pen to the given pattern.
This implicitly converts the style of the pen to Qt::CustomDashLine.
The pattern must be specified as an even number of positive entries where the entries 1, 3, 5... are the dashes and 2, 4, 6... are the spaces. For example:
\table 100% \row
The dash pattern is specified in units of the pens width; e.g. a dash of length 5 in width 10 is 50 pixels long. Note that a pen with zero width is equivalent to a cosmetic pen with a width of 1 pixel.
Each dash is also subject to cap styles so a dash of 1 with square cap set will extend 0.5 pixels out in each direction resulting in a total width of 2.
Note that the default cap style is Qt::SquareCap, meaning that a square line end covers the end point and extends beyond it by half the line width.
| void QPen::setJoinStyle | ( | Qt::PenJoinStyle | style | ) |
Sets the pen's join style to the given style.
The default value is Qt::BevelJoin.
Sets the miter limit of this pen to the given limit.
The miter limit describes how far a miter join can extend from the join point. This is used to reduce artifacts between line joins where the lines are close to parallel.
This value does only have effect when the pen style is set to Qt::MiterJoin. The value is specified in units of the pen's width, e.g. a miter limit of 5 in width 10 is 50 pixels long. The default miter limit is 2, i.e. twice the pen width in pixels.
| void QPen::setStyle | ( | Qt::PenStyle | style | ) |
Sets the pen style to the given style.
See the \l Qt::PenStyle documentation for a list of the available styles. Since Qt 4.1 it is also possible to specify a custom dash pattern using the setDashPattern() function which implicitly converts the style of the pen to Qt::CustomDashLine.
| void QPen::setWidth | ( | int | width | ) |
Sets the pen width to the given width in pixels with integer precision.
A line width of zero indicates a cosmetic pen. This means that the pen width is always drawn one pixel wide, independent of the \l {QPainter#Coordinate Transformations}{transformation} set on the painter.
Setting a pen width with a negative value is not supported.
Sets the pen width to the given width in pixels with floating point precision.
A line width of zero indicates a cosmetic pen. This means that the pen width is always drawn one pixel wide, independent of the \l {QPainter#Coordinate Transformations}{transformation} on the painter.
Setting a pen width with a negative value is not supported.
| Qt::PenStyle QPen::style | ( | ) | const |
Returns the pen style.
| int QPen::width | ( | ) | const |
Returns the pen width with integer precision.
| qreal QPen::widthF | ( | ) | const |
Returns the pen width with floating point precision.
|
friend |
|
friend |
|
friend |
1.14.0