Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages | Examples

DWFToolkit::DWFEmbeddedFontImpl Class Reference
[DWF Publisher API]

#include "dwf/publisher/EmbeddedFont.h"

List of all members.


Detailed Description

Interface for TrueType font embedding engines.
Since:
7.0.1.

As of the 7.0.1 release, font embedding is only available on Microsoft Windows though the use of the T2Embed API (redistributable DLL required.) This non-final implementation pattern keeps the publishing API independent of platform-specific font embedding technology.

Definition at line 75 of file EmbeddedFont.h.

Public Member Functions

virtual ~DWFEmbeddedFontImpl () throw ()
virtual _DWFTK_API void addCharacters (const DWFString &rCharacters)=0 throw ( DWFException )
virtual _DWFTK_API void embed ()=0 throw ( DWFException )
virtual _DWFTK_API DWFInputStreamgetInputStream ()=0 throw ( DWFException )
virtual _DWFTK_API const DWFStringgetFaceName ()=0 throw ( DWFException )
virtual _DWFTK_API const DWFStringgetLogfontName ()=0 throw ( DWFException )
virtual _DWFTK_API int getRequest ()=0 throw ( DWFException )
virtual _DWFTK_API DWFFontResource::tePrivilege getPrivilege ()=0 throw ( DWFException )
virtual _DWFTK_API DWFFontResource::teCharacterCode getCharacterCode ()=0 throw ( DWFException )
virtual _DWFTK_API void load (bool bForceRename=true)=0 throw ( DWFException )
virtual _DWFTK_API const DWFStringloadedFontName () const =0 throw ( DWFException )
virtual _DWFTK_API void unload ()=0 throw ( DWFException )

Protected Member Functions

_DWFTK_API DWFEmbeddedFontImpl () throw ()


Constructor & Destructor Documentation

virtual DWFToolkit::DWFEmbeddedFontImpl::~DWFEmbeddedFontImpl  )  throw () [inline, virtual]
 

Destructor

Exceptions:
None 

Definition at line 85 of file EmbeddedFont.h.

_DWFTK_API DWFToolkit::DWFEmbeddedFontImpl::DWFEmbeddedFontImpl  )  throw () [inline, protected]
 

Constructor

Exceptions:
None 

Definition at line 179 of file EmbeddedFont.h.


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::DWFEmbeddedFontImpl::addCharacters const DWFString rCharacters  )  throw ( DWFException ) [pure virtual]
 

Identifies which character glyphs to embed.

This is an additive operation. Generally, an embedded font object is created for each TrueType font that should be published. For every string (or character) that is added to the scene that must be rendered in an embedded font, that string (or character) is sent to this method. If possible, only those data for the final character subset should be embedded.

The following are equivalent:

  1.                     pFont->addCharacters( L"This is some text" );
                        pFont->addCharacters( L"Doors and Windows" );
    
  2.                     pFont->addCharacters( L"adehimnorstwxDTW" );
    

Parameters:
rCharacters The Unicode character string.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFEmbeddedFontImpl::embed  )  throw ( DWFException ) [pure virtual]
 

Captures the embeddable font data.

This method should be invoked once after addCharacters() to use the engine implementation to perform it's work and extract, compress, etc. the font data. The next call to getInputStream() will provide the data generated from this operation.

Exceptions:
DWFException 

virtual _DWFTK_API DWFFontResource::teCharacterCode DWFToolkit::DWFEmbeddedFontImpl::getCharacterCode  )  throw ( DWFException ) [pure virtual]
 

Returns the character code for the embedded font

Returns:
The character code enumeration.
Exceptions:
DWFException 

virtual _DWFTK_API const DWFString& DWFToolkit::DWFEmbeddedFontImpl::getFaceName  )  throw ( DWFException ) [pure virtual]
 

Returns the canonical face name of the font.

Returns:
The font name.
Exceptions:
DWFException 

virtual _DWFTK_API DWFInputStream* DWFToolkit::DWFEmbeddedFontImpl::getInputStream  )  throw ( DWFException ) [pure virtual]
 

Provides a stream to read the embeddable font data obtained from a previous call to embed().

Returns:
A pointer to a data stream. The caller is responsible for deleting the pointer with DWFCORE_FREE_OBJECT.
Exceptions:
DWFException 

virtual _DWFTK_API const DWFString& DWFToolkit::DWFEmbeddedFontImpl::getLogfontName  )  throw ( DWFException ) [pure virtual]
 

Returns the logfont face name of the font.

Returns:
The font name.
Exceptions:
DWFException 

virtual _DWFTK_API DWFFontResource::tePrivilege DWFToolkit::DWFEmbeddedFontImpl::getPrivilege  )  throw ( DWFException ) [pure virtual]
 

Returns the privilege with which the font was embedded

Returns:
The privilege enumeration.
Exceptions:
DWFException 

virtual _DWFTK_API int DWFToolkit::DWFEmbeddedFontImpl::getRequest  )  throw ( DWFException ) [pure virtual]
 

Returns the request flag with which the font was embedded.

Returns:
The request flag.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFEmbeddedFontImpl::load bool  bForceRename = true  )  throw ( DWFException ) [pure virtual]
 

Loads the given font from an embedded data representation into the font engine.

Exceptions:
DWFException 

virtual _DWFTK_API const DWFString& DWFToolkit::DWFEmbeddedFontImpl::loadedFontName  )  const throw ( DWFException ) [pure virtual]
 

Returns the name under which the font was loaded.

Returns:
The (temporary) font name.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFEmbeddedFontImpl::unload  )  throw ( DWFException ) [pure virtual]
 

Unloads the embedded font from the font engine.

Exceptions:
DWFException 


The documentation for this class was generated from the following file:
Generated on Tue May 17 12:39:12 2005 for Autodesk DWF Toolkit by  doxygen 1.4.1