Interface for the PWG Raster IOutput class. More...

#include <jawsmako/pwgoutput.h>

Inheritance diagram for JawsMako::IPWGOutput:

Public Member Functions
virtual	~IPWGOutput ()=default
virtual void	setRenderer (const IRendererPtr &renderer)=0
	Set the renderer for the content.
Public Member Functions inherited from JawsMako::IOutput
virtual	~IOutput ()=default
virtual void	setPreset (const U8String &preset)=0
	Configure the output according to a general preset. Please see the supplied documentation for details of these presets. The default is "Preserve" which will attempt to produce output as close to the input as possible for the output format. A string value can be used for any parameter and will be converted as necessary.
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.
virtual void	setAllowedPermissionsFlags (uint32 allowedPermissions)=0
	Control whether assemblies with certain security permission flags are allowed to be written by this output.
virtual void	writeAssembly (const IDocumentAssemblyPtr &assembly, const U8String &pathToFile)=0
	Write the given document assembly to a file on disk.
virtual void	writeAssembly (const IDocumentAssemblyPtr &assembly, const String &pathToFile)=0
	Write the given document assembly to a file on disk, specified by a wide character string.
virtual void	writeAssembly (const IDocumentAssemblyPtr &assembly, const IOutputStreamPtr &stream)=0
	Write the given document assembly to a stream.
virtual IOutputWriterPtr	openWriter (const IDocumentAssemblyPtr &assembly, const U8String &pathToFile)=0
	Create an output writer for the given assembly, targeting a file on disk. This is designed to allow streaming output, or to deal with situations where an operation would require too much memory to hold an entire edited assembly in memory at once.
virtual IOutputWriterPtr	openWriter (const IDocumentAssemblyPtr &assembly, const String &pathToFile)=0
	Create an output writer for the given assembly, targeting a file on disk. As above, but with the file specified in a wide character string.
virtual IOutputWriterPtr	openWriter (const IDocumentAssemblyPtr &assembly, const IOutputStreamPtr &stream)=0
	Create an output writer for the given assembly, targeting a stream.
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 IPWGOutputPtr	create (const IJawsMakoPtr &jawsMako, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
	Create a PWG Output instance.
Static Public Member Functions inherited from JawsMako::IOutput
static JAWSMAKO_API IOutputPtr	create (const IJawsMakoPtr &jawsMako, eFileFormat format, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
	Create an output for writing source in the given format.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Interface for the PWG Raster IOutput class.

Constructor & Destructor Documentation

◆ ~IPWGOutput()

virtual JawsMako::IPWGOutput::~IPWGOutput ( )

virtualdefault

Member Function Documentation

◆ create()

JAWSMAKO_API IPWGOutputPtr JawsMako::IPWGOutput::create	(	const IJawsMakoPtr &	jawsMako,
		const IProgressMonitorPtr &	progressMonitor = IProgressMonitorPtr() )

static

Create a PWG Output instance.

Parameters

jawsMako	The JawsMako instance.
progressMonitor	The progress monitor which allows aborting an operation or registering a progress callback.

Returns: IPWGOutputPtr A smart pointer to the PWG output instance.

◆ setRenderer()

virtual void JawsMako::IPWGOutput::setRenderer ( const IRendererPtr & renderer )

pure virtual

Set the renderer for the content.

Parameters

renderer A smart pointer to the IRenderer instance.

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

jawsmako/pwgoutput.h

Public Member Functions