Union::Properties::ShadowProperty Class

class Union::Properties::ShadowProperty

A property group containing properties relating to an element's shadow. More...

Header: #include <ShadowProperty>
CMake: find_package(Union REQUIRED)
target_link_libraries(mytarget PRIVATE Union::Union)

Public Functions

ShadowProperty()
ShadowProperty(const Union::Properties::ShadowProperty &other)
ShadowProperty(Union::Properties::ShadowProperty &&other)
std::optional<Union::Properties::LineProperty> bottom() const
std::optional<Union::Properties::CornerProperty> bottomLeft() const
std::optional<Union::Properties::CornerProperty> bottomRight() const
bool hasAnyValue() const
std::optional<Union::Properties::LineProperty> left() const
std::optional<Union::Properties::SizeProperty> offsets() const
std::optional<Union::Properties::LineProperty> right() const
void setBottom(const std::optional<Union::Properties::LineProperty> &newValue)
void setBottomLeft(const std::optional<Union::Properties::CornerProperty> &newValue)
void setBottomRight(const std::optional<Union::Properties::CornerProperty> &newValue)
void setLeft(const std::optional<Union::Properties::LineProperty> &newValue)
void setOffsets(const std::optional<Union::Properties::SizeProperty> &newValue)
void setRight(const std::optional<Union::Properties::LineProperty> &newValue)
void setTop(const std::optional<Union::Properties::LineProperty> &newValue)
void setTopLeft(const std::optional<Union::Properties::CornerProperty> &newValue)
void setTopRight(const std::optional<Union::Properties::CornerProperty> &newValue)
std::optional<Union::Properties::LineProperty> top() const
std::optional<Union::Properties::CornerProperty> topLeft() const
std::optional<Union::Properties::CornerProperty> topRight() const
Union::Properties::ShadowProperty &operator=(Union::Properties::ShadowProperty &&other)
Union::Properties::ShadowProperty &operator=(const Union::Properties::ShadowProperty &other)

Static Public Members

Union::Properties::ShadowProperty empty()
void resolveProperties(const Union::Properties::ShadowProperty &source, Union::Properties::ShadowProperty &destination)
QDebug operator<<(QDebug debug, const Union::Properties::ShadowProperty &type)
bool operator==(const Union::Properties::ShadowProperty &left, const Union::Properties::ShadowProperty &right)

Detailed Description

Member Function Documentation

ShadowProperty::ShadowProperty()

Default constructor. Constructs a null instance.

A null instance in this case means an instance that does not have any values for its properties. This includes property groups.

ShadowProperty::ShadowProperty(const Union::Properties::ShadowProperty &other)

Copy constructor.

ShadowProperty::ShadowProperty(Union::Properties::ShadowProperty &&other)

Move constructor.

std::optional<Union::Properties::LineProperty> ShadowProperty::bottom() const

Returns the value of bottom.

See also setBottom().

std::optional<Union::Properties::CornerProperty> ShadowProperty::bottomLeft() const

Returns the value of bottomLeft.

See also setBottomLeft().

std::optional<Union::Properties::CornerProperty> ShadowProperty::bottomRight() const

Returns the value of bottomRight.

See also setBottomRight().

[static] Union::Properties::ShadowProperty ShadowProperty::empty()

Create and return an empty ShadowProperty instance.

This will create an empty ShadowProperty instance, which is defined as an instance with all of its values default-constructed. Note that this is different from a default-constructed instance which will have all its values unset.

bool ShadowProperty::hasAnyValue() const

Returns if this property group has any value set.

Note that for any property that is also a property group, this will also check if that group has any value.

std::optional<Union::Properties::LineProperty> ShadowProperty::left() const

Returns the value of left.

See also setLeft().

std::optional<Union::Properties::SizeProperty> ShadowProperty::offsets() const

Returns the value of offsets.

See also setOffsets().

[static] void ShadowProperty::resolveProperties(const Union::Properties::ShadowProperty &source, Union::Properties::ShadowProperty &destination)

Copy property values from source to destination if destination does not have a property value.

This will recursively copy property values of grouped properties.

source The source property group to copy from. destination The destination property group to copy to.

Returns the value of right.

See also setRight().

void ShadowProperty::setBottom(const std::optional<Union::Properties::LineProperty> &newValue)

Set the value of bottom.

newValue The new value or std::nullopt to unset the value.

See also bottom().

void ShadowProperty::setBottomLeft(const std::optional<Union::Properties::CornerProperty> &newValue)

Set the value of bottomLeft.

newValue The new value or std::nullopt to unset the value.

See also bottomLeft().

void ShadowProperty::setBottomRight(const std::optional<Union::Properties::CornerProperty> &newValue)

Set the value of bottomRight.

newValue The new value or std::nullopt to unset the value.

See also bottomRight().

void ShadowProperty::setLeft(const std::optional<Union::Properties::LineProperty> &newValue)

Set the value of left.

newValue The new value or std::nullopt to unset the value.

See also left().

void ShadowProperty::setOffsets(const std::optional<Union::Properties::SizeProperty> &newValue)

Set the value of offsets.

newValue The new value or std::nullopt to unset the value.

See also offsets().

void ShadowProperty::setRight(const std::optional<Union::Properties::LineProperty> &newValue)

Set the value of right.

newValue The new value or std::nullopt to unset the value.

See also right().

void ShadowProperty::setTop(const std::optional<Union::Properties::LineProperty> &newValue)

Set the value of top.

newValue The new value or std::nullopt to unset the value.

See also top().

void ShadowProperty::setTopLeft(const std::optional<Union::Properties::CornerProperty> &newValue)

Set the value of topLeft.

newValue The new value or std::nullopt to unset the value.

See also topLeft().

void ShadowProperty::setTopRight(const std::optional<Union::Properties::CornerProperty> &newValue)

Set the value of topRight.

newValue The new value or std::nullopt to unset the value.

See also topRight().

std::optional<Union::Properties::LineProperty> ShadowProperty::top() const

Returns the value of top.

See also setTop().

std::optional<Union::Properties::CornerProperty> ShadowProperty::topLeft() const

Returns the value of topLeft.

See also setTopLeft().

std::optional<Union::Properties::CornerProperty> ShadowProperty::topRight() const

Returns the value of topRight.

See also setTopRight().

Union::Properties::ShadowProperty &ShadowProperty::operator=(Union::Properties::ShadowProperty &&other)

Move assignment operator.

Union::Properties::ShadowProperty &ShadowProperty::operator=(const Union::Properties::ShadowProperty &other)

Copy assignment operator.

Related Non-Members

QDebug operator<<(QDebug debug, const Union::Properties::ShadowProperty &type)

QDebug support for ShadowProperty.

bool operator==(const Union::Properties::ShadowProperty &left, const Union::Properties::ShadowProperty &right)

Equality comparison for ShadowProperty.