hdi::core::ArtboardPointPref Class Reference

Allows for storage of 2D artboard points. More...

#include <hdicoreArtboardPointPref.h>

Inheritance diagram for hdi::core::ArtboardPointPref:

Collaboration diagram for hdi::core::ArtboardPointPref:

Public Member Functions
	ArtboardPointPref ()
	Constructs an empty ArtboardPointPref object.
	ArtboardPointPref (const ArtboardPointPref &abp_)
	Constructs a new ArtboardPointPref object from an existing ArtboardPointPref object (copy constructor)
	ArtboardPointPref (const ArtboardPoint &value_, const std::string &name_="")
	Constructs an ArtboardPointPref object, with new data, to be added to a container at a later time.
virtual	~ArtboardPointPref ()
	Destructs an ArtboardPointPref object.
virtual ArtboardPointPref &	operator= (const ArtboardPointPref &rhs_)
	Allows one ArtboardPointPref object to be assigned from another.
virtual ArtboardPointPref *	clone () const
	Convenience method to clone an ArtboardPointPref object on the heap.
virtual ArtboardPoint	artboardPoint () const
	Gets the point for this object.
virtual bool	setArtboardPoint (const ArtboardPoint &pt_)
	Sets the point 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.

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 2D artboard points.

Constructor & Destructor Documentation

ArtboardPointPref() [1/3]

hdi::core::ArtboardPointPref::ArtboardPointPref

(

)

Constructs an empty ArtboardPointPref object.

Author

GW

Date

09/2013

Note

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

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

ArtboardPointPref() [2/3]

hdi::core::ArtboardPointPref::ArtboardPointPref

(

const ArtboardPointPref &

abp_

)

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

Author

GW

Date

09/2013

Parameters

abp_	Existing ArtboardPointPref object

ArtboardPointPref() [3/3]

hdi::core::ArtboardPointPref::ArtboardPointPref	(	const ArtboardPoint &	value_,
		const std::string &	name_ = ""
	)

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

Author

GW

Date

09/2013

Parameters

value_	Initial point 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.

~ArtboardPointPref()

virtual hdi::core::ArtboardPointPref::~ArtboardPointPref ( )

virtual

Destructs an ArtboardPointPref object.

Author

GW

Date

09/2013

Member Function Documentation

artboardPoint()

virtual ArtboardPoint hdi::core::ArtboardPointPref::artboardPoint ( ) const

virtual

Gets the point for this object.

Author

GW

Date

09/2013

Returns

The ArtboardPoint object being described by this wrapper

clone()

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

virtual

Convenience method to clone an ArtboardPointPref object on the heap.

Author

GW

Date

10/2013

Returns

A pointer to the new ArtboardPointPref object

Note

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

Warning

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

Implements hdi::core::PrefData.

operator=()

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

virtual

Allows one ArtboardPointPref object to be assigned from another.

Author

GW

Date

09/2013

Parameters

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

Returns

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

setArtboardPoint()

virtual bool hdi::core::ArtboardPointPref::setArtboardPoint ( const ArtboardPoint &  pt_ )

virtual

Sets the point for this object.

Author

GW

Date

09/2013

Parameters

pt_	New point value

Returns

true if the point is successfully updated, or false otherwise