Mako 8.2.0 API
MakoCore SDK API Documentation
Loading...
Searching...
No Matches
IDOMFontPCL5 Class Referenceabstract

IDOMFontPCL5 (PCL5 Truetype) derived from an OpenType font source. More...

#include <edl/idomfontpcl.h>

Inheritance diagram for IDOMFontPCL5:
[legend]

Classes

class  Data
 Initialization data. More...

Public Types

enum  ePCL5FontType { ePCL5FontTypeTTF , ePCL5FontTypeBitmap }
 Type used to uniquely identify the type of PCL5 font (Currently, only TTF supported). More...
typedef uint16 SymbolSetIDCode
 Type represents the PCL5 Font Symbol Set.
Public Types inherited from IDOMFontOpenType
enum  eOpenTypeFontType { eOpenTypeFontTypeUnknown , eOpenTypeFontTypeTTF , eOpenTypeFontTypeCFF , eOpenTypeFontTypeTTC }
 Type used to uniquely identify the type of OpenType font. More...
enum  eOriginalFontType {
  eOriginalTypeOpenType , eOriginalType1 , eOriginalType2 , eOriginalType42 ,
  eOriginalType9 , eOriginalType11 , eOriginalPclTrueType
}
 Type used to uniquely identify the original type of Font. In the PostScript/PDF inputs, most font types are converted to OpenType before insertion into the DOM. This allows the ability to discover what the original type was. More...
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...

Public Member Functions

virtual IDOMFontPCL5::ePCL5FontType getPCL5FontType () const =0
 Returns the sub font type for this PCLXL font.
virtual bool getFontName (EDLSysString &fontName)=0
 Returns the XL font name.
virtual bool setSymbolSetIDCode (IDOMFontPCL5::SymbolSetIDCode symbolSet)=0
 Set the font symbol set to be used in the generated font.
virtual IDOMFontPCL5::SymbolSetIDCode getSymbolSetIDCode () const =0
 Returns the font symbol set ID as an ID Code.
virtual bool getSymbolSetID (EDLSysString &symbolSetID) const =0
 Returns the font symbol set ID.
virtual bool getFormat15FontBlockEnumerator (IFontPCL5WriteSegmentBlockEnumeratorPtr &enumerator)=0
 Creates a Format 15 font block enumerator.
virtual bool getFormat16FontBlockEnumerator (IFontPCL5WriteSegmentBlockEnumeratorPtr &enumerator)=0
 Creates a Format 16 font block enumerator.
virtual bool getFontTrueTypeGlyphAccessor (IFontPCL5TrueTypeGlyphAccessorPtr &accessor)=0
 Creates a TrueType glyph accessor.
Public Member Functions inherited from IDOMFontOpenTypeTT
virtual int32 writeFont (const IOutputStreamPtr &outStream)=0
 Write the converted OpenType font to stream (CFF style Opentype fonts are converted to TTF style).
virtual int32 writeFont (const EDLSysString &filePath, bool isTemplate=false)
 Write the converted OpenType font to a file (CFF style Opentype fonts are converted to TTF style). This method is normally used to debug and test OpenType CFF->TTF converted fonts.
Public Member Functions inherited from IDOMFontOpenType
 DECL_SMART_PTR (CCIDMap)
virtual bool getObfuscated () const =0
 Returns true if font is obfuscated. Obfuscated fonts are only found in XPS Documents.
virtual bool getIsPSStandardFont () const =0
 Establishes whether the font is a standard PostScript font.
virtual bool getIsPDFStandardFont () const =0
 Establishes whether the font is a standard PDF font.
virtual bool getEmbedded () const =0
 Establishes whether the font is flagged for embeddeding.
virtual void setEmbedded (bool embedded)=0
 Sets whether of not the font is flagged for embeddeding.
virtual bool getSubsetted () const =0
 Requests if the font reports to be a subset.
virtual EDLRawString getRequestedFontName () const =0
 Get the name of the font as requested by the input document. This is only useful for PDF and PostScript input. If a font has to be substituted for another requested font, this will return the name of the font the input desired. The encoding of this font name is not defined.
