Page in the document. More...

Public Member Functions
void	GetDimensions (float &, float &) const

bool	ApplyBox (const char *)

void	SetDimensions (float, float)

AOI_Object_LayerPtr	GetFirstLayer () const

AOI_ColorSpacePtr	GetPageColorSpace () const

void	RemoveBlendingSpace ()

Detailed Description

Page in the document.

Definition at line 10 of file AOI_Page.h.

Member Function Documentation

◆ ApplyBox()

bool AOI_Page::ApplyBox ( const char * boxName )

    Applies crop box on page
    \param boxName Variable that specifies what box to be applied; the following values can be passed
                                    "MediaBox", "CropBox", "BleedBox", "TrimBox", "ArtBox"

See also: ApplyCropBox

Definition at line 32 of file AOI_Page.cpp.

◆ GetDimensions()

void AOI_Page::GetDimensions	(	float &	width,
		float &	height ) const

Returns the dimensions of the page in AOI units.

Parameters

width	Variable that receives the width.
height	Variable that receives the height.

See also: SetDimensions

Definition at line 21 of file AOI_Page.cpp.

◆ GetFirstLayer()

AOI_Object_Layer * AOI_Page::GetFirstLayer ( ) const

Returns the first layer of the page. The first layer is the layer that appears on the bottom of the page.

Returns: Pointer to a layer object.

Definition at line 55 of file AOI_Page.cpp.

◆ GetPageColorSpace()

AOI_ColorSpace * AOI_Page::GetPageColorSpace ( ) const

Returns the colorspace of the page. This call may result in a NULL pointer when no page colorspace is defined. Page colorspaces are commonly defined when a multipage TIFF with embedded profiles is loaded, in such document this call returns the page ICC profile colorspace.

Returns: Page colorspace object. NULL when no page colorspace is defined.

Definition at line 68 of file AOI_Page.cpp.

◆ RemoveBlendingSpace()

void AOI_Page::RemoveBlendingSpace ( )

Remove the blending space from the page and uses the renderer space as blending space.

Definition at line 77 of file AOI_Page.cpp.

◆ SetDimensions()

void AOI_Page::SetDimensions	(	float	width,
		float	height )

Changes the dimensions of the page.