Union::Properties::BorderProperty Class

class Union::Properties::BorderProperty

A property group containing properties of a background's border. More...

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

Public Functions

BorderProperty()
BorderProperty(const Union::Properties::BorderProperty &other)
BorderProperty(Union::Properties::BorderProperty &&other)
std::optional<Union::Properties::LineProperty> bottom() const
bool hasAnyValue() const
std::optional<Union::Properties::LineProperty> left() const
std::optional<Union::Properties::LineProperty> right() const
void setBottom(const std::optional<Union::Properties::LineProperty> &newValue)
void setLeft(const std::optional<Union::Properties::LineProperty> &newValue)
void setRight(const std::optional<Union::Properties::LineProperty> &newValue)
void setTop(const std::optional<Union::Properties::LineProperty> &newValue)
std::optional<Union::Properties::LineProperty> top() const
Union::Properties::BorderProperty &operator=(Union::Properties::BorderProperty &&other)
Union::Properties::BorderProperty &operator=(const Union::Properties::BorderProperty &other)

Static Public Members

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

Detailed Description

Member Function Documentation

BorderProperty::BorderProperty()

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.

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

Copy constructor.

BorderProperty::BorderProperty(Union::Properties::BorderProperty &&other)

Move constructor.

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

Returns the value of bottom.

See also setBottom().

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

Create and return an empty BorderProperty instance.

This will create an empty BorderProperty 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 BorderProperty::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> BorderProperty::left() const

Returns the value of left.

See also setLeft().

[static] void BorderProperty::resolveProperties(const Union::Properties::BorderProperty &source, Union::Properties::BorderProperty &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 BorderProperty::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 BorderProperty::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 BorderProperty::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 BorderProperty::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().

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

Returns the value of top.

See also setTop().

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

Move assignment operator.

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

Copy assignment operator.

Related Non-Members

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

QDebug support for BorderProperty.

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

Equality comparison for BorderProperty.