hdi::core::FillStyleMapPref Class Reference

Allows for storage of fill style maps. More...

#include <hdicoreFillStyleMapPref.h>

Inheritance diagram for hdi::core::FillStyleMapPref:

Collaboration diagram for hdi::core::FillStyleMapPref:

Public Member Functions
	FillStyleMapPref ()
	Constructs an empty FillStyleMapPref object.
	FillStyleMapPref (const FillStyleMapPref &fs_)
	Constructs a new FillStyleMapPref object from an existing FillStyleMapPref object (copy constructor)
	FillStyleMapPref (const FillStyle::Map &value_, const std::string &name_="")
	Constructs a FillStyleMapPref object, with new data, to be added to a container at a later time.
virtual	~FillStyleMapPref ()
	Destructs a FillStyleMapPref object.
virtual FillStyleMapPref &	operator= (const FillStyleMapPref &rhs_)
	Allows one FillStyleMapPref object to be assigned from another.
virtual FillStyleMapPref *	clone () const
	Convenience method to clone an FillStyleMapPref object on the heap.
virtual Type	dataType () const
	Gets the type of persistent data.
virtual FillStyle::Map	fillStyleMap () const
	Gets the fill style map value for this object.
virtual bool	setFillStyleMap (const FillStyle::Map &value_)
	Sets the fill style map value for this object.
Public Member Functions inherited from hdi::core::PrefData
	PrefData ()
	Constructs an empty PrefData object.
virtual	~PrefData ()
	Destructs a PrefData object.
virtual PrefData &	operator= (const PrefData &rhs_)
	Allows one PrefData object to be assigned from another.
virtual PrefData *	clone () const =0
	Convenience method to clone a PrefData object, taking its subclass type into account for proper memory management.
virtual bool	isEmpty () const
	Gets whether the target PrefData object is empty (constructed with the default ctor)
virtual bool	operator== (const PrefData &rhs_) const
	Tests whether a given PrefData object is the same as another.
virtual bool	operator!= (const PrefData &rhs_) const
	Tests whether a given PrefData object is not the same as another.
virtual Type	dataType () const
	Gets the type of persistent data.
virtual std::string	key () const
	Gets the persistent data object's key.
virtual void	setKey (const std::string &key_)
	Sets the persistent data object's key.
virtual std::string	stringify () const
	Recursively serializes the target object as a JSON data (sub)tree, returning the appropriate JSON string.

Friends
class	PathStyleMapPref

Additional Inherited Members
Public Types inherited from hdi::core::PrefData
enum	Type {   UnknownType = 0 , ArrayType = 10 , ArtboardPointType = 20 , ArtboardRectType = 30 ,   ArtColorType = 40 , BoolType = 50 , ColorType = 60 , DashStyleType = 70 ,   DashStyleMapType = 80 , DictionaryType = 90 , FillStyleType = 100 , FillStyleMapType = 110 ,   FontType = 120 , NumberType = 130 , PathType = 140 , PathStyleType = 150 ,   PathStyleMapType = 160 , PointType = 170 , RectType = 180 , SizeType = 190 ,   StringType = 200 , StrokeStyleType = 210 , StrokeStyleMapType = 220 , TransformMatrixType = 230 ,   CustomTypeOffset = 10000 }
	Describes the type of the data the PrefData object contains; useful for determining which subclass to cast a PrefData object to.
Static Public Member Functions inherited from hdi::core::PrefData
static std::unique_ptr< PrefData >	parse (const std::string &jsonStr_)
	Parses the given JSON string to a best-fit representation of PrefData subclass objects in a tree.
Protected Member Functions inherited from hdi::core::PrefData
void *	__impl () const
	Internal use only.
	PrefData (plat::PersistentData *&)
	Internal use only.
	PrefData (const PrefData &data_)
	Constructs a new PrefData object from an existing PrefData object (copy constructor)
Protected Attributes inherited from hdi::core::PrefData
void *	_data
	Private implementation data.

Detailed Description

Allows for storage of fill style maps.

Constructor & Destructor Documentation

FillStyleMapPref() [1/3]

hdi::core::FillStyleMapPref::FillStyleMapPref

(

)

Constructs an empty FillStyleMapPref object.

Author

GW

Date

11/2015

Note

To test if a FillStyleMapPref object is empty, call isEmpty() on it

Empty FillStyleMapPref objects do not relate to any actual preference data; they are designed to be "receivers" of some other FillStyleMapPref object via the overloaded assignment operator. Empty FillStyleMapPref objects are useless until such time (though it is safe to call any of their methods)

FillStyleMapPref() [2/3]

hdi::core::FillStyleMapPref::FillStyleMapPref

(

const FillStyleMapPref &

fs_

)

Constructs a new FillStyleMapPref object from an existing FillStyleMapPref object (copy constructor)

Author

GW

Date

11/2015

Parameters

fs_	Existing FillStyleMapPref object

FillStyleMapPref() [3/3]

hdi::core::FillStyleMapPref::FillStyleMapPref	(	const FillStyle::Map &	value_,
		const std::string &	name_ = ""
	)

Constructs a FillStyleMapPref object, with new data, to be added to a container at a later time.

Author

GW

Date

11/2015

Parameters

value_	Initial fill style map value
name_	Name for the data once it has been added to its container, as UTF-8

Note

The name_ argument can only be "" (omitted) if the object will be added directly to an ArrayPref object.

~FillStyleMapPref()

virtual hdi::core::FillStyleMapPref::~FillStyleMapPref ( )

virtual

Destructs a FillStyleMapPref object.

Author

GW

Date

11/2015

Member Function Documentation

clone()

virtual FillStyleMapPref * hdi::core::FillStyleMapPref::clone ( ) const

virtual

Convenience method to clone an FillStyleMapPref object on the heap.

Author

GW

Date

11/2015

Returns

A pointer to the new FillStyleMapPref object

Note

If you subclass FillStyleMapPref, you MUST overload this method yourself! If you don't and/or your clone() method does not return an instance of your FillStyleMapPref subclass, you will experience "object slicing" when adding the pref to a container.

Warning

The caller must manage the memory for the returned FillStyleMapPref object.

Implements hdi::core::PrefData.

dataType()

virtual Type hdi::core::FillStyleMapPref::dataType ( ) const

virtual

Gets the type of persistent data.

Author

GW

Date

11/2015

Returns

FillStyleMapType

Note

This is useful for knowing how to cast a PrefData object to its proper subclass

Reimplemented from hdi::core::PrefData.

fillStyleMap()

virtual FillStyle::Map hdi::core::FillStyleMapPref::fillStyleMap ( ) const

virtual

Gets the fill style map value for this object.

Author

GW

Date

11/2015

Returns

The fill style map value being described by this wrapper

operator=()

virtual FillStyleMapPref & hdi::core::FillStyleMapPref::operator= ( const FillStyleMapPref &  rhs_ )

virtual

Allows one FillStyleMapPref object to be assigned from another.

Author

GW

Date

11/2015

Parameters

rhs_	Righthand side of the = operator; the object to copy values from

Returns

The target FillStyleMapPref object, but with its value updated to match that of rhs_

setFillStyleMap()

virtual bool hdi::core::FillStyleMapPref::setFillStyleMap ( const FillStyle::Map &  value_ )

virtual

Sets the fill style map value for this object.

Author

GW

Date

11/2015

Parameters

value_

New fill style map value

Returns

true if the fill style map is successfully updated, or false otherwise