Mako 7.3.0 API
IDOMType3Font Class Referenceabstract

Representation of a PostScript/PDF Type 3 Font. At present, the stream cannot be set, only retrieved. More...

#include <idomfont.h>

Inheritance diagram for IDOMType3Font:

Classes

class  Data
 Initialization data. More...
 

Public Member Functions

virtual DOMid getId () const =0
 Retrieves the unique ID of this font. This ID is allocated on creation. Clones of this font will receive a new id. More...
 
virtual bool hasGlyph (const EDLSysString &glyphName) const =0
 Determines if the font already has a glyph with the given name. More...
 
virtual IDOMGlyphPtr getGlyph (const EDLSysString &glyphName) const =0
 Retrieves a glyph of the given name. An exception with code EDL_ERR_TYPE3_GLYPH_NOT_FOUND will be thrown if no such glyph is present. More...
 
virtual bool hasGlyph (uint32 codePoint) const =0
 Determines if the font already has a glyph with the given unicode codepoint. More...
 
virtual IDOMGlyphPtr getGlyph (uint32 codePoint) const =0
 Retrieves a glyph of the given unicode codepoint, if it exists. An exception with code EDL_ERR_TYPE3_GLYPH_NOT_FOUND will be thrown if no such glyph is present. More...
 
virtual bool hasGlyph (IDOMGlyph::GlyphID glyphID) const =0
 Determines if the font already has a glyph with the given glyph ID. More...
 
virtual IDOMGlyphPtr getGlyph (IDOMGlyph::GlyphID glyphID) const =0
 Retrieves a glyph of the given GlyphID, if it exists. An exception with code EDL_ERR_TYPE3_GLYPH_NOT_FOUND will be thrown if no such glyph is present. More...
 
virtual CDOMGlyphVect getGlyphs () const =0
 Obtain a vector of all of the glyphs present in this font. More...
 
virtual void deleteGlyphs ()=0
 Delete the glyph collection from the font.
 
virtual void addGlyph (const IDOMGlyphPtr &glyph)=0
 Adds a glyph of the given name to the font. More...
 
virtual FRect getBBox ()=0
 Returns font's bounding box. More...
 
virtual JawsMako::IPDFDictionaryPtr getFontDictionary () const =0
 Fetch the font dictionary. Do not edit the returned dictionary. More...
 
- Public Member Functions inherited from IDOMFont
virtual eFontType getFontType () const =0
 Gets the font type. See eFontType for more information on font types. More...
 
virtual IDOMFontSourcePtr getFontSource () const =0
 Get the font source of this font. More...
 
virtual void setFontSource (const IDOMFontSourcePtr &fontSource)=0
 Sets the font source for this font. More...
 
virtual IInputStreamPtr getFontBaseStream () const =0
 Return the base stream for this font, obtaining it from the font source. More...
 
virtual void getCharacterMap (CCharacterMap &characterMap, uint32 fontIndex=0U)=0
 Get the character map for this font. More...
 
- Public Member Functions inherited from IDOMFontSource
virtual eFontSourceType getFontSourceType () const =0
 Gets the font source type. More...
 
virtual const EDLSysString & determineUri () const =0
 Determines the URI based on the font source (underlying font sources may be searched) More...
 
- Public Member Functions inherited from IEDLObject
virtual const CClassIDgetClassID () const =0
 Returns class ID of IEDLObject. More...
 
virtual bool init (CClassParams *pData)
 The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory. More...
 
virtual bool clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
 Create a copy of EDLObject. More...
 
- Public Member Functions inherited from IRCObject
virtual void addRef () const =0
 Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
 
virtual bool decRef () const =0
 Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to. More...
 
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to. More...
 
- Public Member Functions inherited from IDOMHashable
virtual ~IDOMHashable ()
 Virtual destructor.
 
virtual bool hash (uint64 &hash)=0
 Retrieve a hash for this object. More...
 
virtual uint64 hashE ()
 As hash(), but throws an exception if the operation fails. More...
 

Static Public Member Functions

static const CClassIDclassID ()
 Retrieves class id of IDOM. More...
 
- Static Public Member Functions inherited from IDOMFont
static const CClassIDclassID ()
 Retrieves class id of IDOMFont. More...
 
- Static Public Member Functions inherited from IDOMFontSource
static const CClassIDclassID ()
 Retrieves the class id of IDOMFontSource. More...
 

Additional Inherited Members