virtual EDLSysString getPostScriptName (IEDLClassFactory *pFactory, int32 fontIndex)=0
 Get the "PostScript" Name of the font, from the font data itself. This is usually extracted from the 'name' OpenType table, but may be synthesized if the name cannot be obtained.
virtual EDLSysString getFullName (IEDLClassFactory *pFactory, int32 fontIndex)=0
 Get the "Full" Name of the font, from the font data itself. This is usually extracted from the 'name' OpenType table, but may be synthesized if the name cannot be obtained.
virtual eOpenTypeFontType getOpenTypeFontType ()=0
 Returns the sub font type for this opentype font.
virtual eOriginalFontType getOriginalFontType ()=0
 Returns the original font type for this opentype font.
virtual IFontOpenTypeTableAccessorPtr getFontOpenTypeTableAccessor (uint32 fontIndex=0)=0
 Creates an OpenType font table accessor.
virtual IFontTrueTypeGlyphAccessorPtr getFontTrueTypeGlyphAccessor (uint32 fontIndex=0, bool stripInstructions=false)=0
 Creates a TrueType glyph accessor.
virtual uint16 getFontLicenseFromOS2Table (uint32 fontIndex=0)=0
 Gets the fsType field (embedded licensing information) from the OS/2 table.
virtual bool getIsRestricted (uint32 fontIndex=0)=0
 Is the font marked as restricted from embedding according to its license?
virtual IDOMFontOpenTypeTTPtr createTrueTypeOnlyFontVersion (const ISessionPtr &ptrSession, bool regenerateStream)=0
 Create a TrueType only font from this OpenType font that may contain CFF fonts.
virtual IDOMFontOpenTypePtr createSubsetFont (const ISessionPtr &ptrSession, const CEDLVector< uint16 > &usedGlyphs, const CEDLVector< uint32 > &usedUnicode)=0
 Create a Subsetted version if this font.
virtual IDOMFontOpenTypePtr createRenamedFont (const ISessionPtr &ptrSession, const EDLSysString &fontName, uint32 fontIndex=0)=0
 Get a renamed version of this font. An exception of type IEDLError is thrown on failure.
virtual const CEDLSimpleBuffergetOriginalOS2Table () const =0
 Obtain the original OS/2 Table, if present, that was included in the font.
virtual CCIDMapConstPtr getCidMap () const =0
 Obtain the CID Map for this font, if present.
virtual int32 getFlags () const =0
 Obtain the PDF FontDescriptor Style flags, if present.
virtual const CEDLSimpleBuffergetPanose () const =0
 Obtain the PDF Style Panose information, if present.
virtual void setCidMap (const CCIDMapConstPtr &cidMap)=0
 Set or clear the CIDMap for the font. Valid only for TrueType fonts.
virtual bool validateInstructions (const ISessionPtr &session, uint32 fontIndex=0)=0
 Validate glyph instructions.
virtual IDOMFontOpenTypePtr stripInstructions (const ISessionPtr &session, uint32 fontIndex=0, bool all=false)=0
 Strip glyph instructions.
virtual EDLRawString getOriginalPdfEncoding () const =0
 Obtain the original PDF Font Encoding, if present.
virtual void removeOriginalPdfEncoding ()=0
 Clear the original PDF Font Encoding, if set.
Public Member Functions inherited from IDOMFont
virtual eFontType getFontType () const =0
 Gets the font type. See eFontType for more information on font types.
virtual IDOMFontSourcePtr getFontSource () const =0
 Get the font source of this font.
virtual void setFontSource (const IDOMFontSourcePtr &fontSource)=0
 Sets the font source for this font.
virtual IInputStreamPtr getFontBaseStream () const =0
 Return the base stream for this font, obtaining it from the font source.
virtual void getCharacterMap (CCharacterMap &characterMap, uint32 fontIndex=0U)=0
 Get the character map for this font.
Public Member Functions inherited from IDOMFontSource
virtual eFontSourceType getFontSourceType () const =0
 Gets the font source type.
virtual const EDLSysStringdetermineUri () const =0
 Determines the URI based on the font source (underlying font sources may be searched)
