#include <IGalleyFitCalculator.h>

Inheritance diagram for IGalleyFitCalculator:

Public Types
enum	{ kDefaultIID = IID_IGALLEYFITCALCULATOR }

Public Member Functions
virtual void	SetDocRef (const UIDRef &docRef)=0

virtual UIDRef	GetDocRef ()=0

virtual void	SetStoryRef (const UIDRef &storyRef)=0

virtual UIDRef	GetStoryRef ()=0

virtual void	SetFitControl (bool16 useCachedLineCount=kFalse, bool16 updateFit=kTrue)=0

virtual void	SetFitType (IGalleyInfoUtils::FitType fitType)=0

virtual IGalleyInfoUtils::FitType	GetFitType ()=0

virtual void	SetCharCount (int32 charCount)=0

virtual int32	GetCharCount ()=0

virtual void	SetLineCount (int32 lineCount)=0

virtual int32	GetLineCount ()=0

virtual void	SetLastLineVPos (PMReal lastLineVPos)=0

virtual PMReal	GetLastLineVPos ()=0

virtual void	SetLastLineHeight (PMReal lastLineHeight)=0

virtual PMReal	GetLastLineHeight ()=0

virtual void	SetLastValidFrame (const UIDRef &frameRef)=0

virtual UIDRef	GetLastValidFrame ()=0

virtual void	SetFirstOverflowLine (int32 firstOverflowLine)=0

virtual int32	GetFirstOverflowLine ()=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

This interface is a data interface associated with the fit widget. It contains or calculates information related to how close a story is to fit. The widget uses this information to display a percentage fit bar.

Member Function Documentation

virtual int32 IGalleyFitCalculator::GetCharCount ( )

pure virtual

Current cached character count

Returns: character count.

virtual UIDRef IGalleyFitCalculator::GetDocRef ( )

pure virtual

Get a document reference that the fit calculations are performed on

Returns: a document reference.

virtual int32 IGalleyFitCalculator::GetFirstOverflowLine ( )

pure virtual

Not used. Get index of first line in overset

Returns: cached lindex of first line in overset

virtual IGalleyInfoUtils::FitType IGalleyFitCalculator::GetFitType ( )

pure virtual

Get the current fit type used to decide what type string to display in the fit control (words, lines, depth).

Returns: kDepthFit, kWordCountFit, kLineCountFit or kPageFit.

virtual PMReal IGalleyFitCalculator::GetLastLineHeight ( )

pure virtual

Not used. Height of the last line in the story.

Returns: cached last line in story height

virtual PMReal IGalleyFitCalculator::GetLastLineVPos ( )

pure virtual

Not used. Vertical position of the last line of text

Returns: cached last line v pos

virtual UIDRef IGalleyFitCalculator::GetLastValidFrame ( )

pure virtual

Not used. Last text frame that has text in it.

Returns: cached last valid frame ref

virtual int32 IGalleyFitCalculator::GetLineCount ( )

pure virtual

How many lines are there in the story. Optional data, information required only if calling SetFitControl with useCachedLineCount == kTrue

Returns: line count.

virtual UIDRef IGalleyFitCalculator::GetStoryRef ( )

pure virtual

Get the text story reference that fit information is calculated for.

Returns: a text story reference.

virtual void IGalleyFitCalculator::SetCharCount ( int32 charCount )

pure virtual

How many characters are there in the story. Optional data, information required only if calling SetFitControl with useCachedLineCount == kTrue

Parameters

charCount - character count

virtual void IGalleyFitCalculator::SetDocRef ( const UIDRef & docRef )

pure virtual

Set a document reference that the fit calculations will be performed on

Parameters

docRef the document reference to perform the calculations on

virtual void IGalleyFitCalculator::SetFirstOverflowLine ( int32 firstOverflowLine )

pure virtual

Not used. Set index of first line in overset

Parameters

firstOverflowLine - index of first line in overset

virtual void IGalleyFitCalculator::SetFitControl	(	bool16	useCachedLineCount = `kFalse`,
		bool16	updateFit = `kTrue`
	)

pure virtual

Cause the fit information to be calculated and the fit widget to be updated.

Parameters

useCachedLineCount	obsolete to be removed
updateFit	kTrue to invalidate the fit widget for draw

virtual void IGalleyFitCalculator::SetFitType ( IGalleyInfoUtils::FitType fitType )

pure virtual

Get the current fit type used to decide what type string to display in the fit control (words, lines, depth).

Parameters

fitType - pass the type fit that the ui should display. Must have set the corresponding fields in this interface to use the correct values.

virtual void IGalleyFitCalculator::SetLastLineHeight ( PMReal lastLineHeight )

pure virtual

Not used. Height of the last line in the story.

Parameters

lastLineHeight - last line in story height

virtual void IGalleyFitCalculator::SetLastLineVPos ( PMReal lastLineVPos )

pure virtual

Not used. Vertical position of the last line of text extracted from waxLine->GetYPosition()

Parameters

lastLineVPos - position of line

virtual void IGalleyFitCalculator::SetLastValidFrame ( const UIDRef & frameRef )

pure virtual

Not used. Last text frame that has text in it.

Parameters

frameRef - last valid frame ref

virtual void IGalleyFitCalculator::SetLineCount ( int32 lineCount )

pure virtual

Set how many lines are there in the story. Optional data, information required only if calling SetFitControl with useCachedLineCount == kTrue

Parameters

lineCount - line count

virtual void IGalleyFitCalculator::SetStoryRef ( const UIDRef & storyRef )

pure virtual

Set a story to perform fit calculations on.

Parameters

storyRef the story to set the interface to look at

Public Types

Public Member Functions

Detailed Description

Member Function Documentation