#include <ITextFrameColumn.h>

Inheritance diagram for ITextFrameColumn:

Public Types
enum	{ kDefaultIID = IID_ITEXTFRAMECOLUMN }

Public Member Functions
virtual IMultiColumnTextFrame *	QueryMultiColumnTextFrame () const =0

virtual void	SetFrameListUID (UID frameListUID)=0

virtual UID	GetFrameListUID () const =0

virtual IFrameList *	QueryFrameList () const =0

virtual UID	GetTextModelUID () const =0

virtual ITextModel *	QueryTextModel () const =0

virtual IStoryOptions *	QueryStoryOptions () const =0

virtual PMReal	HitTestFrame (const PMPoint &pPt, bool16 composeFirst, TextIndex *nextLine, bool16 primarySTOnly=kTrue)=0

virtual bool16	GetIsEmpty () const =0

virtual void	GetHierarchyChildren (UIDList &childList) const =0

virtual void	AddHierarchyChild (const IInlineData *id)=0

virtual void	RemoveHierarchyChild (const IInlineData *id)=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

Text support for PageItems. Currently kFrameItemBoss implements this interface. kFrameItemBoss is a child of kMultiColumnItemBoss.

Member Function Documentation

virtual void ITextFrameColumn::AddHierarchyChild ( const IInlineData * id )

pure virtual

Add an Inline as being associated with this TextFrameColumn.

virtual UID ITextFrameColumn::GetFrameListUID ( ) const

pure virtual

Reports which IFrameList this ITextFrameColumn is contained in. Note that for the kMultiColumnItemBoss this will be the IFrameList its children ITextFrames are part of.

Returns: UID of the containing IFrameList.

virtual void ITextFrameColumn::GetHierarchyChildren ( UIDList & childList ) const

pure virtual

Appends to the list the Inlines which claim this TextFrameColumn when IInlineData::GetTextFrameRef() is called. Thus by definition only Inlines which are properly registered are returned by this call.

Parameters

childList Reference to UIDList

virtual bool16 ITextFrameColumn::GetIsEmpty ( ) const

pure virtual

Reports the state of Text content in the ITextFrameColumn.

Returns: kTrue if the TextFrame has no content in it. Note that a TextFrame with a TextSpan of zero can still have other content such as Footnotes.

virtual UID ITextFrameColumn::GetTextModelUID ( ) const

pure virtual

Reports which ITextModel this ITextFrameColumn is associated with.

Returns: UID of ITextModel this ITextFrameColumn is associated with.

virtual PMReal ITextFrameColumn::HitTestFrame	(	const PMPoint &	pPt,
		bool16	composeFirst,
		TextIndex *	nextLine,
		bool16	primarySTOnly = `kTrue`
	)

pure virtual

Determine the closest TextIndex to the specified Pasteboard point. NOTE: If the passed in point is outside the boundary of the frame, this method still returns the text index of the closest character.

Parameters

pPt	Point in pasteboard coordinates
composeFirst	If kTrue and the Frame requires composition, then the Frame is composed before computing the hit.
nextLine	If non-nil and a hit is registered, set to the TextIndex of the next WaxLine.
primarySTOnly	If kTrue, then only WaxLines in the Frame are examined. Otherwise the method will burrow into objects such as Tables and Footnotes within the Frame to find the closest hit.

Returns: The TextIndex of the closest character/glyph within the Frame or kInvalidTextIndex if nothing is hit.

virtual IFrameList* ITextFrameColumn::QueryFrameList ( ) const

pure virtual

Reports the IFrameList this ITextFrameColumn is contained in. Note that for the kMultiColumnItemBoss this will be the IFrameList its children ITextFrames are part of.

Returns: A pointer to the containing IFrameList.

virtual IMultiColumnTextFrame* ITextFrameColumn::QueryMultiColumnTextFrame ( ) const

pure virtual

Returns a point to the parent MultiColumnTextFrame

Returns: Pointer to MultiColumnTextFrame parent

virtual IStoryOptions* ITextFrameColumn::QueryStoryOptions ( ) const

pure virtual

Reports which IStoryOptions this ITextFrameColumn is associated with.

Returns: A pointer to the IStoryOptions this ITextFrameColumn is associated with.

virtual ITextModel* ITextFrameColumn::QueryTextModel ( ) const

pure virtual

Reports which ITextModel this ITextFrameColumn is associated with.

Returns: A pointer to the ITextModel this ITextFrameColumn is associated with.

virtual void ITextFrameColumn::RemoveHierarchyChild ( const IInlineData * id )

pure virtual

Remove an Inline from being associated with this TextFrameColumn.

virtual void ITextFrameColumn::SetFrameListUID ( UID frameListUID )

pure virtual

Sets the IFrameList this ITextFrameColumn is contained in. This method should only be called by the methods of IFrameList.

Parameters

frameListUID UID of the containing IFrameList.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation