|
Mako 7.5.0 API
|
|
Mako 7.5.0 API
|
An instance of the IJawsMako library. Only one instance of this object is currently allowed. This class may also be used as both an EDL factory and an EDL session, and passed to any EDL API that requires these objects. More...
#include <jawsmako.h>
Public Member Functions | |
| virtual void | freeMemory ()=0 |
| Inform JawsMako that system memory is being exhausted. This will cause JawsMako to free up cached information and discard any unmodified pages. | |
| virtual IDOMFontPtr | findFont (const U8String &fontName, uint32_t &fontIndex)=0 |
| Find a font from the system fonts, and the font index if applicable. | |
| virtual bool | findFont (const U8String &fontName)=0 |
| Check to see if a system font with the given name is available. | |
 Public Member Functions inherited from ISession | |
| virtual bool | setFactory (IEDLClassFactory *pFactory)=0 |
| initializes Session by setting EDL class Factory | |
| virtual IEDLClassFactory * | getFactory ()=0 |
| EDL Class Factory getter method. | |
| virtual IMessageHandlerPtr | getMessageHandler ()=0 |
| Obtain the session's message handler. | |
| virtual ILiteMessageHandlerPtr | getLiteMessageHandler ()=0 |
| Obtain the session's litemessage handler. | |
| virtual bool | setTemporaryDirectory (const EDLSysString &sTempDirectory)=0 |
| Set the temporary directory to be used by EDL and filters for this session. | |
| virtual bool | getTemporaryDirectory (EDLSysString &sTempDirectory)=0 |
| Get the temporary directory to be used by EDL and filters for this session. | |
| virtual IEDLTempStorePtr | getTempStore ()=0 |
| Get the temporary store for this session. The temporary directory must be set before calling this member. Throws an IEDLError on failure. | |
| virtual bool | setStartupDirectory (const EDLSysString &sStartupDirectory)=0 |
| Set the startup directory. This is meaningfull for executable environments. Note the client must set this during initalisation for it to be valid. | |
| virtual bool | getStartupDirectory (EDLSysString &sStartupDirectory)=0 |
| Get the startup directory. | |
| Public Member Functions inherited from IEDLObject | |
| virtual const CClassID & | getClassID () 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 IEDLClassFactory | |
| virtual bool | registerNamedClass (const EDLSysString &strName, const CClassID &id, bool overwrite=true)=0 |
| Register a GUID under a string name. | |
| virtual bool | findNamedClass (const EDLSysString &strName, CClassID &id)=0 |
| Retrieve GUID registered under the string name. | |
| virtual bool | registerClass (const CClassID &id, creatorFunc f)=0 |
| Register a GUID with creator function. | |
| virtual IEDLObjectPtr | createInstance (const CClassID &id, CClassParams *pParams=NULL)=0 |
| Creates the registered class by CClassID. | |
| virtual IEDLObjectPtr | createInstanceJawsMako (const CClassID &id, CClassParams *pParams=NULL, IEDLClassFactory *factory=NULL)=0 |
| Creates the registered class by CClassID. | |
| virtual IEDLObjectPtr | getSingleton (const CClassID &id)=0 |
| Creates the EDL singleton (for example FontLibrary or ColorManager) | |
Static Public Member Functions | |
| static JAWSMAKO_API IJawsMakoPtr | create (const U8String &tempDir=U8String(""), const U8String &cacheDir=U8String(""), const CTemporaryStoreParameters &tempStoreParams=CTemporaryStoreParameters(), const std::map< std::string, std::string > &initialParams=std::map< std::string, std::string >()) |
| Create an IJawsMako instance. Only one may be created at any one time. | |
| static JAWSMAKO_API void | enablePDFInput (const IJawsMakoPtr &jawsMako) |
| Enable PDF Input for JawsMako. | |
| static JAWSMAKO_API void | enablePDFOutput (const IJawsMakoPtr &jawsMako) |
| Enable PDF Output for JawsMako. | |
| static JAWSMAKO_API void | enablePSInput (const IJawsMakoPtr &jawsMako) |
| Enable PostScript Input for JawsMako. | |
| static JAWSMAKO_API void | enablePSOutput (const IJawsMakoPtr &jawsMako) |
| Enable PostScript Output for JawsMako. | |
| static JAWSMAKO_API void | enableAllFeatures (const IJawsMakoPtr &jawsMako) |
| Enable all JawsMako features. | |
Additional Inherited Members | |
| Protected Member Functions inherited from IRCObject | |
| virtual | ~IRCObject () |
| Virtual destructor. | |
An instance of the IJawsMako library. Only one instance of this object is currently allowed. This class may also be used as both an EDL factory and an EDL session, and passed to any EDL API that requires these objects.
|
static |
Enable PostScript Input for JawsMako.
Note that enabling PostScript will also enable PDF Input, as for PostScript the input is converted and then opened as PDF.
|
pure virtual |
Check to see if a system font with the given name is available.
Only TrueType, TrueType collections or OpenType/CFF fonts are supported. Matching is currently exact; there is no attempt to find a font that is similarly named. Fonts are matched based on their Full or PostScript font names.
The list of fonts on the system is cached and refreshed once per JawsMako instance creation.
May throw an exception if there was an error when finding the font.
| fontName | The font name of the desired font. |
|
pure virtual |
Find a font from the system fonts, and the font index if applicable.
Only TrueType, TrueType collections or OpenType/CFF fonts are supported. Matching is currently exact; there is no attempt to find a font that is similarly named. Fonts are matched based on their Full or PostScript font names.
The list of fonts on the system is cached and refreshed once per JawsMako instance creation.
An IError of code JM_ERR_FONT_NOT_FOUND will be thrown if the font could not be found.
| fontName | The font name of the desired font. |
| fontIndex | If the requested font is part of a TrueType collection, this will be set to the index of the font within the collection, or 0 otherwise. |