An instance of the JawsMako PCL5 input class. More...

#include <jawsmako/pcl5input.h>

Inheritance diagram for JawsMako::IPCL5Input:

Public Types
enum	ePCL5Version { ePCL5Unset , ePCL5e , ePCL5c }
	An enumeration of possible PCL5 versions. More...

Public Member Functions
virtual	~IPCL5Input ()=default
virtual void	setRopResolution (uint32 resolution)=0
	Set the resolution to be used when flattening ROPs.
virtual void	setFlattenRops (bool flatten)=0
	Set whether ROPs should be flattened.
virtual void	setDefaultPaperSize (const U8String &paperSize)=0
	Set the default paper size.
virtual void	setDefaultLandscape (bool landscape)=0
	Set the default orientation.
virtual void	setDefaultCopies (uint32 copies)=0
	Set the default number of per-page copies.
virtual void	setDefaultDuplex (bool duplex)=0
	Set whether duplex should be set by default.
virtual void	setDefaultDuplexBindingMode (IPJLParser::eDuplexBindingMode bindingMode)=0
	Set the default binding edge for duplexing.
virtual void	setDefaultManualFeed (bool manualFeed)=0
	Set whether manual feed should be set by default.
virtual void	setDefaultEdgeToEdge (bool edgeToEdge)=0
	Set whether edge-to-edge printing should be enabled by default.
virtual void	setPclVersion (ePCL5Version version)=0
	Set the PCL5 version to use when interpreting the stream, or ePCL5Unset to detect from any input PJL. If ePCL5Unset is used and PJL provides no hints, the job will be assumed to be PCL5c.
virtual void	setDefaultsFromPjl (IPJLParserPtr &pjlParser)=0
	Take initialization data from the given PJL parser.
virtual void	enableUnencapsulatedMode (bool unencapsulated)=0
	Enable or disable unencapsulated mode.
virtual void	setMediaHandler (IMediaHandler *mediaHandler)=0
	Set the IMediaHandler instance to use to handle unsatisfied media requests.
virtual void	setIgnorePrescribe (bool ignorePrescribe)=0
	Set whether to ignore Kyocera PRESCRIBE commands.
virtual void	setPermanentResourceStore (IRCObjectPtr &permanentResourceStore)=0
	Set a permanent resource store.
virtual void	addInternalFont (const IDOMFontOpenTypePtr &font)=0
	Add an internal font.
Public Member Functions inherited from JawsMako::IInput
virtual	~IInput ()=default
virtual IDocumentAssemblyPtr	open (const U8String &pathToFile)=0
	Open a file on disk, returning the IDocumentAssembly representing the contents.
virtual IDocumentAssemblyPtr	open (const String &pathToFile)=0
	Open a file on disk, returning the IDocumentAssembly representing the contents. Takes a wide character string.
virtual IDocumentAssemblyPtr	open (const IInputStreamPtr &inputStream)=0
	Open a stream, returning the IDocumentAssembly representing the contents.
