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

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

#include <hdicoreFontPref.h>

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

Public Member Functions

 FontPref ()
 Constructs an empty FontPref object. More...
 
 FontPref (const FontPref &f_)
 Constructs a new FontPref object from an existing FontPref object (copy constructor) More...
 
 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. More...
 
virtual ~FontPref ()
 Destructs a FontPref object. More...
 
virtual FontPrefoperator= (const FontPref &rhs_)
 Allows one FontPref object to be assigned from another. More...
 
virtual FontPrefclone () const
 Convenience method to clone an FontPref object on the heap. More...
 
virtual std::auto_ptr< Fontfont () const
 Gets the font face for this object. More...
 
virtual bool setFont (const Font &font_)
 Sets the font face for this object. More...
 
virtual double size () const
 Gets the font size for this object. More...
 
virtual bool setSize (const double size_)
 Sets the font size 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 font faces and sizes.

Constructor & Destructor Documentation

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)
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
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.
virtual hdi::core::FontPref::~FontPref ( )
virtual

Destructs a FontPref object.

Author
GW
Date
09/2013

Member Function Documentation

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.

virtual std::auto_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
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_
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
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
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