Mako 8.2.0 API
MakoCore SDK API Documentation
Loading...
Searching...
No Matches
JawsMako::IPageCropperTransform Class Referenceabstract

Very simple transform for cropping pages to one of the standard boxes. More...

#include <jawsmako/transforms.h>

Inheritance diagram for JawsMako::IPageCropperTransform:
[legend]

Public Types

enum  eBox { eBCrop , eBContent , eBTrim , eBBleed }
 Enumeration of standard boxes. More...
typedef enum JawsMako::IPageCropperTransform::eBox eBox
 Enumeration of standard boxes.

Public Member Functions

virtual void setCropBox (eBox cropBox)=0
 Sets the box to crop to. The default is the crop box.
virtual void setShouldClip (bool clip)=0
 Sets whether or not the area being cropped should be clipped also. The default is true.
Public Member Functions inherited from JawsMako::ITransform
virtual ~ITransform ()
virtual IDOMBrushPtr transform (const IDOMBrushPtr &brush, eBrushUsage usage=eBUGeneral, const CTransformState &state=CTransformState())=0
 Apply the transform to the given brush, if applicable. These transforms are thread safe.
virtual IDOMImagePtr transform (const IDOMImagePtr &image, const CTransformState &state=CTransformState())=0
 Apply the transform to the given image, if applicable. These transforms are thread safe.
virtual IDOMColorPtr transform (const IDOMColorPtr &color, const CTransformState &state=CTransformState())=0
 Apply the transform to the given color, if applicable. These transforms are thread safe.
virtual IDOMColorSpacePtr transform (const IDOMColorSpacePtr &colorSpace, const CTransformState &state=CTransformState())=0
 Apply the transform to the given color space, if applicable. These transforms are thread safe.
virtual IDOMNodePtr transform (const IDOMNodePtr &node, bool &changed, bool transformChildren=true, const CTransformState &state=CTransformState())=0
 Apply the transform to the given node, if applicable. These transforms are thread safe, providing no other transforms are being applied to the same nodes at the same time.
virtual void transformPage (const IPagePtr &page, bool transformContent=true, bool transformAnnotations=true)=0
 Apply the transform to the given page, if applicable. These transforms are thread safe, providing no other transforms are being applied to the same nodes at the same time. The transform will also apply to the annotations appearances.
virtual void flushCaches ()=0
 Flush the caches used by the transform. Most transforms cache recently transformed results to improve the performance of repeated transformations of equivalent results. However, it is possible that some cached results may point to entities that no longer exist, such as content inside an XPS file that no longer exists. If you are deleting or replacing files where transforms have been used, it is advisable to invoke this routine to clear the caches.
virtual void setProgressMonitor (const IProgressMonitorPtr &progressMonitor)=0
 Set the IProgressMonitor object for this transform to allow for monitoring the progress of the transform.
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 IPageCropperTransformPtr create (const IJawsMakoPtr &jawsMako, const IProgressMonitorPtr &progressMonitor=IProgressMonitorPtr())
 Create the transform.

Additional Inherited Members

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

Detailed Description

Very simple transform for cropping pages to one of the standard boxes.

Member Typedef Documentation

◆ eBox

Member Enumeration Documentation

◆ eBox

Enumeration of standard boxes.

Enumerator
eBCrop 

Refers to a CropBox.

eBContent 

Refers to an ArtBox.

eBTrim 

Refers to a TrimBox.

eBBleed 

Member Function Documentation

◆ create()

JAWSMAKO_API IPageCropperTransformPtr JawsMako::IPageCropperTransform::create ( const IJawsMakoPtr & jawsMako,
const IProgressMonitorPtr & progressMonitor = IProgressMonitorPtr() )
static

Create the transform.

Parameters
jawsMakoThe JawsMako instance.
progressMonitorA progress monitor for cancelling, and monitoring the job progress.
Returns
The new instance.

◆ setCropBox()

virtual void JawsMako::IPageCropperTransform::setCropBox ( eBox cropBox)
pure virtual

Sets the box to crop to. The default is the crop box.

Parameters
cropBoxThe box to crop to.

◆ setShouldClip()

virtual void JawsMako::IPageCropperTransform::setShouldClip ( bool clip)
pure virtual

Sets whether or not the area being cropped should be clipped also. The default is true.

Parameters
clipTrue or False

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