Материал из Wiki.crossplatform.ru

Внимание: Актуальная версия перевода документации находится здесь

__NOTOC__

[править] Описание класса QPen
^{[модуль QtGui ]}

Класс QPen определяет, как должен QPainter рисовать линии и контуры фигур. Далее...

 #include <QPen>

• Список всех членов включая унаследованные

[править] Открытые функции

• QPen ()
• QPen ( Qt::PenStyle style )
• QPen ( const QColor & color )
• QPen ( const QBrush & brush, qreal width, Qt::PenStyle style = Qt::SolidLine, Qt::PenCapStyle cap = Qt::SquareCap, Qt::PenJoinStyle join = Qt::BevelJoin )
• QPen ( const QPen & pen )
• ~QPen ()
• QBrush brush () const
• Qt::PenCapStyle capStyle () const
• QColor color () const
• qreal dashOffset () const
• QVector<qreal> dashPattern () const
• bool isCosmetic () const
• bool isSolid () const
• Qt::PenJoinStyle joinStyle () const
• qreal miterLimit () const
• void setBrush ( const QBrush & brush )
• void setCapStyle ( Qt::PenCapStyle style )
• void setColor ( const QColor & color )
• void setCosmetic ( bool cosmetic )
• void setDashOffset ( qreal offset )
• void setDashPattern ( const QVector<qreal> & pattern )
• void setJoinStyle ( Qt::PenJoinStyle style )
• void setMiterLimit ( qreal limit )
• void setStyle ( Qt::PenStyle style )
• void setWidth ( int width )
• void setWidthF ( qreal width )
• Qt::PenStyle style () const
• int width () const
• qreal widthF () const
• operator QVariant () const
• bool operator!= ( const QPen & pen ) const
• QPen & operator= ( const QPen & pen )
• bool operator== ( const QPen & pen ) const

[править] Связанные не-члены

• QDataStream & operator<< ( QDataStream & stream, const QPen & pen )
• QDataStream & operator>> ( QDataStream & stream, QPen & pen )

[править] Подробное описание

Класс QPen определяет, как должен QPainter рисовать линии и контуры фигур.

Перо имеет style(), width(), brush(), capStyle() и 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).

Например:

 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 0 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.

• Pen Style
• Cap Style
• Join Style

[править] Стиль пера

Qt provides several built-in styles represented by the Qt::PenStyle enum:

Simply use the setStyle() function to convert the pen style to either of the built-in styles, except the Qt::CustomDashLine style which we will come back to shortly. Setting the style to Qt::NoPen tells the painter to not draw lines or outlines. The default pen style is Qt::SolidLine.

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. The pattern argument, a QVector, must be specified as an even number of qreal entries where the entries 1, 3, 5... are the dashes and 2, 4, 6... are the spaces. For example, the custom pattern shown above is created using the following code:

 QPen pen;
 QVector<qreal> dashes;
 qreal space = 4;
 
 dashes << 1 << space << 3 << space << 9 << space
            << 27 << space << 9;
 
 pen.setDashPattern(dashes);

Note that 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.

The currently set dash pattern can be retrieved using the dashPattern() function. Use the isSolid() function to determine whether the pen has a solid fill, or not.

[править] Cap Style

The cap style defines how the end points of lines are drawn using QPainter. The cap style only apply to wide lines, i.e. when the width is 1 or greater. The Qt::PenCapStyle enum provides the following styles:

The Qt::SquareCap style is a square line end that covers the end point and extends beyond it by half the line width. The Qt::FlatCap style is a square line end that does not cover the end point of the line. And the Qt::RoundCap style is a rounded line end covering the end point.

The default is Qt::SquareCap.

Whether or not end points are drawn when the pen width is 0 or 1 depends on the cap style. Using Qt::SquareCap or Qt::RoundCap they are drawn, using Qt::FlatCap they are not drawn.

[править] Join Style

The join style defines how joins between two connected lines can be drawn using QPainter. The join style only apply to wide lines, i.e. when the width is 1 or greater. The Qt::PenJoinStyle enum provides the following styles:

The Qt::BevelJoin style fills the triangular notch between the two lines. The Qt::MiterJoin style extends the lines to meet at an angle. And the Qt::RoundJoin style fills a circular arc between the two lines.

