class BackgroundPropertyHandler

Property handler for background properties.

Public Types

enum PropertyKey

List of property keys for BackgroundPropertyHandler.



Color for single background coloring.


Top background color for gradient background coloring.


Bottom background color for gradient background coloring.

Public Functions

BackgroundPropertyHandler(PropertySet *propSet)

Creates a background property handler from a given property set propSet.

Variant propertyValue(PropertyKey key) const

Returns the property value for the specified property key.

Returns an empty Variant if the property key was not found.

void setPropertyValue(PropertyKey key, Variant data)

Sets the property key and value to this handlers property set.

If key exists in the property set, the paired property value is updated to data. Otherwise the key/value pair is added to the property set.

void applyToBackground(vis::Background *background) const

Applies the properties in this property set to the specified background.

void buildProperties(const vis::Background &background)

Sets the property keys and values for this property set from the background.

Public Static Functions

static Str propertySetClassType()

Returns the class type of the property set.

static bool isValidPropertySet(const PropertySet &propSet)

Returns true if the specified property set is a valid background property set.