virtual void	setSequentialMode (bool sequential)=0
	Set/unset sequential mode on this input.
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.
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 IPCL5InputPtr	create (const IJawsMakoPtr &jawsMako, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
	Create an input for reading source documents in PCL5 format.
Static Public Member Functions inherited from JawsMako::IInput
static JAWSMAKO_API IInputPtr	create (const IJawsMakoPtr &jawsMako, eFileFormat format, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
	Create an input for reading source documents in the given format. The following formats are currently supported:

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

Detailed Description

An instance of the JawsMako PCL5 input class.

Member Enumeration Documentation

◆ ePCL5Version

enum JawsMako::IPCL5Input::ePCL5Version

An enumeration of possible PCL5 versions.

Enumerator
ePCL5Unset	Unset.
ePCL5e	PCL5e.
ePCL5c	PCL5c.

Constructor & Destructor Documentation

◆ ~IPCL5Input()

virtual JawsMako::IPCL5Input::~IPCL5Input ( )

virtualdefault

Member Function Documentation

◆ addInternalFont()

virtual void JawsMako::IPCL5Input::addInternalFont ( const IDOMFontOpenTypePtr & font )

pure virtual

Add an internal font.

     Adds a OpenType font to be used as an internal PCL font.  This feature
     permits additional fonts that may be available on some printers to be
     added and used as though they were built-in fonts; for example the
     Andale Mono WT fonts.

     The font will be added using the information in the PCLT table.  This
     table must be present in the font and an exception will be thrown if
     it is not.

Parameters

font	The font to add.

◆ create()

JAWSMAKO_API IPCL5InputPtr JawsMako::IPCL5Input::create	(	const IJawsMakoPtr &	jawsMako,
		const IProgressMonitorPtr &	progressMonitor = IProgressMonitorPtr() )

static

Create an input for reading source documents in PCL5 format.

Parameters

jawsMako	The IJawsMako object
progressMonitor	A smart pointer to an IProgressMonitor object which can be NULL if no such object was passed in.

Returns: IPCL5InputPtr the PCL5 input

◆ enableUnencapsulatedMode()

virtual void JawsMako::IPCL5Input::enableUnencapsulatedMode ( bool unencapsulated )

pure virtual

Enable or disable unencapsulated mode.

      Setting this mode to true changes the parser behaviour
      as follows.

      - The input stream is not opened; it is assumed to point to
        the start of a PCL5 stream.
      - The PJL parser is not used. If PJL is encountered an
        error will be thrown.
      - The PCL5 interpreter will not consume data after the point the
        interpreter either exhausts the stream or returns to PJL.
        After requesting a document after the last document
        in the session, or by requesting the number of documents, the
        stream will be positioned at the point that the PCL5
        interpreter exited.

      Whereas the default (false) will:

      - open() the input stream.
      - use the built-in PJL parser when PJL is encountered.
      - process all PCL5 sessions present in the stream, even
        if they are interrupted by returning to PJL.

Parameters

unencapsulated True to enable unencapsulated mode, false to disable it.

◆ setDefaultCopies()

virtual void JawsMako::IPCL5Input::setDefaultCopies ( uint32 copies )

pure virtual

Set the default number of per-page copies.

      The default is 1. Must be greater than zero.

Parameters

copies The number of copies to set as the default.

◆ setDefaultDuplex()

virtual void JawsMako::IPCL5Input::setDefaultDuplex ( bool duplex )

pure virtual

Set whether duplex should be set by default.

      The default is false.

Parameters

duplex True to set duplex by default, false to set simplex.

◆ setDefaultDuplexBindingMode()

virtual void JawsMako::IPCL5Input::setDefaultDuplexBindingMode ( IPJLParser::eDuplexBindingMode bindingMode )

pure virtual

Set the default binding edge for duplexing.

      The default is long edge.

Parameters

bindingMode The binding mode to set as the default.

◆ setDefaultEdgeToEdge()

virtual void JawsMako::IPCL5Input::setDefaultEdgeToEdge ( bool edgeToEdge )

pure virtual

Set whether edge-to-edge printing should be enabled by default.

      The default is false.

Parameters

edgeToEdge True to enable edge-to-edge printing by default, false to disable.

◆ setDefaultLandscape()

virtual void JawsMako::IPCL5Input::setDefaultLandscape ( bool landscape )

pure virtual

Set the default orientation.

      The default is portrait.

Parameters

landscape True to set landscape, false to set portrait.

◆ setDefaultManualFeed()

virtual void JawsMako::IPCL5Input::setDefaultManualFeed ( bool manualFeed )

pure virtual

Set whether manual feed should be set by default.

      The default is false.

Parameters

manualFeed True to set manual feed by default, false to disable manual feed.

◆ setDefaultPaperSize()

virtual void JawsMako::IPCL5Input::setDefaultPaperSize ( const U8String & paperSize )

pure virtual

Set the default paper size.

      The paper size is set using a string. To take effect the paper
      size string must match one of the following standard strings:

      - letter
      - legal
      - a4
      - exec
      - executive
      - ledger
      - a3
      - monarchenvelope
      - c5
      - dl
      - jisb4
      - jisb5
      - a5
      - a6
      - tabloid
      - ofuku

      The matching is case-insensitive.

      The default page size is a4

Parameters

paperSize The paper size to set as the default.

◆ setDefaultsFromPjl()

virtual void JawsMako::IPCL5Input::setDefaultsFromPjl ( IPJLParserPtr & pjlParser )

pure virtual

Take initialization data from the given PJL parser.

      Uses the environment in the given PJL parser to set
      defaults in the PCL5 input. Any previously set
      defaults will be ignored.

      This is especially useful with unencapsulated mode,
      where PJL parsing happens externally to the input.

Parameters

pjlParser A smart pointer to an IPJLParser instance

◆ setFlattenRops()

virtual void JawsMako::IPCL5Input::setFlattenRops ( bool flatten )

pure virtual

Set whether ROPs should be flattened.

Please see setRopResolution() for information on ROPs.

      If false, the input will not flatten ROPs. As a result the DOM that
      is produced will not be visually correct. Instead, the ROP components
      will appear in the DOM as distinct objects grouped in a special
      IDOMGroup.

      This mode is useful if only information about the job is required.
      ROPs may be expensive especially for pathological cases which use
      large amounts of overdraw. If we merely need to know what text is on
      a page, the number of pages, whether the content is black and white or
      color etc., then flattening ROPs may significantly slow processing for
      no benefit. Setting this parameter false will avoid that processing.

      The default is true; ROPs will be flattened.

      If false, the ROPs will appear in the DOM inside groups with properties
      denoting their purpose. The operands for a ROP will be stored inside an
      IDOMGroup that is tagged with the property (see IDOMNode::getProperty())
      "RopGroup". Inside that group will be up to two nodes that represent the
      ROP operands. These will be tagged with the property "RopSource" for the
      source operand, and "RopPaint" for the paint operand. The value of these
      properties is irrelevant; only their presence is important.

Parameters

flatten True to flatten ROPs, false to avoid flattening ROPs.

◆ setIgnorePrescribe()

virtual void JawsMako::IPCL5Input::setIgnorePrescribe ( bool ignorePrescribe )

pure virtual

Set whether to ignore Kyocera PRESCRIBE commands.

      When enabled, an attempt will be made to ignore Kyocera PRESCRIBE
      commands in PCL5 streams by skipping data from the start sequence
      !R! to the end sequence EXIT;

Note: !R! may appear in PCL5 data as text and so this parameter should only be enabled when opening PCL5 streams with Kyocera PRESCRIBE.

The default is false.

Parameters

ignorePrescribe True to ignore PRESCRIBE commands, false to process them.

◆ setMediaHandler()

virtual void JawsMako::IPCL5Input::setMediaHandler ( IMediaHandler * mediaHandler )

pure virtual

Set the IMediaHandler instance to use to handle unsatisfied media requests.

Note: This routine does not take ownership of the passed pointer, which must remain allocated until after the input is complete.

Parameters

mediaHandler A smart pointer to an IMediaHandler instance.

◆ setPclVersion()

virtual void JawsMako::IPCL5Input::setPclVersion ( ePCL5Version version )

pure virtual

Set the PCL5 version to use when interpreting the stream, or ePCL5Unset to detect from any input PJL. If ePCL5Unset is used and PJL provides no hints, the job will be assumed to be PCL5c.

The default is ePCL5Unset.

Parameters

version The PCL5 version to use.

◆ setPermanentResourceStore()

virtual void JawsMako::IPCL5Input::setPermanentResourceStore ( IRCObjectPtr & permanentResourceStore )

pure virtual

Set a permanent resource store.

      Set a reference to an object used for storing PCL5 permanent resources.

      PCL5 allows certain resources, such as fonts, symbol sets and macros
      to be designated as permanent, to prevent the printer from deleting
      them during a printer reset.  This function allows reuse of these
      resources with a new IPCL5Input instance.

      This is especially useful when using a PJL parser with unencapsulated
      IPCL5Input instances, where a PJL stream may define separate PCL5 jobs
      that share permanent resources.

Parameters

permanentResourceStore Reference to a permanent resource store. Setting the reference to a NULL object sets the object to a newly created store, which will be populated with any permanent resources.

A non-null value sets the permanent resource store to an existing store. An exception will be thrown if the value is not NULL and is not a valid resource store obtained from a previous call to setPermanentResourceStore().

◆ setRopResolution()

virtual void JawsMako::IPCL5Input::setRopResolution ( uint32 resolution )

pure virtual

Set the resolution to be used when flattening ROPs.

      PCL5, just as PCL/XL, features a method of using bitwise
      operations to composite pixels from patterns and images
      with content already on the page. These are known as ROPs
      (Raster OPerations). These are not compatible with the DOM
      and most other PDLs, and in many situations require
      rendering at the input stage.

      This parameter controls the rendering resolution. The default
      is 600dpi.

Parameters

resolution The ROP rendering resolution to use.

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

jawsmako/pcl5input.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ePCL5Version

Constructor & Destructor Documentation

◆ ~IPCL5Input()

Member Function Documentation

◆ addInternalFont()

◆ create()

◆ enableUnencapsulatedMode()

◆ setDefaultCopies()

◆ setDefaultDuplex()

◆ setDefaultDuplexBindingMode()

◆ setDefaultEdgeToEdge()

◆ setDefaultLandscape()

◆ setDefaultManualFeed()

◆ setDefaultPaperSize()

◆ setDefaultsFromPjl()

◆ setFlattenRops()

◆ setIgnorePrescribe()

◆ setMediaHandler()

◆ setPclVersion()

◆ setPermanentResourceStore()

◆ setRopResolution()