Interface for the PCL5 IOutput class. More...

#include <jawsmako/pcl5output.h>

Inheritance diagram for JawsMako::IPCL5Output:

Public Types
enum	ePCL5Version { ePCL5e , ePCL5c }
	Supported versions of PCL5. More...
enum	ePCL5ImageCompression { ePICNone , ePICRLE , ePICDeltaRow }
	Available image compression schemes. More...
typedef enum JawsMako::IPCL5Output::ePCL5Version	ePCL5Version
typedef enum JawsMako::IPCL5Output::ePCL5ImageCompression	ePCL5ImageCompression

Public Member Functions
virtual	~IPCL5Output ()
virtual void	setVersion (ePCL5Version version)=0
	Set the PCL version. The default is ePCL5c. Must be either ePCL5c or ePCL5e. Equivalent to calling setParameter() with the parameter name "PCL5Version" using the string value "pcl5e" or "pcl5c".
virtual void	setIncludeMarginsWhenSelectingPaper (bool include)=0
	Set whether paper selection for the PCL output should take into account the non-printable margins of the paper when selecting a paper size.
virtual void	setResolution (uint32 resolution)=0
	Set the PCL resolution The default is 600. Equivalent to calling setParameter() with the parameter name "Resolution".
virtual void	setImageCompression (ePCL5ImageCompression compression)=0
	Set the desired image compression method. The default is delta row. Equivalent to calling setParameter() with the parameter name "ImageCompression" using the string value "None", "RLE", or "DeltaRow".
virtual void	setMediaSource (uint32 mediaSource)=0
	Set the desired media source The default is 7. Equivalent to calling setParameter() with the parameter name "MediaSource".
virtual void	setOpenStream (bool open)=0
	Set whether the output stream should be opened or not.
virtual void	setEmitPjl (bool emitPjl)=0
	Set whether a PJL header or end of job should be emitted.
virtual void	setEnableTrueTypeNotDef (bool enableTrueTypeNotDef)=0
	Set whether a TrueType font's `.notdef` glyph is displayed.
Public Member Functions inherited from JawsMako::IOutput
virtual	~IOutput ()=default
virtual void	setPreset (const U8String &preset)=0
	Configure the output according to a general preset. Please see the supplied documentation for details of these presets. The default is "Preserve" which will attempt to produce output as close to the input as possible for the output format. A string value can be used for any parameter and will be converted as necessary.
virtual void	setParameter (const U8String &param, const U8String &value)=0
	Apply a key value pair output parameter with a string value. The parameter name is case-insensitive. Please refer to the supplied documentation for the details of the available parameters and their ranges.
virtual void	setAllowedPermissionsFlags (uint32 allowedPermissions)=0
	Control whether assemblies with certain security permission flags are allowed to be written by this output.
virtual void	writeAssembly (const IDocumentAssemblyPtr &assembly, const U8String &pathToFile)=0
	Write the given document assembly to a file on disk.
virtual void	writeAssembly (const IDocumentAssemblyPtr &assembly, const String &pathToFile)=0
	Write the given document assembly to a file on disk, specified by a wide character string.
virtual void	writeAssembly (const IDocumentAssemblyPtr &assembly, const IOutputStreamPtr &stream)=0
	Write the given document assembly to a stream.
virtual IOutputWriterPtr	openWriter (const IDocumentAssemblyPtr &assembly, const U8String &pathToFile)=0
	Create an output writer for the given assembly, targeting a file on disk. This is designed to allow streaming output, or to deal with situations where an operation would require too much memory to hold an entire edited assembly in memory at once.
virtual IOutputWriterPtr	openWriter (const IDocumentAssemblyPtr &assembly, const String &pathToFile)=0
	Create an output writer for the given assembly, targeting a file on disk. As above, but with the file specified in a wide character string.