The default is Qt::BevelJoin.

Файл:Qpen-miterlimit.png

When the Qt::MiterJoin style is applied, it is possible to use the setMiterLimit() function to specify how far the miter join can extend from the join point. The miterLimit() is used to reduce artifacts between line joins where the lines are close to parallel.

The miterLimit() must be specified in units of the pens 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.

Смотрите также QPainter, QBrush, Path Stroking Demo, и Scribble Example.

[править] Описание функций-членов

[править]

QPen::QPen ()

Создает по умолчанию черное непрерывное перо толщиной 0.

[править]

QPen::QPen ( Qt::PenStyle style )

Создает черное перо с толщиной 0 и стилем style.

Смотрите также setStyle().

[править]

QPen::QPen ( const QColor & color )

Создает перо с цветом color и толщиной 0..

Смотрите также setBrush() и setColor().

[править]

QPen::QPen ( const QBrush & brush, qreal width, Qt::PenStyle style = Qt::SolidLine, Qt::PenCapStyle cap = Qt::SquareCap, Qt::PenJoinStyle join = Qt::BevelJoin )

Создает перо с заданной кистью brush и толщиной width. Стиль пера устанавливается в style, стиль окончаний пера устанавливается в cap, а стиль соединений - в join.

Смотрите также setBrush(), setWidth(), setStyle(), setCapStyle(), и setJoinStyle().

[править]

QPen::QPen ( const QPen & pen )

Создает перо, являющееся копией pen.

[править]

QPen::~QPen ()

Разрушает перо.

[править]

QBrush QPen::brush () const

Возвращает кисть, используемую для заполнения рисунков данного пера.

Смотрите также setBrush().

[править]

Qt::PenCapStyle QPen::capStyle () const

Возвращает стиль окончаний пера.

Смотрите также setCapStyle() и Cap Style.

[править]

QColor QPen::color () const

Возвращает цвет пера.

Смотрите также brush() и setColor().

[править]

qreal QPen::dashOffset () const

Returns the dash offset for the pen.

Смотрите также setDashOffset().

[править]

QVector< qreal> QPen::dashPattern () const

Возвращает образец линии пера.

Смотрите также setDashPattern(), style(), и isSolid().

[править]

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; pens with a non-zero width are non-cosmetic.

Смотрите также setCosmetic() и widthF().

[править]

bool QPen::isSolid () const

Возвращает true если перо имеет непрерывное заполнение, иначе false.

Смотрите также style() и dashPattern().

[править]

Qt::PenJoinStyle QPen::joinStyle () const

Возвращает стиль соединений пера.

Смотрите также setJoinStyle() и Join Style.

[править]

qreal QPen::miterLimit () const

Возвращает предел митры пера. Предел митры пера уместен только в том случае, если стиль соединений линий пера установлен в Qt::MiterJoin.

Смотрите также setMiterLimit() и Join Style.

[править]

void QPen::setBrush ( const QBrush & brush )

Устанавливает кисть, используемую пером для заполнения форм в brush.

Смотрите также brush() и setColor().

[править]

void QPen::setCapStyle ( Qt::PenCapStyle style )

Устанавливает стиль окончаний пера в style. Значение по умолчанию Qt::SquareCap.

Смотрите также capStyle() и Cap Style.

[править]

void QPen::setColor ( const QColor & color )

Устанавливает цвет пера в color.

Смотрите также setBrush() и color().

[править]

void QPen::setCosmetic ( bool cosmetic )

Sets this pen to cosmetic or non-cosmetic, depending on the value of cosmetic.

Смотрите также isCosmetic().

[править]

void QPen::setDashOffset ( qreal offset )

Sets the dash offset for this pen to the given offset. This implicitly converts the style of the pen to Qt::CustomDashLine.

Смотрите также dashOffset().

[править]

void QPen::setDashPattern ( const QVector< qreal> & pattern )

Устанавливает образец линии пера в pattern. Стиль пера наявно устанавливается в Qt::CustomDashLine.

