JawsMako::IPPMLInput Class Reference

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

#include <jawsmako/ppmlinput.h>

Inheritance diagram for JawsMako::IPPMLInput:

Public Member Functions
virtual	~IPPMLInput ()
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 IPPMLInputPtr	create (const IJawsMakoPtr &jawsMako, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
	Create an input for reading source documents in PPML 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 PPML input class.

Constructor & Destructor Documentation

~IPPMLInput()

virtual JawsMako::IPPMLInput::~IPPMLInput ( )

inlinevirtual

Member Function Documentation

create()

JAWSMAKO_API IPPMLInputPtr JawsMako::IPPMLInput::create ( const IJawsMakoPtr & jawsMako, const IProgressMonitorPtr & progressMonitor = IProgressMonitorPtr() )

static

Create an input for reading source documents in PPML 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

IPPMLInputPtr the PPML input

---

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

• jawsmako/ppmlinput.h