QCBoxShadow Class

Member Function Documentation

QCBoxShadow::QCBoxShadow()

Constructs a default box shadow. The box shadow position is (0, 0) and size (100, 100). Shadow corner radius is 0.0 and blur 0.0. Shadow color is Qt::black.

QCBoxShadow::QCBoxShadow(const QRectF &rect, float radius = 0.0f, float blur = 0.0f, const QColor &color = QColorConstants::Black)

Constructs a box shadow. The box shadow position and size are defined by rect. Shadow corner radius is radius and blur blur. Shadow color is color.

QCBoxShadow::QCBoxShadow(float x, float y, float width, float height, float radius = 0.0f, float blur = 0.0f, const QColor &color = QColorConstants::Black)

Constructs a box shadow. The box shadow position is x, y and size width, height. Shadow corner radius is radius and blur blur. Shadow color is color.

[noexcept] QCBoxShadow::QCBoxShadow(const QCBoxShadow &shadow)

Constructs a box shadow that is a copy of the given shadow.

[constexpr noexcept] QCBoxShadow::QCBoxShadow(QCBoxShadow &&other)

Move-constructs a new QCBoxShadow from other.

[virtual noexcept] QCBoxShadow::~QCBoxShadow()

Destroys the box shadow.

float QCBoxShadow::blur() const

Returns the blur of shadow box.

See also setBlur().

float QCBoxShadow::bottomLeftRadius() const

Returns the bottom-left radius of shadow box. When this is -1, painting of the shadow will use the value of radius() for this corner. The default value is -1.

See also setBottomLeftRadius().

float QCBoxShadow::bottomRightRadius() const

Returns the bottom-right radius of shadow box. When this is -1, painting of the shadow will use the value of radius() for this corner. The default value is -1.

See also setBottomRightRadius().

QRectF QCBoxShadow::boundingRect() const

Returns the area covered by the shadow. This takes into account the shadow rect(), blur() and spread(). If you don't want to use QCPainter::drawBoxShadow() helper method, this can be used to for e.g. adding correctly sized QCPainter::rect() into the path.

See also setRect(), setBlur(), and setSpread().

QColor QCBoxShadow::color() const

Returns the color of shadow box.

See also setColor().

float QCBoxShadow::radius() const

Returns the radius of shadow box.

See also setRadius().

QRectF QCBoxShadow::rect() const

Returns the rect area of shadow box.

See also setRect().

void QCBoxShadow::setBlur(float blur)

Sets the shadow blur to blur in pixels. The default value is 0.0 meaning no blur.

See also blur().

void QCBoxShadow::setBottomLeftRadius(float radius)

Sets the bottom-left corner radius to radius. The default value is -1 which means that individual radius has not been set for this corner, and common radius() is used instead.

See also bottomLeftRadius().

void QCBoxShadow::setBottomRightRadius(float radius)

Sets the bottom-right corner radius to radius. The default value is -1 which means that individual radius has not been set for this corner, and common radius() is used instead.

See also bottomRightRadius().

void QCBoxShadow::setColor(const QColor &color)

Sets the shadow color to color. The default value is black with full opacity.

See also color().

void QCBoxShadow::setRadius(float radius)

Sets the shadow corner radius to radius in pixels. The default value is 0.0 meaning no radius.

See also radius().

void QCBoxShadow::setRect(const QRectF &rect)

Sets the rect area of shadow box to rect.

See also rect().

void QCBoxShadow::setRect(float x, float y, float width, float height)

Sets the rect area of shadow box to (x, y, width, height).

See also rect().

void QCBoxShadow::setSpread(float spread)

Sets the shadow spread to spread in pixels. The default value is 0.0 meaning no spread.

See also spread().

void QCBoxShadow::setTopLeftRadius(float radius)

Sets the top-left corner radius to radius. The default value is -1 which means that individual radius has not been set for this corner, and common radius() is used instead.

See also topLeftRadius().

void QCBoxShadow::setTopRightRadius(float radius)

Sets the top-right corner radius to radius. The default value is -1 which means that individual radius has not been set for this corner, and common radius() is used instead.

See also topRightRadius().

float QCBoxShadow::spread() const

Returns the spread of shadow box.

See also setSpread().

[noexcept] void QCBoxShadow::swap(QCBoxShadow &other)

Swaps this other with other. This operation is very fast and never fails.

float QCBoxShadow::topLeftRadius() const

Returns the top-left radius of shadow box. When this is -1, painting of the shadow will use the value of radius() for this corner. The default value is -1.

See also setTopLeftRadius().

float QCBoxShadow::topRightRadius() const

Returns the top-right radius of shadow box. When this is -1, painting of the shadow will use the value of radius() for this corner. The default value is -1.

See also setTopRightRadius().

[override virtual] QCBrush::BrushType QCBoxShadow::type() const

Reimplements: QCBrush::type() const.

Returns the type of brush, QCBrush::BrushType::BoxShadow.

QVariant QCBoxShadow::operator QVariant() const

Returns the box shadow as a QVariant.

bool QCBoxShadow::operator!=(const QCBoxShadow &shadow) const

Returns true if the box shadow is different from the given shadow; otherwise false.

See also operator==().

[noexcept] QCBoxShadow &QCBoxShadow::operator=(QCBoxShadow &&other)

Move-assigns other to this QCBoxShadow instance.

[noexcept] QCBoxShadow &QCBoxShadow::operator=(const QCBoxShadow &shadow)

Assigns the given shadow to this shadow and returns a reference to this box shadow.

bool QCBoxShadow::operator==(const QCBoxShadow &shadow) const

Returns true if the box shadow is equal to the given shadow; otherwise false.

See also operator!=().