Union::Properties::CornersPropertyGroup Class

class Union::Properties::CornersPropertyGroup

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

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

Public Functions

CornersPropertyGroup()
CornersPropertyGroup(const Union::Properties::CornersPropertyGroup &other)
CornersPropertyGroup(Union::Properties::CornersPropertyGroup &&other)
Union::Properties::CornerPropertyGroup *bottomLeft() const
Union::Properties::CornerPropertyGroup *bottomRight() const
bool hasAnyValue() const
bool isEmpty() const
Union::Properties::CornersPropertyGroup::CornerRadii radii() const
T safePropertyLookup(const T &defaultValue, LookupFunctions... functions) const
void setBottomLeft(std::unique_ptr<Union::Properties::CornerPropertyGroup> &&newValue)
void setBottomRight(std::unique_ptr<Union::Properties::CornerPropertyGroup> &&newValue)
void setTopLeft(std::unique_ptr<Union::Properties::CornerPropertyGroup> &&newValue)
void setTopRight(std::unique_ptr<Union::Properties::CornerPropertyGroup> &&newValue)
QString toString(int indentation = 0, Union::Properties::ToStringFlags flags = ToStringFlags{}) const
Union::Properties::CornerPropertyGroup *topLeft() const
Union::Properties::CornerPropertyGroup *topRight() const
Union::Properties::CornersPropertyGroup &operator=(Union::Properties::CornersPropertyGroup &&other)
Union::Properties::CornersPropertyGroup &operator=(const Union::Properties::CornersPropertyGroup &other)

Static Public Members

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

Detailed Description

Member Function Documentation

CornersPropertyGroup::CornersPropertyGroup()

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.

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

Copy constructor.

CornersPropertyGroup::CornersPropertyGroup(Union::Properties::CornersPropertyGroup &&other)

Move constructor.

Union::Properties::CornerPropertyGroup *CornersPropertyGroup::bottomLeft() const

A property group containing the properties of a corner.

See also setBottomLeft().

Union::Properties::CornerPropertyGroup *CornersPropertyGroup::bottomRight() const

A property group containing the properties of a corner.

See also setBottomRight().

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

Create and return an empty CornersPropertyGroup instance.

This will create an empty CornersPropertyGroup 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 CornersPropertyGroup::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 CornersPropertyGroup::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::CornersPropertyGroup::CornerRadii CornersPropertyGroup::radii() const

Returns the radii of all corners

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

template <typename T, typename... LookupFunctions> requires (std::is_member_function_pointer_v<LookupFunctions> && ...) T CornersPropertyGroup::safePropertyLookup(const T &defaultValue, LookupFunctions... functions) const

Perform safe property lookup of a property or the property of a subgroup.

This should be called with a list of property getter pointer-to-member functions in functions that indicate which properties to access. Each subgroup access will be checked to make sure the subgroup exists. If any of them does not exist, defaultValue will be returned. The final property lookup can be any member function of the final group. If that returns a pointer or std::optional<>, it is checked to see if it has a value. If it does, that value is returned. If not, defaultValue is returned. For functions returning anything else, the value returned by the function is returned.

Example usage:

// Lookup the value of the property "spacing" of the "layout" group.
auto spacing = StylePropertyGroup->safePropertyLookup(0.0, &StylePropertyGroup::layout, &LayoutPropertyGroup::spacing);

void CornersPropertyGroup::setBottomLeft(std::unique_ptr<Union::Properties::CornerPropertyGroup> &&newValue)

Set the value of bottomLeft.

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

See also bottomLeft().

void CornersPropertyGroup::setBottomRight(std::unique_ptr<Union::Properties::CornerPropertyGroup> &&newValue)

Set the value of bottomRight.

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

See also bottomRight().

void CornersPropertyGroup::setTopLeft(std::unique_ptr<Union::Properties::CornerPropertyGroup> &&newValue)

Set the value of topLeft.

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

See also topLeft().

void CornersPropertyGroup::setTopRight(std::unique_ptr<Union::Properties::CornerPropertyGroup> &&newValue)

Set the value of topRight.

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

See also topRight().

QString CornersPropertyGroup::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::CornerPropertyGroup *CornersPropertyGroup::topLeft() const

A property group containing the properties of a corner.

See also setTopLeft().

Union::Properties::CornerPropertyGroup *CornersPropertyGroup::topRight() const

A property group containing the properties of a corner.

See also setTopRight().

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

Move assignment operator.

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

Copy assignment operator.

Related Non-Members

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

QDebug support for CornersPropertyGroup.

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

Equality comparison for CornersPropertyGroup.