Public Member Functions inherited from IEDLObject
virtual const CClassIDgetClassID () const =0
 Returns class ID of IEDLObject.
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.
virtual bool clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
 Create a copy of EDLObject.
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.
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to.
Public Member Functions inherited from IDOMHashable
virtual ~IDOMHashable ()
 Virtual destructor.
virtual bool hash (uint64 &hash)=0
 Retrieve a hash for this object.
virtual uint64 hashE ()
 As hash(), but throws an exception if the operation fails.

Static Public Member Functions

static const CClassIDclassID ()
 Retrieves class id of IDOMFontPCL5.
Static Public Member Functions inherited from IDOMFontOpenTypeTT
static const CClassIDclassID ()
 Retrieves class id of IDOM.
Static Public Member Functions inherited from IDOMFontOpenType
static EDL_API IDOMFontOpenTypePtr create (IEDLClassFactory *pFactory, const IInputStreamPtr &stream)
 Simplified creator of a font from a stream. Throws an IEDLError exception on failure.
static const CClassIDclassID ()
 Retrieves the class id of IDOMFontOpenType.
Static Public Member Functions inherited from IDOMFont
static const CClassIDclassID ()
 Retrieves class id of IDOMFont.
Static Public Member Functions inherited from IDOMFontSource
static const CClassIDclassID ()
 Retrieves the class id of IDOMFontSource.

Additional Inherited Members

Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.

Detailed Description

IDOMFontPCL5 (PCL5 Truetype) derived from an OpenType font source.

Member Function Documentation

◆ classID()

const CClassID & IDOMFontPCL5::classID ( )
inlinestatic

Retrieves class id of IDOMFontPCL5.

Returns
CClassID class id of the element

◆ getFontName()

virtual bool IDOMFontPCL5::getFontName ( EDLSysString & fontName)
pure virtual

Returns the XL font name.

Parameters
fontNameThe font name returned
Returns
bool True on success

◆ getFontTrueTypeGlyphAccessor()

virtual bool IDOMFontPCL5::getFontTrueTypeGlyphAccessor ( IFontPCL5TrueTypeGlyphAccessorPtr & accessor)
pure virtual

Creates a TrueType glyph accessor.

Parameters
accessorReturns the accessor.
Returns
bool True on success.

◆ getFormat15FontBlockEnumerator()

virtual bool IDOMFontPCL5::getFormat15FontBlockEnumerator ( IFontPCL5WriteSegmentBlockEnumeratorPtr & enumerator)
pure virtual

Creates a Format 15 font block enumerator.

Parameters
enumeratorReturns the enumerator
Returns
bool True on success

◆ getFormat16FontBlockEnumerator()

virtual bool IDOMFontPCL5::getFormat16FontBlockEnumerator ( IFontPCL5WriteSegmentBlockEnumeratorPtr & enumerator)
pure virtual

Creates a Format 16 font block enumerator.

Parameters
enumeratorReturns the enumerator
Returns
bool True on success

◆ getPCL5FontType()

virtual IDOMFontPCL5::ePCL5FontType IDOMFontPCL5::getPCL5FontType ( ) const
pure virtual

Returns the sub font type for this PCLXL font.

Returns
IDOMFontPCL5::ePCL5FontType Returns the sub-font type. Currently only TTF is supported.

◆ getSymbolSetID()

virtual bool IDOMFontPCL5::getSymbolSetID ( EDLSysString & symbolSetID) const
pure virtual

Returns the font symbol set ID.

Parameters
symbolSetIDThe font symbol set ID
Returns
bool True on success

◆ getSymbolSetIDCode()

virtual IDOMFontPCL5::SymbolSetIDCode IDOMFontPCL5::getSymbolSetIDCode ( ) const
pure virtual

Returns the font symbol set ID as an ID Code.

Returns
IDOMFontPCL5::SymbolSet Returns the symbol set

◆ setSymbolSetIDCode()

virtual bool IDOMFontPCL5::setSymbolSetIDCode ( IDOMFontPCL5::SymbolSetIDCode symbolSet)
pure virtual

Set the font symbol set to be used in the generated font.

Parameters
symbolSetThe font symbol set
Returns
bool True on success

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