Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
Public Member Functions | List of all members
hdi::core::ColorPref Class Reference

Allows for storage of colors. More...

#include <hdicoreColorPref.h>

Inheritance diagram for hdi::core::ColorPref:
Inheritance graph
[legend]
Collaboration diagram for hdi::core::ColorPref:
Collaboration graph
[legend]

Public Member Functions

 ColorPref ()
 Constructs an empty ColorPref object. More...
 
 ColorPref (const ColorPref &c_)
 Constructs a new ColorPref object from an existing ColorPref object (copy constructor) More...
 
 ColorPref (const Color &value_, const std::string &name_="")
 Constructs a ColorPref object, with new data, to be added to a container at a later time. More...
 
virtual ~ColorPref ()
 Destructs a ColorPref object. More...
 
virtual ColorPrefoperator= (const ColorPref &rhs_)
 Allows one ColorPref object to be assigned from another. More...
 
virtual ColorPrefclone () const
 Convenience method to clone an ColorPref object on the heap. More...
 
virtual Color color () const
 Gets the color for this object. More...
 
virtual bool setColor (const Color &color_)
 Sets the color for this object. More...
 
- Public Member Functions inherited from hdi::core::PrefData
 PrefData ()
 Constructs an empty PrefData object. More...
 
 PrefData (const PrefData &data_)
 Constructs a new PrefData object from an existing PrefData object (copy constructor) More...
 
virtual ~PrefData ()
 Destructs a PrefData object. More...
 
virtual PrefDataoperator= (const PrefData &rhs_)
 Allows one PrefData object to be assigned from another. More...
 
virtual bool isEmpty () const
 Gets whether the target PrefData object is empty (constructed with the default ctor) More...
 
virtual bool operator== (const PrefData &rhs_) const
 Tests whether a given PrefData object is the same as another. More...
 
virtual bool operator!= (const PrefData &rhs_) const
 Tests whether a given PrefData object is not the same as another. More...
 
virtual Type dataType () const
 Gets the type of persistent data. More...
 
virtual std::string key () const
 Gets the persistent data object's key. More...
 
virtual void setKey (const std::string &key_)
 Sets the persistent data object's key. More...
 
virtual std::string stringify () const
 Recursively serializes the target object as a JSON data (sub)tree, returning the appropriate JSON string. More...
 

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::auto_ptr< PrefDataparse (const std::string &jsonStr_)
 Parses the given JSON string to a best-fit representation of PrefData subclass objects in a tree. More...
 
- Protected Member Functions inherited from hdi::core::PrefData
void * __impl () const
 Internal use only. More...
 
 PrefData (plugin::PersistentData *&)
 Internal use only. More...
 
- Protected Attributes inherited from hdi::core::PrefData
void * _data
 Private implementation data.
 

Detailed Description

Allows for storage of colors.

Constructor & Destructor Documentation

hdi::core::ColorPref::ColorPref ( )

Constructs an empty ColorPref object.

Author
GW
Date
09/2013
Note
To test if a ColorPref object is empty, call isEmpty() on it
Empty ColorPref objects do not relate to any actual preference data; they are designed to be "receivers" of some other ColorPref object via the overloaded assignment operator. Empty ColorPref objects are useless until such time (though it is safe to call any of their methods).
hdi::core::ColorPref::ColorPref ( const ColorPref c_)

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

Author
GW
Date
09/2013
Parameters
c_Existing ColorPref object
hdi::core::ColorPref::ColorPref ( const Color value_,
const std::string &  name_ = "" 
)

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

Author
GW
Date
09/2013
Parameters
value_Initial color 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.
virtual hdi::core::ColorPref::~ColorPref ( )
virtual

Destructs a ColorPref object.

Author
GW
Date
09/2013

Member Function Documentation

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

Convenience method to clone an ColorPref object on the heap.

Author
GW
Date
10/2013
Returns
A pointer to the new ColorPref object
Note
If you subclass ColorPref, you MUST overload this method yourself! If you don't and/or your clone() method does not return an instance of your ColorPref subclass, you will experience "object slicing" when adding the pref to a container.
Warning
The caller must manage the memory for the returned ColorPref object.

Implements hdi::core::PrefData.

virtual Color hdi::core::ColorPref::color ( ) const
virtual

Gets the color for this object.

Author
GW
Date
09/2013
Returns
The Color object being described by this wrapper
virtual ColorPref& hdi::core::ColorPref::operator= ( const ColorPref rhs_)
virtual

Allows one ColorPref 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 ColorPref object, but with its value updated to match that of rhs_
virtual bool hdi::core::ColorPref::setColor ( const Color color_)
virtual

Sets the color for this object.

Author
GW
Date
01/2012
Parameters
color_New color value
Returns
true if the color is successfully updated, or false otherwise