qtbase/src/widgets/styles/qdrawutil.cpp
Christian Ehrlicher f349040b39 QDrawUtil: Cleanup qDrawPlainRoundedRect/qDrawPlainRect
Fix the style and use PainterStateGuard instead own save/restore
functionality because PainterStateGuard is already available and used in
those functions.

Pick-to: 6.8
Task-number: QTBUG-132187
Change-Id: Ie454b6cffe03444d88f13d15adb19a7e7783a493
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
(cherry picked from commit 1fb86f1f84bb56dab60bc15604c09a14157d6f10)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
2024-12-20 15:38:17 +00:00

1228 lines
45 KiB
C++

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qdrawutil.h"
#include "qbitmap.h"
#include "qpixmapcache.h"
#include "qpainter.h"
#include "qpalette.h"
#include "qstylehelper_p.h"
#include <private/qpaintengineex_p.h>
#include <qvarlengtharray.h>
#include <qmath.h>
#include <private/qhexstring_p.h>
QT_BEGIN_NAMESPACE
namespace {
class PainterStateGuard {
Q_DISABLE_COPY_MOVE(PainterStateGuard)
public:
explicit PainterStateGuard(QPainter *p) : m_painter(p) {}
~PainterStateGuard()
{
for ( ; m_level > 0; --m_level)
m_painter->restore();
}
void save()
{
m_painter->save();
++m_level;
}
void restore()
{
m_painter->restore();
--m_level;
}
private:
QPainter *m_painter;
int m_level= 0;
};
} // namespace
/*!
\headerfile <qdrawutil.h>
\inmodule QtWidgets
\title Drawing Utility Functions
\sa QPainter
*/
/*!
\fn void qDrawShadeLine(QPainter *painter, int x1, int y1, int x2, int y2,
const QPalette &palette, bool sunken,
int lineWidth, int midLineWidth)
\relates <qdrawutil.h>
Draws a horizontal (\a y1 == \a y2) or vertical (\a x1 == \a x2)
shaded line using the given \a painter. Note that nothing is
drawn if \a y1 != \a y2 and \a x1 != \a x2 (i.e. the line is
neither horizontal nor vertical).
The provided \a palette specifies the shading colors (\l
{QPalette::light()}{light}, \l {QPalette::dark()}{dark} and \l
{QPalette::mid()}{middle} colors). The given \a lineWidth
specifies the line width for each of the lines; it is not the
total line width. The given \a midLineWidth specifies the width of
a middle line drawn in the QPalette::mid() color.
The line appears sunken if \a sunken is true, otherwise raised.
\warning This function does not look at QWidget::style() or
QApplication::style(). Use the drawing functions in QStyle to
make widgets that follow the current GUI style.
Alternatively you can use a QFrame widget and apply the
QFrame::setFrameStyle() function to display a shaded line:
\snippet code/src_gui_painting_qdrawutil.cpp 0
\sa qDrawShadeRect(), qDrawShadePanel(), QStyle
*/
void qDrawShadeLine(QPainter *p, int x1, int y1, int x2, int y2,
const QPalette &pal, bool sunken,
int lineWidth, int midLineWidth)
{
if (Q_UNLIKELY(!p || lineWidth < 0 || midLineWidth < 0)) {
qWarning("qDrawShadeLine: Invalid parameters");
return;
}
PainterStateGuard painterGuard(p);
const qreal devicePixelRatio = QStyleHelper::getDpr(p);
if (!qFuzzyCompare(devicePixelRatio, qreal(1))) {
painterGuard.save();
const qreal inverseScale = qreal(1) / devicePixelRatio;
p->scale(inverseScale, inverseScale);
x1 = qRound(devicePixelRatio * x1);
y1 = qRound(devicePixelRatio * y1);
x2 = qRound(devicePixelRatio * x2);
y2 = qRound(devicePixelRatio * y2);
lineWidth = qRound(devicePixelRatio * lineWidth);
midLineWidth = qRound(devicePixelRatio * midLineWidth);
p->translate(0.5, 0.5);
}
int tlw = lineWidth*2 + midLineWidth; // total line width
QPen oldPen = p->pen(); // save pen
if (sunken)
p->setPen(pal.color(QPalette::Dark));
else
p->setPen(pal.light().color());
QPolygon a;
int i;
if (y1 == y2) { // horizontal line
int y = y1 - tlw/2;
if (x1 > x2) { // swap x1 and x2
int t = x1;
x1 = x2;
x2 = t;
}
x2--;
for (i=0; i<lineWidth; i++) { // draw top shadow
a.setPoints(3, x1+i, y+tlw-1-i,
x1+i, y+i,
x2-i, y+i);
p->drawPolyline(a);
}
if (midLineWidth > 0) {
p->setPen(pal.mid().color());
for (i=0; i<midLineWidth; i++) // draw lines in the middle
p->drawLine(x1+lineWidth, y+lineWidth+i,
x2-lineWidth, y+lineWidth+i);
}
if (sunken)
p->setPen(pal.light().color());
else
p->setPen(pal.dark().color());
for (i=0; i<lineWidth; i++) { // draw bottom shadow
a.setPoints(3, x1+i, y+tlw-i-1,
x2-i, y+tlw-i-1,
x2-i, y+i+1);
p->drawPolyline(a);
}
}
else if (x1 == x2) { // vertical line
int x = x1 - tlw/2;
if (y1 > y2) { // swap y1 and y2
int t = y1;
y1 = y2;
y2 = t;
}
y2--;
for (i=0; i<lineWidth; i++) { // draw left shadow
a.setPoints(3, x+i, y2,
x+i, y1+i,
x+tlw-1, y1+i);
p->drawPolyline(a);
}
if (midLineWidth > 0) {
p->setPen(pal.mid().color());
for (i=0; i<midLineWidth; i++) // draw lines in the middle
p->drawLine(x+lineWidth+i, y1+lineWidth, x+lineWidth+i, y2);
}
if (sunken)
p->setPen(pal.light().color());
else
p->setPen(pal.dark().color());
for (i=0; i<lineWidth; i++) { // draw right shadow
a.setPoints(3, x+lineWidth, y2-i,
x+tlw-i-1, y2-i,
x+tlw-i-1, y1+lineWidth);
p->drawPolyline(a);
}
}
p->setPen(oldPen);
}
/*!
\fn void qDrawShadeRect(QPainter *painter, int x, int y, int width, int height,
const QPalette &palette, bool sunken,
int lineWidth, int midLineWidth,
const QBrush *fill)
\relates <qdrawutil.h>
Draws the shaded rectangle beginning at (\a x, \a y) with the
given \a width and \a height using the provided \a painter.
The provide \a palette specifies the shading colors (\l
{QPalette::light()}{light}, \l {QPalette::dark()}{dark} and \l
{QPalette::mid()}{middle} colors. The given \a lineWidth
specifies the line width for each of the lines; it is not the
total line width. The \a midLineWidth specifies the width of a
middle line drawn in the QPalette::mid() color. The rectangle's
interior is filled with the \a fill brush unless \a fill is \nullptr.
The rectangle appears sunken if \a sunken is true, otherwise
raised.
\warning This function does not look at QWidget::style() or
QApplication::style(). Use the drawing functions in QStyle to make
widgets that follow the current GUI style.
Alternatively you can use a QFrame widget and apply the
QFrame::setFrameStyle() function to display a shaded rectangle:
\snippet code/src_gui_painting_qdrawutil.cpp 1
\sa qDrawShadeLine(), qDrawShadePanel(), qDrawPlainRect(), QStyle
*/
void qDrawShadeRect(QPainter *p, int x, int y, int w, int h,
const QPalette &pal, bool sunken,
int lineWidth, int midLineWidth,
const QBrush *fill)
{
if (w == 0 || h == 0)
return;
if (Q_UNLIKELY(w < 0 || h < 0 || lineWidth < 0 || midLineWidth < 0)) {
qWarning("qDrawShadeRect: Invalid parameters");
return;
}
PainterStateGuard painterGuard(p);
const qreal devicePixelRatio = QStyleHelper::getDpr(p);
if (!qFuzzyCompare(devicePixelRatio, qreal(1))) {
painterGuard.save();
const qreal inverseScale = qreal(1) / devicePixelRatio;
p->scale(inverseScale, inverseScale);
x = qRound(devicePixelRatio * x);
y = qRound(devicePixelRatio * y);
w = devicePixelRatio * w;
h = devicePixelRatio * h;
lineWidth = qRound(devicePixelRatio * lineWidth);
midLineWidth = qRound(devicePixelRatio * midLineWidth);
p->translate(0.5, 0.5);
}
QPen oldPen = p->pen();
if (sunken)
p->setPen(pal.dark().color());
else
p->setPen(pal.light().color());
int x1=x, y1=y, x2=x+w-1, y2=y+h-1;
if (lineWidth == 1 && midLineWidth == 0) {// standard shade rectangle
p->drawRect(x1, y1, w-2, h-2);
if (sunken)
p->setPen(pal.light().color());
else
p->setPen(pal.dark().color());
QLineF lines[4] = { QLineF(x1+1, y1+1, x2-2, y1+1),
QLineF(x1+1, y1+2, x1+1, y2-2),
QLineF(x1, y2, x2, y2),
QLineF(x2,y1, x2,y2-1) };
p->drawLines(lines, 4); // draw bottom/right lines
} else { // more complicated
int m = lineWidth+midLineWidth;
int i, j=0, k=m;
for (i=0; i<lineWidth; i++) { // draw top shadow
QLineF lines[4] = { QLineF(x1+i, y2-i, x1+i, y1+i),
QLineF(x1+i, y1+i, x2-i, y1+i),
QLineF(x1+k, y2-k, x2-k, y2-k),
QLineF(x2-k, y2-k, x2-k, y1+k) };
p->drawLines(lines, 4);
k++;
}
p->setPen(pal.mid().color());
j = lineWidth*2;
for (i=0; i<midLineWidth; i++) { // draw lines in the middle
p->drawRect(x1+lineWidth+i, y1+lineWidth+i, w-j-1, h-j-1);
j += 2;
}
if (sunken)
p->setPen(pal.light().color());
else
p->setPen(pal.dark().color());
k = m;
for (i=0; i<lineWidth; i++) { // draw bottom shadow
QLineF lines[4] = { QLineF(x1+1+i, y2-i, x2-i, y2-i),
QLineF(x2-i, y2-i, x2-i, y1+i+1),
QLineF(x1+k, y2-k, x1+k, y1+k),
QLineF(x1+k, y1+k, x2-k, y1+k) };
p->drawLines(lines, 4);
k++;
}
}
if (fill) {
QBrush oldBrush = p->brush();
int tlw = lineWidth + midLineWidth;
p->setPen(Qt::NoPen);
p->setBrush(*fill);
p->drawRect(x+tlw, y+tlw, w-2*tlw, h-2*tlw);
p->setBrush(oldBrush);
}
p->setPen(oldPen); // restore pen
}
/*!
\fn void qDrawShadePanel(QPainter *painter, int x, int y, int width, int height,
const QPalette &palette, bool sunken,
int lineWidth, const QBrush *fill)
\relates <qdrawutil.h>
Draws the shaded panel beginning at (\a x, \a y) with the given \a
width and \a height using the provided \a painter and the given \a
lineWidth.
The given \a palette specifies the shading colors (\l
{QPalette::light()}{light}, \l {QPalette::dark()}{dark} and \l
{QPalette::mid()}{middle} colors). The panel's interior is filled
with the \a fill brush unless \a fill is \nullptr.
The panel appears sunken if \a sunken is true, otherwise raised.
\warning This function does not look at QWidget::style() or
QApplication::style(). Use the drawing functions in QStyle to make
widgets that follow the current GUI style.
Alternatively you can use a QFrame widget and apply the
QFrame::setFrameStyle() function to display a shaded panel:
\snippet code/src_gui_painting_qdrawutil.cpp 2
\sa qDrawWinPanel(), qDrawShadeLine(), qDrawShadeRect(), QStyle
*/
void qDrawShadePanel(QPainter *p, int x, int y, int w, int h,
const QPalette &pal, bool sunken,
int lineWidth, const QBrush *fill)
{
if (w == 0 || h == 0)
return;
if (Q_UNLIKELY(w < 0 || h < 0 || lineWidth < 0)) {
qWarning("qDrawShadePanel: Invalid parameters");
}
PainterStateGuard painterGuard(p);
const qreal devicePixelRatio = QStyleHelper::getDpr(p);
bool isTranslated = false;
if (!qFuzzyCompare(devicePixelRatio, qreal(1))) {
painterGuard.save();
const qreal inverseScale = qreal(1) / devicePixelRatio;
p->scale(inverseScale, inverseScale);
x = qRound(devicePixelRatio * x);
y = qRound(devicePixelRatio * y);
w = devicePixelRatio * w;
h = devicePixelRatio * h;
lineWidth = qRound(devicePixelRatio * lineWidth);
p->translate(0.5, 0.5);
isTranslated = true;
}
QColor shade = pal.dark().color();
QColor light = pal.light().color();
if (fill) {
if (fill->color() == shade)
shade = pal.shadow().color();
if (fill->color() == light)
light = pal.midlight().color();
}
QPen oldPen = p->pen(); // save pen
QList<QLineF> lines;
lines.reserve(2*lineWidth);
if (sunken)
p->setPen(shade);
else
p->setPen(light);
int x1, y1, x2, y2;
int i;
x1 = x;
y1 = y2 = y;
x2 = x+w-2;
for (i=0; i<lineWidth; i++) { // top shadow
lines << QLineF(x1, y1++, x2--, y2++);
}
x2 = x1;
y1 = y+h-2;
for (i=0; i<lineWidth; i++) { // left shado
lines << QLineF(x1++, y1, x2++, y2--);
}
p->drawLines(lines);
lines.clear();
if (sunken)
p->setPen(light);
else
p->setPen(shade);
x1 = x;
y1 = y2 = y+h-1;
x2 = x+w-1;
for (i=0; i<lineWidth; i++) { // bottom shadow
lines << QLineF(x1++, y1--, x2, y2--);
}
x1 = x2;
y1 = y;
y2 = y+h-lineWidth-1;
for (i=0; i<lineWidth; i++) { // right shadow
lines << QLineF(x1--, y1++, x2--, y2);
}
p->drawLines(lines);
if (fill) { // fill with fill color
if (isTranslated)
p->translate(-0.5, -0.5);
p->fillRect(x+lineWidth, y+lineWidth, w-lineWidth*2, h-lineWidth*2, *fill);
}
p->setPen(oldPen); // restore pen
}
/*!
\internal
This function draws a rectangle with two pixel line width.
It is called from qDrawWinButton() and qDrawWinPanel().
c1..c4 and fill are used:
1 1 1 1 1 2
1 3 3 3 4 2
1 3 F F 4 2
1 3 F F 4 2
1 4 4 4 4 2
2 2 2 2 2 2
*/
static void qDrawWinShades(QPainter *p,
int x, int y, int w, int h,
const QColor &c1, const QColor &c2,
const QColor &c3, const QColor &c4,
const QBrush *fill)
{
if (w < 2 || h < 2) // can't do anything with that
return;
PainterStateGuard painterGuard(p);
const qreal devicePixelRatio = QStyleHelper::getDpr(p);
bool isTranslated = false;
if (!qFuzzyCompare(devicePixelRatio, qreal(1))) {
painterGuard.save();
const qreal inverseScale = qreal(1) / devicePixelRatio;
p->scale(inverseScale, inverseScale);
x = qRound(devicePixelRatio * x);
y = qRound(devicePixelRatio * y);
w = devicePixelRatio * w;
h = devicePixelRatio * h;
p->translate(0.5, 0.5);
isTranslated = true;
}
QPen oldPen = p->pen();
QPoint a[3] = { QPoint(x, y+h-2), QPoint(x, y), QPoint(x+w-2, y) };
p->setPen(c1);
p->drawPolyline(a, 3);
QPoint b[3] = { QPoint(x, y+h-1), QPoint(x+w-1, y+h-1), QPoint(x+w-1, y) };
p->setPen(c2);
p->drawPolyline(b, 3);
if (w > 4 && h > 4) {
QPoint c[3] = { QPoint(x+1, y+h-3), QPoint(x+1, y+1), QPoint(x+w-3, y+1) };
p->setPen(c3);
p->drawPolyline(c, 3);
QPoint d[3] = { QPoint(x+1, y+h-2), QPoint(x+w-2, y+h-2), QPoint(x+w-2, y+1) };
p->setPen(c4);
p->drawPolyline(d, 3);
if (fill) {
if (isTranslated)
p->translate(-0.5, -0.5);
p->fillRect(QRect(x+2, y+2, w-4, h-4), *fill);
}
}
p->setPen(oldPen);
}
/*!
\fn void qDrawWinButton(QPainter *painter, int x, int y, int width, int height,
const QPalette &palette, bool sunken,
const QBrush *fill)
\relates <qdrawutil.h>
Draws the Windows-style button specified by the given point (\a x,
\a y}, \a width and \a height using the provided \a painter with a
line width of 2 pixels. The button's interior is filled with the
\a{fill} brush unless \a fill is \nullptr.
The given \a palette specifies the shading colors (\l
{QPalette::light()}{light}, \l {QPalette::dark()}{dark} and \l
{QPalette::mid()}{middle} colors).
The button appears sunken if \a sunken is true, otherwise raised.
\warning This function does not look at QWidget::style() or
QApplication::style()-> Use the drawing functions in QStyle to make
widgets that follow the current GUI style.
\sa qDrawWinPanel(), QStyle
*/
void qDrawWinButton(QPainter *p, int x, int y, int w, int h,
const QPalette &pal, bool sunken,
const QBrush *fill)
{
if (sunken)
qDrawWinShades(p, x, y, w, h,
pal.shadow().color(), pal.light().color(), pal.dark().color(),
pal.button().color(), fill);
else
qDrawWinShades(p, x, y, w, h,
pal.light().color(), pal.shadow().color(), pal.button().color(),
pal.dark().color(), fill);
}
/*!
\fn void qDrawWinPanel(QPainter *painter, int x, int y, int width, int height,
const QPalette &palette, bool sunken,
const QBrush *fill)
\relates <qdrawutil.h>
Draws the Windows-style panel specified by the given point(\a x,
\a y), \a width and \a height using the provided \a painter with a
line width of 2 pixels. The button's interior is filled with the
\a fill brush unless \a fill is \nullptr.
The given \a palette specifies the shading colors. The panel
appears sunken if \a sunken is true, otherwise raised.
\warning This function does not look at QWidget::style() or
QApplication::style(). Use the drawing functions in QStyle to make
widgets that follow the current GUI style.
Alternatively you can use a QFrame widget and apply the
QFrame::setFrameStyle() function to display a shaded panel:
\snippet code/src_gui_painting_qdrawutil.cpp 3
\sa qDrawShadePanel(), qDrawWinButton(), QStyle
*/
void qDrawWinPanel(QPainter *p, int x, int y, int w, int h,
const QPalette &pal, bool sunken,
const QBrush *fill)
{
if (sunken)
qDrawWinShades(p, x, y, w, h,
pal.dark().color(), pal.light().color(), pal.shadow().color(),
pal.midlight().color(), fill);
else
qDrawWinShades(p, x, y, w, h,
pal.light().color(), pal.shadow().color(), pal.midlight().color(),
pal.dark().color(), fill);
}
/*!
\fn void qDrawPlainRect(QPainter *painter, int x, int y, int width, int height, const QColor &lineColor,
int lineWidth, const QBrush *fill)
\relates <qdrawutil.h>
Draws the plain rectangle beginning at (\a x, \a y) with the given
\a width and \a height, using the specified \a painter, \a lineColor
and \a lineWidth. The rectangle's interior is filled with the \a
fill brush unless \a fill is \nullptr.
\warning This function does not look at QWidget::style() or
QApplication::style(). Use the drawing functions in QStyle to make
widgets that follow the current GUI style.
Alternatively you can use a QFrame widget and apply the
QFrame::setFrameStyle() function to display a plain rectangle:
\snippet code/src_gui_painting_qdrawutil.cpp 4
\sa qDrawShadeRect(), QStyle
*/
void qDrawPlainRect(QPainter *p, int x, int y, int w, int h, const QColor &c,
int lineWidth, const QBrush *fill)
{
if (w == 0 || h == 0)
return;
if (Q_UNLIKELY(w < 0 || h < 0 || lineWidth < 0)) {
qWarning("qDrawPlainRect: Invalid parameters");
return;
}
PainterStateGuard painterGuard(p);
painterGuard.save();
const qreal devicePixelRatio = QStyleHelper::getDpr(p);
if (!qFuzzyCompare(devicePixelRatio, qreal(1))) {
const qreal inverseScale = qreal(1) / devicePixelRatio;
p->scale(inverseScale, inverseScale);
x = qRound(devicePixelRatio * x);
y = qRound(devicePixelRatio * y);
w = devicePixelRatio * w;
h = devicePixelRatio * h;
lineWidth = qRound(devicePixelRatio * lineWidth);
p->translate(0.5, 0.5);
}
p->setPen(c);
p->setBrush(Qt::NoBrush);
for (int i=0; i<lineWidth; i++)
p->drawRect(x+i, y+i, w-i*2 - 1, h-i*2 - 1);
if (fill) { // fill with fill color
p->setPen(Qt::NoPen);
p->setBrush(*fill);
p->drawRect(x+lineWidth, y+lineWidth, w-lineWidth*2, h-lineWidth*2);
}
}
/*!
\fn void qDrawPlainRoundedRect(QPainter *painter, int x, int y,
int width, int height, qreal rx, qreal ry,
const QColor &lineColor, int lineWidth,
const QBrush *fill)
\since 6.7
\relates <qdrawutil.h>
Draws the plain rounded rectangle beginning at (\a x, \a y)
with the given \a width and \a height,
using the horizontal \a rx and vertical radius \a ry,
specified \a painter, \a lineColor and \a lineWidth.
The rectangle's interior is filled with the \a
fill brush unless \a fill is \nullptr.
\warning This function does not look at QWidget::style() or
QApplication::style(). Use the drawing functions in QStyle to make
widgets that follow the current GUI style.
Alternatively you can use a QFrame widget and apply the
QFrame::setFrameStyle() function to display a plain rectangle:
\snippet code/src_gui_painting_qdrawutil.cpp 4
\sa qDrawShadeRect(), QStyle
*/
// ### Qt7: Pass QPen instead of QColor for frame drawing
void qDrawPlainRoundedRect(QPainter *p, int x, int y, int w, int h,
qreal rx, qreal ry, const QColor &c,
int lineWidth, const QBrush *fill)
{
if (w == 0 || h == 0)
return;
if (Q_UNLIKELY(w < 0 || h < 0 || lineWidth < 0)) {
qWarning("qDrawPlainRect: Invalid parameters");
return;
}
PainterStateGuard painterGuard(p);
painterGuard.save();
const qreal devicePixelRatio = QStyleHelper::getDpr(p);
if (!qFuzzyCompare(devicePixelRatio, qreal(1))) {
const qreal inverseScale = qreal(1) / devicePixelRatio;
p->scale(inverseScale, inverseScale);
x = qRound(devicePixelRatio * x);
y = qRound(devicePixelRatio * y);
w = devicePixelRatio * w;
h = devicePixelRatio * h;
lineWidth = qRound(devicePixelRatio * lineWidth);
p->translate(0.5, 0.5);
}
p->setPen(c);
p->setBrush(Qt::NoBrush);
for (int i=0; i<lineWidth; i++) {
QRectF rect(x+i, y+i, w-i*2 - 1, h-i*2 - 1);
rect.marginsRemoved(QMarginsF(0.5,0.5,0.5,0.5));
p->drawRoundedRect(rect, rx, ry);
}
if (fill) { // fill with fill color
p->setPen(Qt::NoPen);
p->setBrush(*fill);
p->drawRoundedRect(x+lineWidth, y+lineWidth, w-lineWidth*2, h-lineWidth*2, rx, ry);
}
}
/*****************************************************************************
Overloaded functions.
*****************************************************************************/
/*!
\fn void qDrawShadeLine(QPainter *painter, const QPoint &p1, const QPoint &p2,
const QPalette &palette, bool sunken, int lineWidth, int midLineWidth)
\relates <qdrawutil.h>
\overload
Draws a horizontal or vertical shaded line between \a p1 and \a p2
using the given \a painter. Note that nothing is drawn if the line
between the points would be neither horizontal nor vertical.
The provided \a palette specifies the shading colors (\l
{QPalette::light()}{light}, \l {QPalette::dark()}{dark} and \l
{QPalette::mid()}{middle} colors). The given \a lineWidth
specifies the line width for each of the lines; it is not the
total line width. The given \a midLineWidth specifies the width of
a middle line drawn in the QPalette::mid() color.
The line appears sunken if \a sunken is true, otherwise raised.
\warning This function does not look at QWidget::style() or
QApplication::style(). Use the drawing functions in QStyle to
make widgets that follow the current GUI style.
Alternatively you can use a QFrame widget and apply the
QFrame::setFrameStyle() function to display a shaded line:
\snippet code/src_gui_painting_qdrawutil.cpp 5
\sa qDrawShadeRect(), qDrawShadePanel(), QStyle
*/
void qDrawShadeLine(QPainter *p, const QPoint &p1, const QPoint &p2,
const QPalette &pal, bool sunken,
int lineWidth, int midLineWidth)
{
qDrawShadeLine(p, p1.x(), p1.y(), p2.x(), p2.y(), pal, sunken,
lineWidth, midLineWidth);
}
/*!
\fn void qDrawShadeRect(QPainter *painter, const QRect &rect, const QPalette &palette,
bool sunken, int lineWidth, int midLineWidth, const QBrush *fill)
\relates <qdrawutil.h>
\overload
Draws the shaded rectangle specified by \a rect using the given \a painter.
The provide \a palette specifies the shading colors (\l
{QPalette::light()}{light}, \l {QPalette::dark()}{dark} and \l
{QPalette::mid()}{middle} colors. The given \a lineWidth
specifies the line width for each of the lines; it is not the
total line width. The \a midLineWidth specifies the width of a
middle line drawn in the QPalette::mid() color. The rectangle's
interior is filled with the \a fill brush unless \a fill is \nullptr.
The rectangle appears sunken if \a sunken is true, otherwise
raised.
\warning This function does not look at QWidget::style() or
QApplication::style(). Use the drawing functions in QStyle to make
widgets that follow the current GUI style.
Alternatively you can use a QFrame widget and apply the
QFrame::setFrameStyle() function to display a shaded rectangle:
\snippet code/src_gui_painting_qdrawutil.cpp 6
\sa qDrawShadeLine(), qDrawShadePanel(), qDrawPlainRect(), QStyle
*/
void qDrawShadeRect(QPainter *p, const QRect &r,
const QPalette &pal, bool sunken,
int lineWidth, int midLineWidth,
const QBrush *fill)
{
qDrawShadeRect(p, r.x(), r.y(), r.width(), r.height(), pal, sunken,
lineWidth, midLineWidth, fill);
}
/*!
\fn void qDrawShadePanel(QPainter *painter, const QRect &rect, const QPalette &palette,
bool sunken, int lineWidth, const QBrush *fill)
\relates <qdrawutil.h>
\overload
Draws the shaded panel at the rectangle specified by \a rect using the
given \a painter and the given \a lineWidth.
The given \a palette specifies the shading colors (\l
{QPalette::light()}{light}, \l {QPalette::dark()}{dark} and \l
{QPalette::mid()}{middle} colors). The panel's interior is filled
with the \a fill brush unless \a fill is \nullptr.
The panel appears sunken if \a sunken is true, otherwise raised.
\warning This function does not look at QWidget::style() or
QApplication::style(). Use the drawing functions in QStyle to make
widgets that follow the current GUI style.
Alternatively you can use a QFrame widget and apply the
QFrame::setFrameStyle() function to display a shaded panel:
\snippet code/src_gui_painting_qdrawutil.cpp 7
\sa qDrawWinPanel(), qDrawShadeLine(), qDrawShadeRect(), QStyle
*/
void qDrawShadePanel(QPainter *p, const QRect &r,
const QPalette &pal, bool sunken,
int lineWidth, const QBrush *fill)
{
qDrawShadePanel(p, r.x(), r.y(), r.width(), r.height(), pal, sunken,
lineWidth, fill);
}
/*!
\fn void qDrawWinButton(QPainter *painter, const QRect &rect, const QPalette &palette,
bool sunken, const QBrush *fill)
\relates <qdrawutil.h>
\overload
Draws the Windows-style button at the rectangle specified by \a rect using
the given \a painter with a line width of 2 pixels. The button's interior
is filled with the \a{fill} brush unless \a fill is \nullptr.
The given \a palette specifies the shading colors (\l
{QPalette::light()}{light}, \l {QPalette::dark()}{dark} and \l
{QPalette::mid()}{middle} colors).
The button appears sunken if \a sunken is true, otherwise raised.
\warning This function does not look at QWidget::style() or
QApplication::style()-> Use the drawing functions in QStyle to make
widgets that follow the current GUI style.
\sa qDrawWinPanel(), QStyle
*/
void qDrawWinButton(QPainter *p, const QRect &r,
const QPalette &pal, bool sunken, const QBrush *fill)
{
qDrawWinButton(p, r.x(), r.y(), r.width(), r.height(), pal, sunken, fill);
}
/*!
\fn void qDrawWinPanel(QPainter *painter, const QRect &rect, const QPalette &palette,
bool sunken, const QBrush *fill)
\relates <qdrawutil.h>
\overload
Draws the Windows-style panel at the rectangle specified by \a rect using
the given \a painter with a line width of 2 pixels. The button's interior
is filled with the \a fill brush unless \a fill is \nullptr.
The given \a palette specifies the shading colors. The panel
appears sunken if \a sunken is true, otherwise raised.
\warning This function does not look at QWidget::style() or
QApplication::style(). Use the drawing functions in QStyle to make
widgets that follow the current GUI style.
Alternatively you can use a QFrame widget and apply the
QFrame::setFrameStyle() function to display a shaded panel:
\snippet code/src_gui_painting_qdrawutil.cpp 8
\sa qDrawShadePanel(), qDrawWinButton(), QStyle
*/
void qDrawWinPanel(QPainter *p, const QRect &r,
const QPalette &pal, bool sunken, const QBrush *fill)
{
qDrawWinPanel(p, r.x(), r.y(), r.width(), r.height(), pal, sunken, fill);
}
/*!
\fn void qDrawPlainRect(QPainter *painter, const QRect &rect, const QColor &lineColor, int lineWidth, const QBrush *fill)
\relates <qdrawutil.h>
\overload
Draws the plain rectangle specified by \a rect using the given \a painter,
\a lineColor and \a lineWidth. The rectangle's interior is filled with the
\a fill brush unless \a fill is \nullptr.
\warning This function does not look at QWidget::style() or
QApplication::style(). Use the drawing functions in QStyle to make
widgets that follow the current GUI style.
Alternatively you can use a QFrame widget and apply the
QFrame::setFrameStyle() function to display a plain rectangle:
\snippet code/src_gui_painting_qdrawutil.cpp 9
\sa qDrawShadeRect(), QStyle
*/
void qDrawPlainRect(QPainter *p, const QRect &r, const QColor &c,
int lineWidth, const QBrush *fill)
{
qDrawPlainRect(p, r.x(), r.y(), r.width(), r.height(), c,
lineWidth, fill);
}
/*!
\fn void qDrawPlainRoundedRect(QPainter *painter, const QRect &rect,
qreal rx, qreal ry,
const QColor &lineColor, int lineWidth,
const QBrush *fill)
\since 6.7
\relates <qdrawutil.h>
\overload
Draws the plain rectangle specified by \a rect using
the horizontal \a rx and vertical radius \a ry,
the given \a painter, \a lineColor and \a lineWidth.
The rectangle's interior is filled with the
\a fill brush unless \a fill is \nullptr.
\warning This function does not look at QWidget::style() or
QApplication::style(). Use the drawing functions in QStyle to make
widgets that follow the current GUI style.
Alternatively you can use a QFrame widget and apply the
QFrame::setFrameStyle() function to display a plain rectangle:
\snippet code/src_gui_painting_qdrawutil.cpp 9
\sa qDrawShadeRect(), QStyle
*/
/*!
\class QTileRules
\since 4.6
\inmodule QtWidgets
\brief The QTileRules class provides the rules used to draw a
pixmap or image split into nine segments.
Spliiting is similar to \l{http://www.w3.org/TR/css3-background/}{CSS3 border-images}.
\sa Qt::TileRule, QMargins
*/
/*! \fn QTileRules::QTileRules(Qt::TileRule horizontalRule, Qt::TileRule verticalRule)
Constructs a QTileRules with the given \a horizontalRule and
\a verticalRule.
*/
/*! \fn QTileRules::QTileRules(Qt::TileRule rule)
Constructs a QTileRules with the given \a rule used for both
the horizontal rule and the vertical rule.
*/
/*!
\fn void qDrawBorderPixmap(QPainter *painter, const QRect &target, const QMargins &margins, const QPixmap &pixmap)
\relates <qdrawutil.h>
\since 4.6
\brief The qDrawBorderPixmap function is for drawing a pixmap into
the margins of a rectangle.
Draws the given \a pixmap into the given \a target rectangle, using the
given \a painter. The pixmap will be split into nine segments and drawn
according to the \a margins structure.
*/
typedef QVarLengthArray<QPainter::PixmapFragment, 16> QPixmapFragmentsArray;
/*!
\relates <qdrawutil.h>
\since 4.6
Draws the indicated \a sourceRect rectangle from the given \a pixmap into
the given \a targetRect rectangle, using the given \a painter. The pixmap
will be split into nine segments according to the given \a targetMargins
and \a sourceMargins structures. Finally, the pixmap will be drawn
according to the given \a rules.
This function is used to draw a scaled pixmap, similar to
\l{http://www.w3.org/TR/css3-background/}{CSS3 border-images}
\sa Qt::TileRule, QTileRules, QMargins
*/
void qDrawBorderPixmap(QPainter *painter, const QRect &targetRect, const QMargins &targetMargins,
const QPixmap &pixmap, const QRect &sourceRect,const QMargins &sourceMargins,
const QTileRules &rules
#ifndef Q_QDOC
, QDrawBorderPixmap::DrawingHints hints
#endif
)
{
QPainter::PixmapFragment d;
d.opacity = 1.0;
d.rotation = 0.0;
QPixmapFragmentsArray opaqueData;
QPixmapFragmentsArray translucentData;
// source center
const int sourceCenterTop = sourceRect.top() + sourceMargins.top();
const int sourceCenterLeft = sourceRect.left() + sourceMargins.left();
const int sourceCenterBottom = sourceRect.bottom() - sourceMargins.bottom() + 1;
const int sourceCenterRight = sourceRect.right() - sourceMargins.right() + 1;
const int sourceCenterWidth = sourceCenterRight - sourceCenterLeft;
const int sourceCenterHeight = sourceCenterBottom - sourceCenterTop;
// target center
const int targetCenterTop = targetRect.top() + targetMargins.top();
const int targetCenterLeft = targetRect.left() + targetMargins.left();
const int targetCenterBottom = targetRect.bottom() - targetMargins.bottom() + 1;
const int targetCenterRight = targetRect.right() - targetMargins.right() + 1;
const int targetCenterWidth = targetCenterRight - targetCenterLeft;
const int targetCenterHeight = targetCenterBottom - targetCenterTop;
QVarLengthArray<qreal, 16> xTarget; // x-coordinates of target rectangles
QVarLengthArray<qreal, 16> yTarget; // y-coordinates of target rectangles
int columns = 3;
int rows = 3;
if (rules.horizontal != Qt::StretchTile && sourceCenterWidth != 0)
columns = qMax(3, 2 + qCeil(targetCenterWidth / qreal(sourceCenterWidth)));
if (rules.vertical != Qt::StretchTile && sourceCenterHeight != 0)
rows = qMax(3, 2 + qCeil(targetCenterHeight / qreal(sourceCenterHeight)));
xTarget.resize(columns + 1);
yTarget.resize(rows + 1);
bool oldAA = painter->testRenderHint(QPainter::Antialiasing);
if (painter->paintEngine()->type() != QPaintEngine::OpenGL
&& painter->paintEngine()->type() != QPaintEngine::OpenGL2
&& oldAA && painter->combinedTransform().type() != QTransform::TxNone) {
painter->setRenderHint(QPainter::Antialiasing, false);
}
xTarget[0] = targetRect.left();
xTarget[1] = targetCenterLeft;
xTarget[columns - 1] = targetCenterRight;
xTarget[columns] = targetRect.left() + targetRect.width();
yTarget[0] = targetRect.top();
yTarget[1] = targetCenterTop;
yTarget[rows - 1] = targetCenterBottom;
yTarget[rows] = targetRect.top() + targetRect.height();
qreal dx = targetCenterWidth;
qreal dy = targetCenterHeight;
switch (rules.horizontal) {
case Qt::StretchTile:
dx = targetCenterWidth;
break;
case Qt::RepeatTile:
dx = sourceCenterWidth;
break;
case Qt::RoundTile:
dx = targetCenterWidth / qreal(columns - 2);
break;
}
for (int i = 2; i < columns - 1; ++i)
xTarget[i] = xTarget[i - 1] + dx;
switch (rules.vertical) {
case Qt::StretchTile:
dy = targetCenterHeight;
break;
case Qt::RepeatTile:
dy = sourceCenterHeight;
break;
case Qt::RoundTile:
dy = targetCenterHeight / qreal(rows - 2);
break;
}
for (int i = 2; i < rows - 1; ++i)
yTarget[i] = yTarget[i - 1] + dy;
// corners
if (targetMargins.top() > 0 && targetMargins.left() > 0 && sourceMargins.top() > 0 && sourceMargins.left() > 0) { // top left
d.x = (0.5 * (xTarget[1] + xTarget[0]));
d.y = (0.5 * (yTarget[1] + yTarget[0]));
d.sourceLeft = sourceRect.left();
d.sourceTop = sourceRect.top();
d.width = sourceMargins.left();
d.height = sourceMargins.top();
d.scaleX = qreal(xTarget[1] - xTarget[0]) / d.width;
d.scaleY = qreal(yTarget[1] - yTarget[0]) / d.height;
if (hints & QDrawBorderPixmap::OpaqueTopLeft)
opaqueData.append(d);
else
translucentData.append(d);
}
if (targetMargins.top() > 0 && targetMargins.right() > 0 && sourceMargins.top() > 0 && sourceMargins.right() > 0) { // top right
d.x = (0.5 * (xTarget[columns] + xTarget[columns - 1]));
d.y = (0.5 * (yTarget[1] + yTarget[0]));
d.sourceLeft = sourceCenterRight;
d.sourceTop = sourceRect.top();
d.width = sourceMargins.right();
d.height = sourceMargins.top();
d.scaleX = qreal(xTarget[columns] - xTarget[columns - 1]) / d.width;
d.scaleY = qreal(yTarget[1] - yTarget[0]) / d.height;
if (hints & QDrawBorderPixmap::OpaqueTopRight)
opaqueData.append(d);
else
translucentData.append(d);
}
if (targetMargins.bottom() > 0 && targetMargins.left() > 0 && sourceMargins.bottom() > 0 && sourceMargins.left() > 0) { // bottom left
d.x = (0.5 * (xTarget[1] + xTarget[0]));
d.y =(0.5 * (yTarget[rows] + yTarget[rows - 1]));
d.sourceLeft = sourceRect.left();
d.sourceTop = sourceCenterBottom;
d.width = sourceMargins.left();
d.height = sourceMargins.bottom();
d.scaleX = qreal(xTarget[1] - xTarget[0]) / d.width;
d.scaleY = qreal(yTarget[rows] - yTarget[rows - 1]) / d.height;
if (hints & QDrawBorderPixmap::OpaqueBottomLeft)
opaqueData.append(d);
else
translucentData.append(d);
}
if (targetMargins.bottom() > 0 && targetMargins.right() > 0 && sourceMargins.bottom() > 0 && sourceMargins.right() > 0) { // bottom right
d.x = (0.5 * (xTarget[columns] + xTarget[columns - 1]));
d.y = (0.5 * (yTarget[rows] + yTarget[rows - 1]));
d.sourceLeft = sourceCenterRight;
d.sourceTop = sourceCenterBottom;
d.width = sourceMargins.right();
d.height = sourceMargins.bottom();
d.scaleX = qreal(xTarget[columns] - xTarget[columns - 1]) / d.width;
d.scaleY = qreal(yTarget[rows] - yTarget[rows - 1]) / d.height;
if (hints & QDrawBorderPixmap::OpaqueBottomRight)
opaqueData.append(d);
else
translucentData.append(d);
}
// horizontal edges
if (targetCenterWidth > 0 && sourceCenterWidth > 0) {
if (targetMargins.top() > 0 && sourceMargins.top() > 0) { // top
QPixmapFragmentsArray &data = hints & QDrawBorderPixmap::OpaqueTop ? opaqueData : translucentData;
d.sourceLeft = sourceCenterLeft;
d.sourceTop = sourceRect.top();
d.width = sourceCenterWidth;
d.height = sourceMargins.top();
d.y = (0.5 * (yTarget[1] + yTarget[0]));
d.scaleX = dx / d.width;
d.scaleY = qreal(yTarget[1] - yTarget[0]) / d.height;
for (int i = 1; i < columns - 1; ++i) {
d.x = (0.5 * (xTarget[i + 1] + xTarget[i]));
data.append(d);
}
if (rules.horizontal == Qt::RepeatTile)
data[data.size() - 1].width = ((xTarget[columns - 1] - xTarget[columns - 2]) / d.scaleX);
}
if (targetMargins.bottom() > 0 && sourceMargins.bottom() > 0) { // bottom
QPixmapFragmentsArray &data = hints & QDrawBorderPixmap::OpaqueBottom ? opaqueData : translucentData;
d.sourceLeft = sourceCenterLeft;
d.sourceTop = sourceCenterBottom;
d.width = sourceCenterWidth;
d.height = sourceMargins.bottom();
d.y = (0.5 * (yTarget[rows] + yTarget[rows - 1]));
d.scaleX = dx / d.width;
d.scaleY = qreal(yTarget[rows] - yTarget[rows - 1]) / d.height;
for (int i = 1; i < columns - 1; ++i) {
d.x = (0.5 * (xTarget[i + 1] + xTarget[i]));
data.append(d);
}
if (rules.horizontal == Qt::RepeatTile)
data[data.size() - 1].width = ((xTarget[columns - 1] - xTarget[columns - 2]) / d.scaleX);
}
}
// vertical edges
if (targetCenterHeight > 0 && sourceCenterHeight > 0) {
if (targetMargins.left() > 0 && sourceMargins.left() > 0) { // left
QPixmapFragmentsArray &data = hints & QDrawBorderPixmap::OpaqueLeft ? opaqueData : translucentData;
d.sourceLeft = sourceRect.left();
d.sourceTop = sourceCenterTop;
d.width = sourceMargins.left();
d.height = sourceCenterHeight;
d.x = (0.5 * (xTarget[1] + xTarget[0]));
d.scaleX = qreal(xTarget[1] - xTarget[0]) / d.width;
d.scaleY = dy / d.height;
for (int i = 1; i < rows - 1; ++i) {
d.y = (0.5 * (yTarget[i + 1] + yTarget[i]));
data.append(d);
}
if (rules.vertical == Qt::RepeatTile)
data[data.size() - 1].height = ((yTarget[rows - 1] - yTarget[rows - 2]) / d.scaleY);
}
if (targetMargins.right() > 0 && sourceMargins.right() > 0) { // right
QPixmapFragmentsArray &data = hints & QDrawBorderPixmap::OpaqueRight ? opaqueData : translucentData;
d.sourceLeft = sourceCenterRight;
d.sourceTop = sourceCenterTop;
d.width = sourceMargins.right();
d.height = sourceCenterHeight;
d.x = (0.5 * (xTarget[columns] + xTarget[columns - 1]));
d.scaleX = qreal(xTarget[columns] - xTarget[columns - 1]) / d.width;
d.scaleY = dy / d.height;
for (int i = 1; i < rows - 1; ++i) {
d.y = (0.5 * (yTarget[i + 1] + yTarget[i]));
data.append(d);
}
if (rules.vertical == Qt::RepeatTile)
data[data.size() - 1].height = ((yTarget[rows - 1] - yTarget[rows - 2]) / d.scaleY);
}
}
// center
if (targetCenterWidth > 0 && targetCenterHeight > 0 && sourceCenterWidth > 0 && sourceCenterHeight > 0) {
QPixmapFragmentsArray &data = hints & QDrawBorderPixmap::OpaqueCenter ? opaqueData : translucentData;
d.sourceLeft = sourceCenterLeft;
d.sourceTop = sourceCenterTop;
d.width = sourceCenterWidth;
d.height = sourceCenterHeight;
d.scaleX = dx / d.width;
d.scaleY = dy / d.height;
qreal repeatWidth = (xTarget[columns - 1] - xTarget[columns - 2]) / d.scaleX;
qreal repeatHeight = (yTarget[rows - 1] - yTarget[rows - 2]) / d.scaleY;
for (int j = 1; j < rows - 1; ++j) {
d.y = (0.5 * (yTarget[j + 1] + yTarget[j]));
for (int i = 1; i < columns - 1; ++i) {
d.x = (0.5 * (xTarget[i + 1] + xTarget[i]));
data.append(d);
}
if (rules.horizontal == Qt::RepeatTile)
data[data.size() - 1].width = repeatWidth;
}
if (rules.vertical == Qt::RepeatTile) {
for (int i = 1; i < columns - 1; ++i)
data[data.size() - i].height = repeatHeight;
}
}
if (opaqueData.size())
painter->drawPixmapFragments(opaqueData.data(), opaqueData.size(), pixmap, QPainter::OpaqueHint);
if (translucentData.size())
painter->drawPixmapFragments(translucentData.data(), translucentData.size(), pixmap);
if (oldAA)
painter->setRenderHint(QPainter::Antialiasing, true);
}
QT_END_NAMESPACE