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

Allows for storage of stroke styles. More...

#include <hdicoreStrokeStylePref.h>

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

Public Member Functions

 StrokeStylePref ()
 Constructs an empty StrokeStylePref object. More...
 
 StrokeStylePref (const StrokeStylePref &ss_)
 Constructs a new StrokeStylePref object from an existing StrokeStylePref object (copy constructor) More...
 
 StrokeStylePref (const StrokeStyle &value_, const std::string &name_="")
 Constructs a StrokeStylePref object, with new data, to be added to a container at a later time. More...
 
virtual ~StrokeStylePref ()
 Destructs a StrokeStylePref object. More...
 
virtual StrokeStylePrefoperator= (const StrokeStylePref &rhs_)
 Allows one StrokeStylePref object to be assigned from another. More...
 
virtual StrokeStylePrefclone () const
 Convenience method to clone an StrokeStylePref object on the heap. More...
 
virtual Type dataType () const
 Gets the type of persistent data. More...
 
virtual StrokeStyle strokeStyle () const
 Gets the stroke style value for this object. More...
 
virtual bool setStrokeStyle (const StrokeStyle &value_)
 Sets the stroke style value 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 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...
 

Friends

class PathStylePref
 

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 stroke styles.

Constructor & Destructor Documentation

hdi::core::StrokeStylePref::StrokeStylePref ( )

Constructs an empty StrokeStylePref object.

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

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

Author
GW
Date
11/2015
Parameters
ss_Existing StrokeStylePref object
hdi::core::StrokeStylePref::StrokeStylePref ( const StrokeStyle value_,
const std::string &  name_ = "" 
)

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

Author
GW
Date
11/2015
Parameters
value_Initial stroke style 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::StrokeStylePref::~StrokeStylePref ( )
virtual

Destructs a StrokeStylePref object.

Author
GW
Date
11/2015

Member Function Documentation

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

Convenience method to clone an StrokeStylePref object on the heap.

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

Implements hdi::core::PrefData.

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

Gets the type of persistent data.

Author
GW
Date
11/2015
Returns
StrokeStyleType
Note
This is useful for knowing how to cast a PrefData object to its proper subclass

Reimplemented from hdi::core::PrefData.

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

Allows one StrokeStylePref 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 StrokeStylePref object, but with its value updated to match that of rhs_
virtual bool hdi::core::StrokeStylePref::setStrokeStyle ( const StrokeStyle value_)
virtual

Sets the stroke style value for this object.

Author
GW
Date
11/2015
Parameters
value_New stroke style value
Returns
true if the stroke style is successfully updated, or false otherwise
virtual StrokeStyle hdi::core::StrokeStylePref::strokeStyle ( ) const
virtual

Gets the stroke style value for this object.

Author
GW
Date
11/2015
Returns
The stroke style value being described by this wrapper