IHTMLPageItemAttributes Class Reference

#include <IHTMLPageItemAttributes.h>

Inheritance diagram for IHTMLPageItemAttributes:

Public Types
enum	{ kDefaultIID = IID_IHTMLPAGEITEMATTRIBUTES }

Public Member Functions
virtual void	SetHasFixedDimensions (bool32 isFixed)=0
virtual bool32	GetHasFixedDimensions () const =0
virtual ErrorCode	SetRelativeURIToHTMLFile (const WideString *relativePosixPath)=0
virtual void	GetRelativeURIToHTMLFile (WideString &relativePosixPath) const =0
virtual ErrorCode	CopyFrom (IHTMLPageItemAttributes *srcAttrs)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

IHTMLPageItemAttributes are a collection of attributes or options on the embedded HTML which are used for such things as deciding how the iframe that wraps the HTML is transformed in response to liquid layout rules.

Member Function Documentation

virtual ErrorCode IHTMLPageItemAttributes::CopyFrom ( IHTMLPageItemAttributes *  srcAttrs )

pure virtual

A convenience function for clients so that they do not need to be updated if new data members are added to this interface in the future. This function simply copies the data from the provided srcAttrs into 'this.'

Parameters

srcAttrs

[IN] The attributes to copy from

virtual bool32 IHTMLPageItemAttributes::GetHasFixedDimensions ( ) const

pure virtual

Is this HTML a fixed size or is it liquid in nature such that if the parent div or iframe is resized, it can adapt its contents to fit the new dimensions? If it is fixed size, then we must scale the parent element. If it is not fixed size, we can resize the parent element.

Returns

true if it is fixed size and hence must be scaled. false if it is liquid in nature.

virtual void IHTMLPageItemAttributes::GetRelativeURIToHTMLFile ( WideString &  relativePosixPath ) const

pure virtual

Placed HTML comes into InDesign as a packaged file where the actual HTML file is embedded somewhere within the package. On HTML export, we need to build a relative path to the HTML file to use as the 'src' of an 'iframe'. This field helps us to do that.

Parameters

relativePosixPath

[OUT] a Posix subpath within the placed package to the actual HTML file, relative to the uncompressed package folder.

virtual void IHTMLPageItemAttributes::SetHasFixedDimensions ( bool32  isFixed )

pure virtual

Set whether or not the dimensions of this HTML is intrinsically fixed.

Parameters

isFixed

[IN] true if dimensions are fixed, false if liquid.

virtual ErrorCode IHTMLPageItemAttributes::SetRelativeURIToHTMLFile ( const WideString *  relativePosixPath )

pure virtual

Placed HTML comes into InDesign as a packaged file where the actual HTML file is embedded somewhere within the package. On HTML export, we need to build a relative POSIX path to the HTML file to use as the 'src' of an 'iframe'. This field helps us to do that.

Parameters

relativePosixPath

[IN] subpath within the placed package to the actual HTML file, relative to the uncompressed package folder.

Returns

an ErrorCode (kSuccess if successful).