Mako 8.1.0 API
Loading...
Searching...
No Matches
JawsMako::IOutputIntent Class Referenceabstract

Interface class representing a PDF output intent. More...

#include <outputintent.h>

Inheritance diagram for JawsMako::IOutputIntent:

Public Member Functions

virtual IOutputIntentPtr clone ()=0
 Clone the output intent.
 
virtual U8String getSubtype () const =0
 Retrieve the subtype.
 
virtual U8String getOutputCondition () const =0
 Retrieve the output condition, if present.
 
virtual U8String getOutputConditionIdentifier () const =0
 Retrieve the output condition identifier.
 
virtual U8String getRegistryName () const =0
 Retrieve the registry name, if present.
 
virtual U8String getInfo () const =0
 Retrieve the output intent information string, if present.
 
virtual IDOMICCProfilePtr getProfile () const =0
 Retrieve the output ICC profile if provided.
 
virtual RawString getCheckSum () const =0
 Retrieve the 16-byte MD5 checksum of the profile, if provided.
 
virtual CU8StringVect getColorantTable () const =0
 Retrieve the colorant table for the output intent, if provided.
 
virtual uint32 getProfileVersion () const =0
 Retrieve the ICC profile version, if provided, as a 32 bit value.
 
virtual RawString getProfileColorSpaceSignature () const =0
 Retrieve the four-byte color space signature of the IFF profile.
 
virtual U8String getProfileName () const =0
 Retrieve the profile name, if provided.
 
virtual CFileSpecVect getProfileFileSpecifications () const =0
 Retrieve any file specifications referring to external profiles (IFileSpecAsUrl) or embedded profiles (IFileSpecAsEmbeddedData).
 
- 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.
 

Static Public Member Functions

static JAWSMAKO_API IOutputIntentPtr create (const IJawsMakoPtr &jawsMako, const U8String &subtype, const U8String &outputCondition, const U8String &outputConditionIdentifier, const U8String &registryName, const U8String &info, const IDOMICCProfilePtr &profile=IDOMICCProfilePtr(), const RawString &checkSum=RawString(), const CU8StringVect &colorantTable=CU8StringVect(), uint32 profileVersion=0, const RawString &profileCS=RawString(), const U8String &profileName=U8String(), const CFileSpecVect &fileSpecs=CFileSpecVect())
 Create an IOutputIntent.
 

Additional Inherited Members

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

Detailed Description

Interface class representing a PDF output intent.

Member Function Documentation

◆ clone()

virtual IOutputIntentPtr JawsMako::IOutputIntent::clone ( )
pure virtual

Clone the output intent.

Returns
IOutputIntentPtr The cloned output intent.

◆ create()

static JAWSMAKO_API IOutputIntentPtr JawsMako::IOutputIntent::create ( const IJawsMakoPtr & jawsMako,
const U8String & subtype,
const U8String & outputCondition,
const U8String & outputConditionIdentifier,
const U8String & registryName,
const U8String & info,
const IDOMICCProfilePtr & profile = IDOMICCProfilePtr(),
const RawString & checkSum = RawString(),
const CU8StringVect & colorantTable = CU8StringVect(),
uint32 profileVersion = 0,
const RawString & profileCS = RawString(),
const U8String & profileName = U8String(),
const CFileSpecVect & fileSpecs = CFileSpecVect() )
static

Create an IOutputIntent.

Parameters
jawsMakoThe IJawsMako object
subtypeThe subtype of the output intent, e.g. "GTS_PDFA1".
outputConditionThe output condition, if any.
outputConditionIdentifierThe output condition identifier, if any.
registryNameThe registry name, if any.
infoThe output intent information string, if any.
profileThe ICC profile, if any
checkSumThe 16-byte MD5 checksum of the profile, if any.
colorantTableThe colorant table for the output intent, if any.
profileVersionThe ICC profile version, if any.
profileCSThe four-byte color space signature of the IFF profile, if any.
profileNameThe profile name, if any.
fileSpecsThe file specifications referring to external or embedded profiles, if any.
Returns
IOutputIntentPtr The new output intent.

◆ getCheckSum()

virtual RawString JawsMako::IOutputIntent::getCheckSum ( ) const
pure virtual

Retrieve the 16-byte MD5 checksum of the profile, if provided.

PDF 2.0 Features

Returns
RawString The checksum of the profile, or an empty string if none is set.

◆ getColorantTable()

virtual CU8StringVect JawsMako::IOutputIntent::getColorantTable ( ) const
pure virtual

Retrieve the colorant table for the output intent, if provided.

Returns
CU8StringVect The colorant table, or an empty vector if none is set.

◆ getInfo()

virtual U8String JawsMako::IOutputIntent::getInfo ( ) const
pure virtual

Retrieve the output intent information string, if present.

Returns
U8String The output intent information string, or an empty string if none is set.

◆ getOutputCondition()

virtual U8String JawsMako::IOutputIntent::getOutputCondition ( ) const
pure virtual

Retrieve the output condition, if present.

Returns
U8String The output condition, or an empty string if none is set.

◆ getOutputConditionIdentifier()

virtual U8String JawsMako::IOutputIntent::getOutputConditionIdentifier ( ) const
pure virtual

Retrieve the output condition identifier.

Returns
U8String The output condition identifier, or an empty string if none is set.

◆ getProfile()

virtual IDOMICCProfilePtr JawsMako::IOutputIntent::getProfile ( ) const
pure virtual

Retrieve the output ICC profile if provided.

Returns
IDOMICCProfilePtr The ICC profile, or an empty pointer if none is set.

◆ getProfileColorSpaceSignature()

virtual RawString JawsMako::IOutputIntent::getProfileColorSpaceSignature ( ) const
pure virtual

Retrieve the four-byte color space signature of the IFF profile.

Returns
RawString The color space signature, or an empty string if none is set.

◆ getProfileFileSpecifications()

virtual CFileSpecVect JawsMako::IOutputIntent::getProfileFileSpecifications ( ) const
pure virtual

Retrieve any file specifications referring to external profiles (IFileSpecAsUrl) or embedded profiles (IFileSpecAsEmbeddedData).

For convenience, the first embedded profile in this list will be returned by getProfile() unless a top-level profile has also been provided.

Returns
CFileSpecVect The file specifications referring to external or embedded profiles, or an empty vector if none are set.

◆ getProfileName()

virtual U8String JawsMako::IOutputIntent::getProfileName ( ) const
pure virtual

Retrieve the profile name, if provided.

Returns
U8String The profile name, or an empty string if none is set.

◆ getProfileVersion()

virtual uint32 JawsMako::IOutputIntent::getProfileVersion ( ) const
pure virtual

Retrieve the ICC profile version, if provided, as a 32 bit value.

Returns
uint32 The ICC profile version, or 0 if none is set.

◆ getRegistryName()

virtual U8String JawsMako::IOutputIntent::getRegistryName ( ) const
pure virtual

Retrieve the registry name, if present.

Returns
U8String The registry name, or an empty string if none is set.

◆ getSubtype()

virtual U8String JawsMako::IOutputIntent::getSubtype ( ) const
pure virtual

Retrieve the subtype.

Returns
U8String The subtype of the output intent, e.g. "GTS_PDFA1".

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