[−][src]Struct qt_gui::QPen

#[repr(C)]pub struct QPen { /* fields omitted */ }

The QPen class defines how a QPainter should draw lines and outlines of shapes.

C++ class: QPen.

C++ documentation:

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 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:

QPainter painter(this);
QPen pen(Qt::green, 3, Qt::DashDotLine, Qt::RoundCap, Qt::RoundJoin);
painter.setPen(pen);

which is equivalent to

QPainter painter(this);
QPen pen;  // creates a default pen
pen.setStyle(Qt::DashDotLine);
pen.setWidth(3);
pen.setBrush(Qt::green);
pen.setCapStyle(Qt::RoundCap);
pen.setJoinStyle(Qt::RoundJoin);
painter.setPen(pen);

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 Paint System documentation.

Methods

`impl QPen`[src]

`pub unsafe fn brush(&self) -> CppBox<QBrush>`[src]

Returns the brush used to fill strokes generated with this pen.

Calls C++ function: QBrush QPen::brush() const.

C++ documentation:

Returns the brush used to fill strokes generated with this pen.

See also setBrush().

`pub unsafe fn cap_style(&self) -> PenCapStyle`[src]

Returns the pen's cap style.

Calls C++ function: Qt::PenCapStyle QPen::capStyle() const.

C++ documentation:

Returns the pen's cap style.

See also setCapStyle() and Cap Style.

`pub unsafe fn color(&self) -> CppBox<QColor>`[src]

Returns the color of this pen's brush.

Calls C++ function: QColor QPen::color() const.

C++ documentation:

Returns the color of this pen's brush.

See also brush() and setColor().

`pub unsafe fn copy_from(&self, pen: impl CastInto<Ref<QPen>>) -> Ref<QPen>`[src]

Assigns the given pen to this pen and returns a reference to this pen.

Calls C++ function: QPen& QPen::operator=(const QPen& pen).

C++ documentation:

Assigns the given pen to this pen and returns a reference to this pen.

`pub unsafe fn dash_offset(&self) -> c_double`[src]

Returns the dash offset for the pen.

Calls C++ function: double QPen::dashOffset() const.

C++ documentation:

Returns the dash offset for the pen.

See also setDashOffset().

`pub unsafe fn dash_pattern(&self) -> CppBox<QVectorOfDouble>`[src]

Returns the dash pattern of this pen.

Calls C++ function: QVector<double> QPen::dashPattern() const.

C++ documentation:

Returns the dash pattern of this pen.

See also setDashPattern(), style(), and isSolid().

`pub unsafe fn is_cosmetic(&self) -> bool`[src]

Returns true if the pen is cosmetic; otherwise returns false.

Calls C++ function: bool QPen::isCosmetic() const.

C++ documentation:

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.

See also setCosmetic() and widthF().

`pub unsafe fn is_detached(&self) -> bool`[src]

Calls C++ function: bool QPen::isDetached().

`pub unsafe fn is_solid(&self) -> bool`[src]

Returns true if the pen has a solid fill, otherwise false.

Calls C++ function: bool QPen::isSolid() const.

C++ documentation:

Returns true if the pen has a solid fill, otherwise false.

See also style() and dashPattern().

`pub unsafe fn join_style(&self) -> PenJoinStyle`[src]

Returns the pen's join style.

Calls C++ function: Qt::PenJoinStyle QPen::joinStyle() const.

C++ documentation:

Returns the pen's join style.

See also setJoinStyle() and Join Style.

`pub unsafe fn miter_limit(&self) -> c_double`[src]

Returns the miter limit of the pen. The miter limit is only relevant when the join style is set to Qt::MiterJoin.

Calls C++ function: double QPen::miterLimit() const.

C++ documentation:

Returns the miter limit of the pen. The miter limit is only relevant when the join style is set to Qt::MiterJoin.

See also setMiterLimit() and Join Style.

`pub unsafe fn new() -> CppBox<QPen>`[src]

Constructs a default black solid line pen with 1 width.

Calls C++ function: [constructor] void QPen::QPen().

C++ documentation:

Constructs a default black solid line pen with 1 width.

`pub unsafe fn from_pen_style(arg1: PenStyle) -> CppBox<QPen>`[src]

Constructs a black pen with 1 width and the given style.

Calls C++ function: [constructor] void QPen::QPen(Qt::PenStyle arg1).

C++ documentation:

Constructs a black pen with 1 width and the given style.

See also setStyle().

`pub unsafe fn from_q_color(color: impl CastInto<Ref<QColor>>) -> CppBox<QPen>`[src]

Constructs a solid line pen with 1 width and the given color.

Calls C++ function: [constructor] void QPen::QPen(const QColor& color).

C++ documentation:

Constructs a solid line pen with 1 width and the given color.

See also setBrush() and setColor().