PsCommand Struct Reference

PsCommand class. More...

#include <pdfix.h>

Public Member Functions
virtual bool	LoadParamsFromStream (PsStream *params, PsDataFormat format)=0
	Set command parameters defined by the JSON stream. More...
virtual bool	Reset ()=0
virtual bool	SaveOutputToStream (PsStream *stream, PsDataFormat format, PdfSaveFlags flags)=0
virtual bool	SaveCommandsToStream (PsCommandType type, PsStream *stream, PsDataFormat format, PdfSaveFlags flags)=0
virtual bool	SetSelection (PdfSelection *selection)=0
	Set selection that is used for command. More...
virtual bool	Run ()=0
	Execute command. More...

Detailed Description

PsCommand class.

A PsCommand represents an action that the user can perform on the PDF document. Specifically, a PsCommand represents a command which can be added to a command sequence and executed either interactively or via batch processing.

Member Function Documentation

LoadParamsFromStream()

virtual bool PsCommand::LoadParamsFromStream ( PsStream *  params, PsDataFormat  format  )

pure virtual

Set command parameters defined by the JSON stream.

Parameters

params	The command data stream
format	Command stream format json/xml

Run()

virtual bool PsCommand::Run ( )

pure virtual

Execute command.

Returns

type of the render device context

SetSelection()

virtual bool PsCommand::SetSelection ( PdfSelection *  selection )

pure virtual

Set selection that is used for command.

Parameters

selection

The selection which holds objects to run the command on or nullptr to run on the whole document