virtual IOutputWriterPtr	openWriter (const IDocumentAssemblyPtr &assembly, const IOutputStreamPtr &stream)=0
	Create an output writer for the given assembly, targeting a stream.
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 IPCL5OutputPtr	create (const IJawsMakoPtr &jawsMako, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
	Create a PCL5 Output instance.
Static Public Member Functions inherited from JawsMako::IOutput
static JAWSMAKO_API IOutputPtr	create (const IJawsMakoPtr &jawsMako, eFileFormat format, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
	Create an output for writing source in the given format.

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

Detailed Description

Interface for the PCL5 IOutput class.

Member Typedef Documentation

◆ ePCL5ImageCompression

typedef enum JawsMako::IPCL5Output::ePCL5ImageCompression JawsMako::IPCL5Output::ePCL5ImageCompression

◆ ePCL5Version

typedef enum JawsMako::IPCL5Output::ePCL5Version JawsMako::IPCL5Output::ePCL5Version

Member Enumeration Documentation

◆ ePCL5ImageCompression

enum JawsMako::IPCL5Output::ePCL5ImageCompression

Available image compression schemes.

Enumerator
ePICNone
ePICRLE
ePICDeltaRow

◆ ePCL5Version

enum JawsMako::IPCL5Output::ePCL5Version

Supported versions of PCL5.

Enumerator
ePCL5e
ePCL5c

Constructor & Destructor Documentation

◆ ~IPCL5Output()

virtual JawsMako::IPCL5Output::~IPCL5Output ( )

inlinevirtual

Member Function Documentation

◆ create()

JAWSMAKO_API IPCL5OutputPtr JawsMako::IPCL5Output::create	(	const IJawsMakoPtr &	jawsMako,
		const IProgressMonitorPtr &	progressMonitor = IProgressMonitorPtr() )

static

Create a PCL5 Output instance.

Parameters

jawsMako	The JawsMako instance.
progressMonitor	The progress monitor which allows aborting an operation or registering a progress callback.

Returns: IPCL5OutputPtr A smart pointer to the PCL5 output instance.

◆ setEmitPjl()

virtual void JawsMako::IPCL5Output::setEmitPjl ( bool emitPjl )

pure virtual

Set whether a PJL header or end of job should be emitted.

   The default is true.

   Equivalent to calling setParameter() with the parameter name
   "EmitPJL", the value "true" or "false".

Parameters

emitPjl Whether to emit a PJL header or end of job.

◆ setEnableTrueTypeNotDef()

virtual void JawsMako::IPCL5Output::setEnableTrueTypeNotDef ( bool enableTrueTypeNotDef )

pure virtual

Set whether a TrueType font's .notdef glyph is displayed.

   The default is false.

   Equivalent to calling setParameter() with the parameter name
   "EnableTrueTypeNotDef", the value "true" or "false".

Parameters

enableTrueTypeNotDef Whether to display the .notdef glyph.

◆ setImageCompression()

virtual void JawsMako::IPCL5Output::setImageCompression ( ePCL5ImageCompression compression )

pure virtual

Set the desired image compression method. The default is delta row. Equivalent to calling setParameter() with the parameter name "ImageCompression" using the string value "None", "RLE", or "DeltaRow".

Parameters

compression The compression method to use.

◆ setIncludeMarginsWhenSelectingPaper()

virtual void JawsMako::IPCL5Output::setIncludeMarginsWhenSelectingPaper ( bool include )

pure virtual

Set whether paper selection for the PCL output should take into account the non-printable margins of the paper when selecting a paper size.

Real PCL/5 devices generally cannot print to the edge of a sheet of paper. Setting this parameter it to true will cause the paper size selection algorithm to potentially choose a larger paper size such that the page being output will appear in its entirety. If false, the page size will be chosen based on the physical size of the DOM page. In both cases the output will be centered on the selected paper. Equivalent to calling setParameter() with the parameter name "IncludeMarginsWhenSelectingPaper" using the string value "true" or "false".

The default is false.

Parameters

include True to include the margins when selecting a paper size.

◆ setMediaSource()

virtual void JawsMako::IPCL5Output::setMediaSource ( uint32 mediaSource )

pure virtual

Set the desired media source The default is 7. Equivalent to calling setParameter() with the parameter name "MediaSource".

Parameters

mediaSource The media source to use.

◆ setOpenStream()

virtual void JawsMako::IPCL5Output::setOpenStream ( bool open )

pure virtual

Set whether the output stream should be opened or not.

   If true, the output stream will be opened and closed by the
   PCL5 output. If false, Mako will assume the stream has been
   opened and that it will not be closed.

   Setting this to false allows the PCL5 stream to be written
   to an existing stream or channel.

   The default is true.

   Equivalent to calling setParameter() with the parameter name
   "OpenStream", the value "true" or "false".

Parameters

open	Whether to open the stream or not.

◆ setResolution()

virtual void JawsMako::IPCL5Output::setResolution ( uint32 resolution )

pure virtual

Set the PCL resolution The default is 600. Equivalent to calling setParameter() with the parameter name "Resolution".

Parameters

resolution The resolution to use.

◆ setVersion()

virtual void JawsMako::IPCL5Output::setVersion ( ePCL5Version version )

pure virtual

Set the PCL version. The default is ePCL5c. Must be either ePCL5c or ePCL5e. Equivalent to calling setParameter() with the parameter name "PCL5Version" using the string value "pcl5e" or "pcl5c".

Parameters

version The version to use.

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

jawsmako/pcl5output.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ePCL5ImageCompression

◆ ePCL5Version

Member Enumeration Documentation

◆ ePCL5ImageCompression

◆ ePCL5Version

Constructor & Destructor Documentation

◆ ~IPCL5Output()

Member Function Documentation

◆ create()

◆ setEmitPjl()

◆ setEnableTrueTypeNotDef()

◆ setImageCompression()

◆ setIncludeMarginsWhenSelectingPaper()

◆ setMediaSource()

◆ setOpenStream()

◆ setResolution()

◆ setVersion()