hdi::core::BoolPref Class Reference

Allows for storage of bools. More...

#include <hdicoreBoolPref.h>

Inheritance diagram for hdi::core::BoolPref:

Collaboration diagram for hdi::core::BoolPref:

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

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 bools.

Constructor & Destructor Documentation

BoolPref() [1/3]

hdi::core::BoolPref::BoolPref

(

)

Constructs an empty BoolPref object.

Author

GW

Date

09/2013

Note

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

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

BoolPref() [2/3]

hdi::core::BoolPref::BoolPref

(

const BoolPref &

b_

)

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

Author

GW

Date

09/2013

Parameters

b_	Existing BoolPref object

BoolPref() [3/3]

hdi::core::BoolPref::BoolPref	(	const bool	value_,
		const std::string &	name_ = ""
	)

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

Author

GW

Date

09/2013

Parameters

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

~BoolPref()

virtual hdi::core::BoolPref::~BoolPref ( )

virtual

Destructs a BoolPref object.

Author

GW

Date

09/2013

Member Function Documentation

boolValue()

virtual bool hdi::core::BoolPref::boolValue ( ) const

virtual

Gets the bool value for this object.

Author

GW

Date

09/2013

Returns

The bool value being described by this wrapper

clone()

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

virtual

Convenience method to clone an BoolPref object on the heap.

Author

GW

Date

10/2013

Returns

A pointer to the new BoolPref object

Note

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

Warning

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

Implements hdi::core::PrefData.

operator=()

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

virtual

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

setBoolValue()

virtual bool hdi::core::BoolPref::setBoolValue ( const bool  value_ )

virtual

Sets the bool value for this object.

Author

GW

Date

09/2013

Parameters

value_

New bool value

Returns

true if the bool is successfully updated, or false otherwise