ColorDecorator Class Reference

#include <ColorDecorator.hpp>

Inheritance diagram for ColorDecorator:

Public Types
enum class	Color : int {   White , Red , Green , Blue ,   Cyan , Magenta , Yellow , Black ,   Custom }

Public Member Functions
Color	color () const
const vector< double > &	rgb () const
Public Member Functions inherited from ShapeDecorator
Shape *	shape () const
Public Member Functions inherited from ShapeItem
virtual void	paint ()
Public Member Functions inherited from Item
	Item (const Item &)=delete
virtual	~Item ()
void	addChild (Item *child)
const vector< Item * > &	children () const
virtual void	clearItemListProperty (const PropertyDef *property)
void	destroyChild (Item *child)
virtual bool	getBoolProperty (const PropertyDef *property) const
virtual vector< double >	getDoubleListProperty (const PropertyDef *property) const
virtual double	getDoubleProperty (const PropertyDef *property) const
virtual string	getEnumProperty (const PropertyDef *property) const
virtual int	getIntProperty (const PropertyDef *property) const
virtual vector< Item * >	getItemListProperty (const PropertyDef *property) const
virtual Item *	getItemProperty (const PropertyDef *property) const
virtual string	getStringProperty (const PropertyDef *property) const
int	getUtilityProperty (string name) const
virtual void	insertIntoItemListProperty (const PropertyDef *property, int index, Item *item)
Item &	operator= (const Item &)=delete
Item *	parent () const
virtual void	removeFromItemListProperty (const PropertyDef *property, int index)
virtual void	setBoolProperty (const PropertyDef *property, bool value)
virtual void	setDoubleListProperty (const PropertyDef *property, vector< double > value)
virtual void	setDoubleProperty (const PropertyDef *property, double value)
virtual void	setEnumProperty (const PropertyDef *property, string value)
virtual void	setIntProperty (const PropertyDef *property, int value)
virtual void	setItemProperty (const PropertyDef *property, Item *item)
virtual void	setStringProperty (const PropertyDef *property, string value)
void	setUtilityProperty (string name, int value)
virtual string	type () const

Protected Member Functions
	ColorDecorator ()
void	paintSelf () override
Protected Member Functions inherited from ShapeDecorator
	ShapeDecorator ()
Protected Member Functions inherited from Shape
	Shape ()
Protected Member Functions inherited from ShapeItem
	ShapeItem ()
virtual void	drawLine (double x1, double y1, double x2, double y2)
virtual void	paintSelf ()
virtual void	popState ()
virtual void	pushState ()
virtual void	setColor (double r, double g, double b)
virtual void	setWidth (double w)
Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType = ShapeDecorator
using	ItemType = ColorDecorator

Private Attributes
Color	_color
vector< double >	_rgb

Friends
class	ItemRegistry

Detailed Description

The ColorDecorator class represents a decorator that sets the color for the shape or group of shapes being decorated.

Member Enumeration Documentation

Color

enum class ColorDecorator::Color : int

strong

This enumeration lists the colors supported by the ColorDecorator. Select 'Custom' to allow specifying arbitrary red, green, and blue intensities.

White : "the white color" .

Red : "the red color" .

Green : "the green color" .

Blue : "the blue color" .

Cyan : "the cyan color" .

Magenta : "the magenta color" .

Yellow : "the yellow color" .

Black : "the black color" .

Custom : "a custom RGB color" .

Constructor & Destructor Documentation

ColorDecorator()

ColorDecorator::ColorDecorator ( )

inlineprotected

Default constructor for concrete Item subclass ColorDecorator : "a decorator that sets the color of a shape or group of shapes" .

Member Function Documentation

color()

Color ColorDecorator::color ( ) const

inline

This function returns the value of the discoverable Color enumeration property color : "the color of the decorated shape or group of shapes" .

paintSelf()

void ColorDecorator::paintSelf ( )

overrideprotectedvirtual

This function sets the line width in the current graphics state by calling the setColor() function.

Reimplemented from ShapeItem.

rgb()

ColorDecorator::rgb ( ) const

inline

This function returns the value of the discoverable double list property rgb : "the red, green, blue intensities of the decorated shape or group of shapes" .

The minimum value for this property is "0" .

The maximum value for this property is "1" .

The default value for this property is given by the conditional value expression "0.5, 0.5, 0.5" .

This property is relevant only if the Boolean expression "colorCustom" evaluates to true after replacing the names by true or false depending on their presence.

---

The documentation for this class was generated from the following file:

• ColorDecorator.hpp