An instance of the JawsMako PCL5 input class. More...
#include <pcl5input.h>
Public Member Functions | |
virtual void | setRopResolution (uint32 resolution)=0 |
Set the resolution to be used when flattening ROPs. More... | |
virtual void | setFlattenRops (bool flatten)=0 |
Set whether or not ROPs should be flattened. More... | |
virtual void | setDefaultPaperSize (const U8String &paperSize)=0 |
Set the default paper size. More... | |
virtual void | setDefaultLandscape (bool landscape)=0 |
Set the default orientation. More... | |
virtual void | setDefaultCopies (uint32 copies)=0 |
Set the default number of per-page copies. More... | |
virtual void | setDefaultDuplex (bool duplex)=0 |
Set whether or not duplex should be set by default. More... | |
virtual void | setDefaultDuplexBindingMode (IPJLParser::eDuplexBindingMode bindingMode)=0 |
Set the default binding edge for duplexing. More... | |
virtual void | setDefaultManualFeed (bool manualFeed)=0 |
Set whether or not manual feed should be set by default. More... | |
virtual void | setDefaultsFromPjl (IPJLParserPtr &pjlParser)=0 |
Take initialisation data from the given PJL parser. More... | |
virtual void | enableUnencapsulatedMode (bool unencapsulated)=0 |
Enable or disable unencapsulated mode. More... | |
virtual void | setMediaHandler (IMediaHandler *mediaHandler)=0 |
Set the IMediaHandler instance to use to handle unsatisfied media requests. More... | |
virtual void | setIgnorePrescribe (bool ignorePrescribe)=0 |
Set whether or not to ignore Kyocera PRESCRIBE commands. More... | |
Public Member Functions inherited from JawsMako::IInput | |
virtual IDocumentAssemblyPtr | open (const U8String &pathToFile)=0 |
Open a file on disk, returning the IDocumentAssembly representing the contents. More... | |
virtual IDocumentAssemblyPtr | open (const String &pathToFile)=0 |
Open a file on disk, returning the IDocumentAssembly representing the contents. Takes a wide character string. More... | |
virtual IDocumentAssemblyPtr | open (const IInputStreamPtr &inputStream)=0 |
Open a stream, returning the IDocumentAssembly representing the contents. More... | |
virtual void | setSequentialMode (bool sequential)=0 |
Set/unset sequential mode on this input. More... | |
virtual void | setParameter (const U8String ¶m, 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. More... | |
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. More... | |
virtual int32 | getRefCount () const =0 |
Retrieve the current reference count of the actual object pointed to. More... | |
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. More... | |
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: More... | |
Additional Inherited Members | |
Protected Member Functions inherited from IRCObject | |
virtual | ~IRCObject () |
Virtual destructor. | |
An instance of the JawsMako PCL5 input class.
|
static |
Create an input for reading source documents in PCL5 format.
jawsMako | The IJawsMako object |
progressMonitor | A smart pointer to an IProgressMonitor object which can be NULL if no such object was passed in. |
|
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 interupted by returning to PJL.
|
pure virtual |
Set the default number of per-page copies.
The default is 1. Must be greater than zero.
|
pure virtual |
Set whether or not duplex should be set by default.
The default is false.
|
pure virtual |
Set the default binding edge for duplexing.
The default is long edge.
|
pure virtual |
Set the default orientation.
Pass true to set landscape, or false to set portrait. The default is portrait.
|
pure virtual |
Set whether or not manual feed should be set by default.
The default is false.
|
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
|
pure virtual |
Take initialisation 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.
|
pure virtual |
Set whether or not 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.
flatten | True to flatten ROPs, false to avoid flattening ROPs. |
|
pure virtual |
Set whether or not 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.
|
pure virtual |
Set the IMediaHandler instance to use to handle unsatisfied media requests.
Note that this routine does not take ownership of the passed pointer, which must remain allocated until after the input is complete.
|
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.
resolution | The ROP rendering resolution to use. |