IMultiColumnTextFrame.h

//========================================================================================
// 
// $File$
// 
// Owner: dwaterfa
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// The IMultiColumnTextFrame interface exists on a kMultiColumnItemBoss.
// kMultiColumnItemBoss is within a graphic frame (which may be any spline
// shape).
// 
// The IMultiColumnTextFrame interface holds information on the relationship
// between multi column text and the story displayed in the multi column frame
// item. The children (by IHierarchy) of the IMultiColumnTextFrame are one or
// more ITextFrameColumn(s).
// 
//========================================================================================

#ifndef __IMultiColumnTextFrame__
#define __IMultiColumnTextFrame__

#include "IPMUnknown.h"
#include "IFrameList.h"
#include "ITextParcelList.h"
#include "TextID.h"
#include "CTextEnum.h"
#include "PMRect.h"
#include "IReferencePointData.h"

class ITextModel;
class PMPoint;
class IdleTimer;
class ITextFrameColumn;
class IStoryOptions;
class IParcel;
class ITextColumnSizer;

class IMultiColumnTextFrame : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IMULTICOLUMNTEXTFRAME };

 virtual TextIndex TextStart() const = 0;

 virtual int32 TextSpan() const = 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 ITextFrameColumn* QueryFrameInFrameList() const = 0;

 virtual UID GetUIDInFrameList(bool16 getLast = kFalse) const = 0;

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

 virtual void SetFirstLineOffsetMetric(Text::FirstLineOffsetMetric nFirstLineOffset) = 0;

 virtual Text::FirstLineOffsetMetric GetFirstLineOffsetMetric() const = 0;

 virtual void SetMinFirstLineOffset(PMReal x) = 0;

 virtual PMReal GetMinFirstLineOffset() const = 0;

 virtual void SetVerticalJustification(Text::VerticalJustification vj) = 0;

 virtual Text::VerticalJustification GetVerticalJustification() const = 0;

 virtual void SetMaxVJInterParaSpace(PMReal maxInterParaSpace) = 0;

 virtual PMReal GetMaxVJInterParaSpace() const = 0;

 virtual void SetVJBalanceColumns(bool16 balanced) = 0;

 virtual bool16 GetVJBalanceColumns() const = 0;

 virtual void SetAutoSizeDimension(Text::AutoSizeDimension asDimension) = 0;

 virtual Text::AutoSizeDimension GetAutoSizeDimension() const = 0;

 virtual void SetAutoSizeRefPoint(IReferencePointData::ReferencePointPosition asRefPoint) = 0;

 virtual IReferencePointData::ReferencePointPosition GetAutoSizeRefPoint() const = 0;

 virtual void SetAutoSizeHasMinHeight(bool16 asHasMinHeight) = 0;

 virtual bool16 GetAutoSizeHasMinHeight() const = 0;

 virtual void SetAutoSizeMinHeightValue(PMReal asMinHeightValue) = 0;

 virtual PMReal GetAutoSizeMinHeightValue() const = 0;

 virtual void SetAutoSizeHasMinWidth(bool16 asHasMinWidth) = 0;

 virtual bool16 GetAutoSizeHasMinWidth() const = 0;

 virtual void SetAutoSizeMinWidthValue(PMReal asMinWidthValue) = 0;

 virtual PMReal GetAutoSizeMinWidthValue() const = 0;

 virtual void SetAutoSizeNoLineBreak(bool16 asNoLineBreak) = 0;

 virtual bool16 GetAutoSizeNoLineBreak() const = 0;

 virtual PMRect CalculateNthColumnBBox(int32 n) const = 0;

 virtual bool16 GetIsFittingToContent() const = 0;

 virtual bool16 GetIsEmpty(bool16* optionalIsOnlyLastCR = nil) const = 0;

 virtual bool16 GetIgnoringTextWrap() const = 0;

 virtual bool16 GetContainsOversetContent() const = 0;

 virtual bool16 GetIsOverset() const = 0;

 virtual bool16 GetIsOnlyMCF() const = 0;

 virtual bool16 GetIsFirstMCF() const = 0;

 virtual UID GetPreviousMCFUID() const = 0;

 virtual bool16 GetIsLastMCF() const = 0;

 virtual UID GetNextMCFUID() const = 0;

 virtual int32 GetMCFIndex() const = 0;

 virtual IParcel* QueryParcelAt(const PMPoint& whereInMCFCoord) const = 0;

 virtual void LinkToFrameList(IFrameList* newFrameList,
 int32 frameListAt = IFrameList::kAtTheEnd) = 0;

 virtual PMReal CalculateVariableColWidthIf(int32 numColumns,
 PMReal gutterWidth,
 const PMRect& insets) const = 0;

 virtual PMReal CalculateAdjustedFixedColumnWidthIf(PMReal fixedColWidth) const = 0;

 virtual PMReal CalculateAdjustedFlexibleColumnWidthIf(PMReal mcfWidth, PMReal gutterWidth, const PMRect& insets, PMReal minWidth, PMReal maxWidth, int32* newNumColumns) const = 0;

 virtual void CalculateAdjustedSplineDimensions(bool16 ceiling,
 PMReal* pAdjWidth,
 bool16* pWidthConstrained,
 PMReal* pAdjHeight,
 bool16* pHeightConstrained) const = 0;

 virtual void GetLayoutProperties(int32* pParentAnchorCorner,
 int32* pMCFAnchorCorner) const = 0;

 virtual void RecomposeThru() const = 0;

};

#endif