IFrameType Class Reference

Inheritance diagram for IFrameType:

Public Types
enum	{ kDefaultIID = IID_IFRAMETYPE }
enum	FrameType {   kNotAFrame, kGraphicFrame, kEmptyGraphicFrame, kGraphicFrameWithPlaceHolder,   kTextFrame, kEmptyTextFrame, kEndnoteTextFrame }

Public Member Functions
virtual FrameType	GetFrameType () const =0
virtual bool16	IsGraphicFrame () const =0
virtual bool16	IsTextFrame () const =0
virtual bool16	IsAFrame () const =0
virtual bool16	IsNotAFrame () const =0
virtual bool16	IsEmpty () const =0
virtual bool16	IsLogicallyEmpty () const =0
virtual bool16	IsEndnoteTextFrame () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Function Documentation

virtual FrameType IFrameType::GetFrameType ( ) const

pure virtual

Interface on all spline page items. Returns the type of frame that the

spline represents. If the spline is not a frame (a simple page item)

kNotAFrame is returned.

Returns

FrameType.

virtual bool16 IFrameType::IsAFrame ( ) const

pure virtual

Helper method that relies on GetFrameType().

Returns

kTrue if the object is a frame, not a simple page item.

virtual bool16 IFrameType::IsEmpty ( ) const

pure virtual

Helper method that relies on GetFrameType().

NOTE: "empty" means "no content, not even a placeholder".

Returns

kTrue if the object is "empty".

virtual bool16 IFrameType::IsEndnoteTextFrame ( ) const

pure virtual

Helper method that checks whether this text frame belongs to an endnotes story.

Returns

kTrue if the text frame belongs to an endnotes story.

virtual bool16 IFrameType::IsGraphicFrame ( ) const

pure virtual

Helper method that relies on GetFrameType().

Returns

kTrue if the frame either holds an image or potentially does.

virtual bool16 IFrameType::IsLogicallyEmpty ( ) const

pure virtual

Helper method that relies on GetFrameType().

NOTE: "logically empty" includes graphic frames with placeholder content.

Returns

kTrue if the object is "logically empty".

virtual bool16 IFrameType::IsNotAFrame ( ) const

pure virtual

Helper method that relies on GetFrameType().

Returns

kTrue if the object is a page item, but not a frame.

virtual bool16 IFrameType::IsTextFrame ( ) const

pure virtual

Helper method that relies on GetFrameType().

Returns

kTrue if the frame either contains text or potentially does.