JawsMako::IPSInput Class Reference

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

#include <jawsmako/psinput.h>

Inheritance diagram for JawsMako::IPSInput:

Public Member Functions
virtual	~IPSInput ()=default
virtual void	enableUnencapsulatedMode (bool unencapsulated)=0
	Enable or disable unencapsulated mode.
virtual void	setProlog (const IInputStreamPtr &prolog)=0
	Set a prolog stream to be consumed by the PostScript interpreter before the input stream is processed, or NULL to clear.
virtual IDistillerPtr	getDistiller () const =0
	Return a smart pointer to the underlying IDistiller object.
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 IPSInputPtr	create (const IJawsMakoPtr &jawsMako, bool eps=false, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
	Create an input for reading source documents in PostScript 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 PS input class.

Constructor & Destructor Documentation

~IPSInput()

virtual JawsMako::IPSInput::~IPSInput ( )

virtualdefault

Member Function Documentation

create()

JAWSMAKO_API IPSInputPtr JawsMako::IPSInput::create ( const IJawsMakoPtr & jawsMako, bool eps = false, const IProgressMonitorPtr & progressMonitor = IProgressMonitorPtr() )

static

Create an input for reading source documents in PostScript format.

The IPSInput interface allows PostScript to be imported into JawsMako. The input PostScript is converted to PDF and then read in using the IPDFInput interface.

Parameters

jawsMako	The IJawsMako object.
eps	Whether the source is Encapsulated PostScript. The default is false.
progressMonitor	A smart pointer to an IProgressMonitor object which can be NULL if no such object was passed in.

Returns

IPSInputPtr the PS input.

enableUnencapsulatedMode()

virtual void JawsMako::IPSInput::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 PostScript stream.
      - The PostScript interpreter will not consume data after the point the
        interpreter either exhausts the stream or a UEL is encountered.

      Whereas the default (false) will:

      - open() the input stream.
      - attempt to consume the entire stream.

      As such unencapsulated mode will only work with the stream version of IInput::open().

Parameters

unencapsulated

Whether to enable unencapsulated mode or not.

getDistiller()

virtual IDistillerPtr JawsMako::IPSInput::getDistiller ( ) const

pure virtual

Return a smart pointer to the underlying IDistiller object.

     This may be used for additional configuration prior to opening the PostScript source.

     IPSInput options will override IDistiller options, for example if setProlog()
     is used to set a prolog stream on both the IPSInput object and the underlying
     IDistiller object, only the stream set on the IPSInput object will apply.

Returns

IDistillerPtr the underlying IDistiller object.

setProlog()

virtual void JawsMako::IPSInput::setProlog ( const IInputStreamPtr & prolog )

pure virtual

Set a prolog stream to be consumed by the PostScript interpreter before the input stream is processed, or NULL to clear.

This stream will be both opened and closed, and will not be cloned; take care when opening multiple PostScript inputs with the same prolog simultaneously.

Parameters

prolog

The prolog stream to use.

---

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

• jawsmako/psinput.h