Union::Properties::BorderPropertyGroup Class

class Union::Properties::BorderPropertyGroup

A property group containing properties of an element's border. More...

Header: #include <BorderPropertyGroup.h>
CMake: find_package(Union REQUIRED)
target_link_libraries(mytarget PRIVATE Union::Union)

Public Functions

BorderPropertyGroup()
BorderPropertyGroup(const Union::Properties::BorderPropertyGroup &other)
BorderPropertyGroup(Union::Properties::BorderPropertyGroup &&other)
Union::Properties::LinePropertyGroup *bottom() const
bool hasAnyValue() const
bool isEmpty() const
Union::Properties::LinePropertyGroup *left() const
Union::Properties::LinePropertyGroup *right() const
void setBottom(std::unique_ptr<Union::Properties::LinePropertyGroup> &&newValue)
void setLeft(std::unique_ptr<Union::Properties::LinePropertyGroup> &&newValue)
void setRight(std::unique_ptr<Union::Properties::LinePropertyGroup> &&newValue)
void setTop(std::unique_ptr<Union::Properties::LinePropertyGroup> &&newValue)
QMarginsF sizes() const
QString toString(int indentation = 0, Union::Properties::ToStringFlags flags = ToStringFlags{}) const
Union::Properties::LinePropertyGroup *top() const
Union::Properties::BorderPropertyGroup &operator=(Union::Properties::BorderPropertyGroup &&other)
Union::Properties::BorderPropertyGroup &operator=(const Union::Properties::BorderPropertyGroup &other)

Static Public Members

std::unique_ptr<Union::Properties::BorderPropertyGroup> empty()
void resolveProperties(const Union::Properties::BorderPropertyGroup *source, Union::Properties::BorderPropertyGroup *destination)
QDebug operator<<(QDebug debug, Union::Properties::BorderPropertyGroup *type)
bool operator==(const Union::Properties::BorderPropertyGroup &left, const Union::Properties::BorderPropertyGroup &right)

Detailed Description

Member Function Documentation

BorderPropertyGroup::BorderPropertyGroup()

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.

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

Copy constructor.

BorderPropertyGroup::BorderPropertyGroup(Union::Properties::BorderPropertyGroup &&other)

Move constructor.

Union::Properties::LinePropertyGroup *BorderPropertyGroup::bottom() const

A property group containing the properties of a line.

See also setBottom().

[static] std::unique_ptr<Union::Properties::BorderPropertyGroup> BorderPropertyGroup::empty()

Create and return an empty BorderPropertyGroup instance.

This will create an empty BorderPropertyGroup 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 BorderPropertyGroup::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.

bool BorderPropertyGroup::isEmpty() const

Returns if this property is considered empty.

A property is considered empty if it has no values or if the values it contains are all considered empty values.

Union::Properties::LinePropertyGroup *BorderPropertyGroup::left() const

A property group containing the properties of a line.

See also setLeft().

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

A property group containing the properties of a line.

See also setRight().

void BorderPropertyGroup::setBottom(std::unique_ptr<Union::Properties::LinePropertyGroup> &&newValue)

Set the value of bottom.

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

See also bottom().

void BorderPropertyGroup::setLeft(std::unique_ptr<Union::Properties::LinePropertyGroup> &&newValue)

Set the value of left.

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

See also left().

void BorderPropertyGroup::setRight(std::unique_ptr<Union::Properties::LinePropertyGroup> &&newValue)

Set the value of right.

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

See also right().

void BorderPropertyGroup::setTop(std::unique_ptr<Union::Properties::LinePropertyGroup> &&newValue)

Set the value of top.

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

See also top().

QMarginsF BorderPropertyGroup::sizes() const

Returns the size of all borders

QString BorderPropertyGroup::toString(int indentation = 0, Union::Properties::ToStringFlags flags = ToStringFlags{}) const

Returns a string representation of this property group.

This is intended for debugging.

indentation The amount of indentation to apply. Defaults to 0. flags A set of flags that control conversion behavior.

Union::Properties::LinePropertyGroup *BorderPropertyGroup::top() const

A property group containing the properties of a line.

See also setTop().

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

Move assignment operator.

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

Copy assignment operator.

Related Non-Members

QDebug operator<<(QDebug debug, Union::Properties::BorderPropertyGroup *type)

QDebug support for BorderPropertyGroup.

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

Equality comparison for BorderPropertyGroup.