CHMLGraphicFrameMetaData Class Reference

#include <CHMLFiltHelper.h>

Public Types
enum	LayoutObjectType { eGraphicsFrame, eTextFrame, eUnknown }
typedef object_type	data_type

Public Member Functions
	CHMLGraphicFrameMetaData ()
	CHMLGraphicFrameMetaData (LayoutObjectType type, int32 page, const PMRect &bboxRectInPage)
	CHMLGraphicFrameMetaData (LayoutObjectType type, int32 page, const PMRect &bboxRectInPage, const PMString &datalinkpath)
LayoutObjectType	GetLayoutObjectType () const
int32	GetPage () const
PMRect	GetRectInPage () const
PMString	GetDataLinkPath () const
void	SetDataLinkPath (const PMString &path)

Detailed Description

Helper (data) class for exporting aspects of a layout.

Member Enumeration Documentation

enum CHMLGraphicFrameMetaData::LayoutObjectType

Types for the layout objects we understand

Enumerator
eGraphicsFrame	A graphics frame (that may contain an image); type from which we can get an IGraphicFrameData but iGraphicFrameData->GetTextContentUID is kInvalidUID, i.e. it can't be a text frame.
eUnknown	Some other type

Constructor & Destructor Documentation

CHMLGraphicFrameMetaData::CHMLGraphicFrameMetaData ( )

inline

Default constructor

CHMLGraphicFrameMetaData::CHMLGraphicFrameMetaData ( LayoutObjectType  type, int32  page, const PMRect &  bboxRectInPage  )

inline

Constructor

Parameters

type	IN what sort of layout object this is (from IPageItemTypeUtils. A graphics frame; IGraphicFrameData or a text frame)
page	IN which page number this object is on (absolute, not just a spread-page index)
bboxRectInPage	IN bounding box in the parent coordinate system

CHMLGraphicFrameMetaData::CHMLGraphicFrameMetaData ( LayoutObjectType  type, int32  page, const PMRect &  bboxRectInPage, const PMString &  datalinkpath  )

inline

Constructor

Parameters

type	IN what sort of layout object this is (from IPageItemTypeUtils. A graphics frame; IGraphicFrameData or a text frame)
page	IN which page number this object is on (absolute, not just a spread-page index)
bboxRectInPage	IN bounding box in the parent coordinate system
datalinkpath	IN specifies the path to the linked file

Member Function Documentation

PMString CHMLGraphicFrameMetaData::GetDataLinkPath ( ) const

inline

Accessor for path to datalinked asset represented in this

Returns

PMString

LayoutObjectType CHMLGraphicFrameMetaData::GetLayoutObjectType ( ) const

inline

Accessor for the type of this layout object

Returns

one of the enumerated LayoutObjectType values

int32 CHMLGraphicFrameMetaData::GetPage ( ) const

inline

Accessor for the page (absolute) on which this layout object is located in the publication

Returns

page on which layout object is found

PMRect CHMLGraphicFrameMetaData::GetRectInPage ( ) const

inline

Accessor for the bounding box of the layout object

Returns

PMRect giving the bounding box of the layout object in the parent coordinates

void CHMLGraphicFrameMetaData::SetDataLinkPath ( const PMString &  path )

inline

Specify the path of the datalinked file

Parameters

path	IN represents path to asset that is datalinked