JawsMako::IPRNInput Class Reference

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

#include <jawsmako/prninput.h>

Inheritance diagram for JawsMako::IPRNInput:

Public Member Functions
virtual	~IPRNInput ()
virtual void	setIgnorePrescribe (bool ignorePrescribe)=0
	Set whether to ignore Kyocera PRESCRIBE commands.
virtual void	setPclVersion (IPCL5Input::ePCL5Version version)=0
	Set the version of PCL5 to interpret any PCL5 content present in the PRN stream or ePCL5Unset to detect from any input PJL. If ePCL5Unset is used and PJL provides no hints, any PCL5 content in the print stream will be assumed to be PCL5c.
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 IPRNInputPtr	create (const IJawsMakoPtr &jawsMako)
	Create an input for reading printer (PRN) source documents.
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 PRN input class.

Constructor & Destructor Documentation

~IPRNInput()

virtual JawsMako::IPRNInput::~IPRNInput ( )

inlinevirtual

Member Function Documentation

create()

JAWSMAKO_API IPRNInputPtr JawsMako::IPRNInput::create ( const IJawsMakoPtr & jawsMako )

static

Create an input for reading printer (PRN) source documents.

The IPRNInput interface allows PRN documents to be imported into JawsMako. These are files that have a PJL header and one or more documents in a given PDL, immediately preceded by a @PJL ENTER LANGUAGE tag. The language tags that are currently recognized are PCL, PCLXL, HPGL2, POSTSCRIPT and PDF.

Parameters

jawsMako

The IJawsMako object

Returns

IPRNInputPtr the PRN input

setIgnorePrescribe()

virtual void JawsMako::IPRNInput::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 that !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

Whether to ignore PRESCRIBE commands.

setPclVersion()

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

pure virtual

Set the version of PCL5 to interpret any PCL5 content present in the PRN stream or ePCL5Unset to detect from any input PJL. If ePCL5Unset is used and PJL provides no hints, any PCL5 content in the print stream will be assumed to be PCL5c.

The default is ePCL5Unset.

Parameters

version

The PCL5 version to use.

---

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

• jawsmako/prninput.h