Образец должен быть задан, как набор чисел, где значения с номерами 1, 3, 5... - это длины штрихов, с номерами 2, 4, 6... длины пропусков. Например:

 QPen pen;
 QVector<qreal> dashes;
 qreal space = 4;
 dashes << 1 << space << 3 << space << 9 << space
            << 27 << space << 9;
 pen.setDashPattern(dashes);

Образец линии пера задается в единицах толщины пера, например, образец штриха, длиной в 5 при толщине линии 10 пикселей, имеет длину 50 пикселей. Каждый из штрихов подчинен стилям окончания, так что, штрих, длиной в 1 пиксель при квадратных окончаниях линий, будет растянут на 0.5 пикселей в каждом из направлений, и в результате длина штриха будет равна 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.

Смотрите также setStyle(), dashPattern(), и setCapStyle().

[править]

void QPen::setJoinStyle ( Qt::PenJoinStyle style )

Устанавливает стиль соединений пера в style. Значение по умолчанию Qt::BevelJoin.

Смотрите также joinStyle() и Join Style.

[править]

void QPen::setMiterLimit ( qreal limit )

Устанавливает предел митры пера в limit.

Файл:Qpen-miterlimit.png

Предел митры указывает, как далеко может простираться митра от точки соединения линий. Он используется для уменьшения закрышиваемой области между соединяющимися линиями в случаях, когда линии почти параллельны.

Имеет значение только тогда, когда стиль пера установлен в Qt::MiterJoin. TЗначение задается в единицах толщины пера, 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.

Смотрите также miterLimit(), setJoinStyle(), и Join Style.

[править]

void QPen::setStyle ( Qt::PenStyle style )

Устанавливает стиль пера в style.

Для получения списка всех стилей пера см. описание Qt::PenStyle. 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.

Смотрите также style() и Pen Style.

[править]

void QPen::setWidth ( int width )

Устанавливает толщину пера width в пикселах с точностью до целого числа.

Ширина пера равная нулю делает перо косметическим. Это означает, что толщина линии будет равна 1, независимо от трансформации установленной в паинтере.

Установка толщины пера в отрицательные значения не поддерживается.

Смотрите также setWidthF() и width().

[править]

void QPen::setWidthF ( qreal width )

Устанавливает толщину пера в width в пикселах с точностю до точки.

Ширина пера равная нулю делает перо косметическим. Это означает, что толщина линии будет равна 1, независимо от трансформации установленной в паинтере.

Установка толщины пера в отрицательные значения не поддерживается.

Смотрите также setWidth() и widthF().

[править]

Qt::PenStyle QPen::style () const

Возвращает стиль пера.

Смотрите также setStyle() и Pen Style.

[править]

int QPen::width () const

Возвращает толщину пера в виде целого числа.

Смотрите также setWidth() и widthF().

[править]

qreal QPen::widthF () const

Возвращает толщину пера в виде числа с плавающей точкой.

Смотрите также setWidthF() и width().

[править]

QPen::operator QVariant () const

Возвращает перо как QVariant.

[править]

bool QPen::operator!= ( const QPen & pen ) const

Возвращает true если данное перо отлично от пера pen; в противном случае возвращает false. Два пера различны, если они имеют разные стили, ширину или цвет.

Смотрите также operator==().

[править]

QPen & QPen::operator= ( const QPen & pen )

Присваивает значение пера pen данному перу и возвращает ссылку на данное перо.

[править]

bool QPen::operator== ( const QPen & pen ) const

Возвращает true если данное перо эквивалентно pen; в противном случае возвращает false. Два пера различны, если они имеют разные стили, ширину или цвет.

Смотрите также operator!=().

[править] Связанные не-члены

[править]

QDataStream & operator<< ( QDataStream & stream, const QPen & pen )

Эта перегруженная функция член предоставлена для удобства.

Записывает перо pen в поток stream и возвращает ссылку на поток stream.

Смотрите также Формат QDataStream операторов.

[править]

QDataStream & operator>> ( QDataStream & stream, QPen & pen )

Эта перегруженная функция член предоставлена для удобства.

Читает из потока stream в перо pen и возвращает ссылку на поток stream.

Смотрите также Формат QDataStream операторов.

Перевод: akorchagin

Обсуждение и критика перевода Здесь...