hdi::core::FontPref Class Reference

Allows for storage of font faces and sizes. More...

#include <hdicoreFontPref.h>

Inheritance diagram for hdi::core::FontPref:

Collaboration diagram for hdi::core::FontPref:

Public Member Functions
	FontPref ()
	Constructs an empty FontPref object.
	FontPref (const FontPref &f_)
	Constructs a new FontPref object from an existing FontPref object (copy constructor)
	FontPref (const Font &face_, const double size_, const std::string &name_="")
	Constructs a FontPref object, with new data, to be added to a container at a later time.
virtual	~FontPref ()
	Destructs a FontPref object.
virtual FontPref &	operator= (const FontPref &rhs_)
	Allows one FontPref object to be assigned from another.
virtual FontPref *	clone () const
	Convenience method to clone an FontPref object on the heap.
virtual std::unique_ptr< Font >	font () const
	Gets the font face for this object.
virtual bool	setFont (const Font &font_)
	Sets the font face for this object.
virtual double	size () const
	Gets the font size for this object.
virtual bool	setSize (const double size_)
	Sets the font size 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 font faces and sizes.

Constructor & Destructor Documentation

FontPref() [1/3]

hdi::core::FontPref::FontPref

(

)

Constructs an empty FontPref object.

Author

GW

Date

09/2013

Note

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

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

FontPref() [2/3]

hdi::core::FontPref::FontPref

(

const FontPref &

f_

)

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

Author

GW

Date

09/2013

Parameters

f_	Existing FontPref object

FontPref() [3/3]

hdi::core::FontPref::FontPref	(	const Font &	face_,
		const double	size_,
		const std::string &	name_ = ""
	)

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

Author

GW

Date

09/2013

Parameters

face_	Initial font face
size_	Initial font size
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.

~FontPref()

virtual hdi::core::FontPref::~FontPref ( )

virtual

Destructs a FontPref object.

Author

GW

Date

09/2013

Member Function Documentation

clone()

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

virtual

Convenience method to clone an FontPref object on the heap.

Author

GW

Date

10/2013

Returns

A pointer to the new FontPref object

Note

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

Warning

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

Implements hdi::core::PrefData.

font()

virtual std::unique_ptr< Font > hdi::core::FontPref::font ( ) const

virtual

Gets the font face for this object.

Author

GW

Date

09/2013

Returns

The Font object being described by this wrapper

operator=()

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

virtual

Allows one FontPref 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 FontPref object, but with its value updated to match that of rhs_

setFont()

virtual bool hdi::core::FontPref::setFont ( const Font &  font_ )

virtual

Sets the font face for this object.

Author

GW

Date

09/2013

Parameters

font_

New font face

Returns

true if the font is successfully updated, or false otherwise

setSize()

virtual bool hdi::core::FontPref::setSize ( const double  size_ )

virtual

Sets the font size for this object.

Author

GW

Date

09/2013

Parameters

size_

New font size value

Returns

true if the font size is successfully updated, or false otherwise

size()

virtual double hdi::core::FontPref::size ( ) const

virtual

Gets the font size for this object.

Author

GW

Date

09/2013

Returns

The font size being described by this wrapper