- Public Types inherited from IDOMFont
enum  eFontType {
  eFontTypeUnknown , eFontTypeOpenType , eFontType3 , eFontTypePCLXL ,
  eFontTypePCL5
}
 type used to uniquely identify the type of font More...
 
typedef uint32 CharCode
 type used to uniquely identify a character code
 
typedef std::map< CharCode, IDOMGlyph::GlyphIDCCharacterMap
 Map type used for storing character code to glyph ID mappings.
 
- Public Types inherited from IDOMFontSource
enum  eFontSourceType { eFontSourceTypeNone , eFontSourceTypeStreamFilter , eFontSourceTypeStream , eFontSourceTypeFont }
 type used to uniquely identify the source type of a font More...
 
- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

Representation of a PostScript/PDF Type 3 Font. At present, the stream cannot be set, only retrieved.

Member Function Documentation

◆ addGlyph()

virtual void IDOMType3Font::addGlyph ( const IDOMGlyphPtr &  glyph)
pure virtual

Adds a glyph of the given name to the font.

Parameters
glyphThe glyph

◆ classID()

static const CClassID& IDOMType3Font::classID ( )
inlinestatic

Retrieves class id of IDOM.

Returns
CClassID class id of the element

◆ getBBox()

virtual FRect IDOMType3Font::getBBox ( )
pure virtual

Returns font's bounding box.

Returns
FRect The bounding box

◆ getFontDictionary()

virtual JawsMako::IPDFDictionaryPtr IDOMType3Font::getFontDictionary ( ) const
pure virtual

Fetch the font dictionary. Do not edit the returned dictionary.

Returns
IPDFDictionaryPtr The font dictionary

◆ getGlyph() [1/3]

virtual IDOMGlyphPtr IDOMType3Font::getGlyph ( const EDLSysString &  glyphName) const
pure virtual

Retrieves a glyph of the given name. An exception with code EDL_ERR_TYPE3_GLYPH_NOT_FOUND will be thrown if no such glyph is present.

Parameters
glyphNameThe glyph name
Returns
IDOMGlyphPtr The glyph

◆ getGlyph() [2/3]

virtual IDOMGlyphPtr IDOMType3Font::getGlyph ( IDOMGlyph::GlyphID  glyphID) const
pure virtual

Retrieves a glyph of the given GlyphID, if it exists. An exception with code EDL_ERR_TYPE3_GLYPH_NOT_FOUND will be thrown if no such glyph is present.

Parameters
glyphIDThe glyphID
Returns
IDOMGlyphPtr The glyph

◆ getGlyph() [3/3]

virtual IDOMGlyphPtr IDOMType3Font::getGlyph ( uint32  codePoint) const
pure virtual

Retrieves a glyph of the given unicode codepoint, if it exists. An exception with code EDL_ERR_TYPE3_GLYPH_NOT_FOUND will be thrown if no such glyph is present.

Parameters
codePointThe unicode codepoint
Returns
IDOMGlyphPtr The glyph

◆ getGlyphs()

virtual CDOMGlyphVect IDOMType3Font::getGlyphs ( ) const
pure virtual

Obtain a vector of all of the glyphs present in this font.

Returns
CDOMGlyphVect The glyphs

◆ getId()

virtual DOMid IDOMType3Font::getId ( ) const
pure virtual

Retrieves the unique ID of this font. This ID is allocated on creation. Clones of this font will receive a new id.

Returns
DOMid The DOM ID

◆ hasGlyph() [1/3]

virtual bool IDOMType3Font::hasGlyph ( const EDLSysString &  glyphName) const
pure virtual

Determines if the font already has a glyph with the given name.

Parameters
glyphNameThe glyph name
Returns
bool true if the glyph is present, false otherwise

◆ hasGlyph() [2/3]

virtual bool IDOMType3Font::hasGlyph ( IDOMGlyph::GlyphID  glyphID) const
pure virtual

Determines if the font already has a glyph with the given glyph ID.

Parameters
glyphIDThe glyphID
Returns
bool true if the glyph is present, false otherwise

◆ hasGlyph() [3/3]

virtual bool IDOMType3Font::hasGlyph ( uint32  codePoint) const
pure virtual

Determines if the font already has a glyph with the given unicode codepoint.

Parameters
codePointThe unicode codepoint
Returns
bool true if the glyph is present, false otherwise

The documentation for this class was generated from the following file: