Union::Properties::DisplayPropertyGroup Class

Member Function Documentation

DisplayPropertyGroup::DisplayPropertyGroup()

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.

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

Copy constructor.

DisplayPropertyGroup::DisplayPropertyGroup(Union::Properties::DisplayPropertyGroup &&other)

Move constructor.

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

Create and return an empty DisplayPropertyGroup instance.

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

std::optional<qreal> DisplayPropertyGroup::opacity() const

The opacity of the element.

See also setOpacity().

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

void DisplayPropertyGroup::setOpacity(const std::optional<qreal> &newValue)

Set the value of opacity.

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

See also opacity().

void DisplayPropertyGroup::setVisible(const std::optional<bool> &newValue)

Set the value of visible.

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

See also visible().

QString DisplayPropertyGroup::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.

std::optional<bool> DisplayPropertyGroup::visible() const

Whether the element should be shown or hidden.

See also setVisible().

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

Move assignment operator.

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

Copy assignment operator.