Mako 8.1.0 API
Loading...
Searching...
No Matches
JawsMako::IScanOverprint Class Referenceabstract

The interface for the object that performs scanning for overprint. More...

#include <scanoverprint.h>

Inheritance diagram for JawsMako::IScanOverprint:

Classes

class  CScanOverprintParams
 Class for storing the results of scanning for overprint in a page. More...
 

Public Member Functions

virtual bool scanPage (const IDOMFixedPagePtr &fixedPage, const CScanOverprintParamsPtr &scanOverprintParams)=0
 Scans a page for presence of overprinting.
 
- 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 IScanOverprintPtr create (const IJawsMakoPtr &jawsMako, const IProgressMonitorPtr &progressMonitor)
 Creates the object to use for scanning for overprint.
 

Additional Inherited Members

- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

The interface for the object that performs scanning for overprint.

Member Function Documentation

◆ create()

static JAWSMAKO_API IScanOverprintPtr JawsMako::IScanOverprint::create ( const IJawsMakoPtr & jawsMako,
const IProgressMonitorPtr & progressMonitor )
static

Creates the object to use for scanning for overprint.

Parameters
jawsMakoThe jawsMako object.
progressMonitorThe progress monitor.
Returns
IScanOverprintPtr The overprint scanning object.

◆ scanPage()

virtual bool JawsMako::IScanOverprint::scanPage ( const IDOMFixedPagePtr & fixedPage,
const CScanOverprintParamsPtr & scanOverprintParams )
pure virtual

Scans a page for presence of overprinting.

Parameters
fixedPageThe page to scan for overprint.
scanOverprintParamsAn object containing the results of the scan.
Returns
True if the scan indicates presence of overprint, false otherwise.

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