Mako 7.3.0 API
JawsMako::IIJPDSInput Class Reference

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

#include <ijpdsinput.h>

Inheritance diagram for JawsMako::IIJPDSInput:

Static Public Member Functions

static JAWSMAKO_API IIJPDSInputPtr create (const IJawsMakoPtr &jawsMako, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
 Create an input for reading source documents in IJPDS 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

- 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 &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. 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...
 
- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

An instance of the JawsMako IJPDS input class.

Member Function Documentation

◆ create()

static JAWSMAKO_API IIJPDSInputPtr JawsMako::IIJPDSInput::create ( const IJawsMakoPtr &  jawsMako,
const IProgressMonitorPtr &  progressMonitor = IProgressMonitorPtr() 
)
static

Create an input for reading source documents in IJPDS format.

Parameters
jawsMakoThe IJawsMako object
progressMonitorA smart pointer to an IProgressMonitor object which can be NULL if no such object was passed in.
Returns
IIJPDSInputPtr the IJPDS input

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