ITextFrameFacade.h

//========================================================================================
// 
// $File$
// 
// Owner: Jianlan Song
// 
// $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.
// 
//========================================================================================

#ifndef __ITextFrameFacade__
#define __ITextFrameFacade__

// ----- Interfaces -----
#include "ITextModel.h"
#include "IFrameList.h"
#include "IMultiColumnTextFrame.h"

// ----- ID.h files -----
#include "TextID.h"

namespace Facade
 {
 class ITextFrameFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_ITEXTFRAMEFACADE };
 
 virtual ErrorCode CreateTextFrame
 (
 UIDRef parent, 
 UIDRef& newFrame,
 const PMRect& boundary, 
 bool16 noGraphicAttr,
 bool16 isHorizontal, 
 bool16 isFrameGrid, 
 bool16 isLeftToRight,
 ClassID frameItem = kFrameItemBoss
 ) = 0;


 virtual ErrorCode CreateTextFrame
 (
 UIDRef parent, 
 UIDRef& newFrame,
 const PMPointList& opposingCorners, 
 bool16 noGraphicAttr,
 bool16 isHorizontal, 
 bool16 isFrameGrid, 
 bool16 isLeftToRight,
 ClassID frameItem = kFrameItemBoss
 ) = 0;

 virtual ErrorCode CreateTextFrameForStory
 (
 UIDRef parent, 
 UIDRef& newFrame,
 const PMRect& boundary, 
 bool16 noGraphicAttr,
 ITextModel* story, 
 bool16 isHorizontal, 
 bool16 isFrameGrid, 
 bool16 isLeftToRight,
 ClassID frameItem = kFrameItemBoss
 ) = 0;

 virtual ErrorCode CreateTextFrameForFrameList
 (
 UIDRef parent, 
 UIDRef& newFrame,
 const PMRect& boundary, 
 bool16 noGraphicAttr, 
 IFrameList * frameList, 
 bool16 atEnd = kTrue,
 ClassID frameItem = kFrameItemBoss
 ) = 0;

 virtual ErrorCode CreateTextFrameForFrameList
 (
 UIDRef parent, 
 UIDRef& newFrame,
 const PMRect& boundary, 
 bool16 noGraphicAttr, 
 IMultiColumnTextFrame * mcFrame, 
 bool16 insertAfter = kTrue,
 ClassID frameItem = kFrameItemBoss
 ) = 0;

 virtual ErrorCode ConvertToTextFrame
 (
 UIDRef parent, 
 bool16 isHorizontal, 
 bool16 isFrameGrid,
 bool16 isLeftToRight,
 ClassID frameItem = kFrameItemBoss
 ) = 0;

 virtual ErrorCode ConvertToTextFrameForStory
 (
 UIDRef parent, 
 ITextModel* story,
 bool16 isHorizontal, 
 bool16 isFrameGrid,
 bool16 isLeftToRight,
 ClassID frameItem = kFrameItemBoss
 ) = 0;

 virtual ErrorCode ConvertToTextFrameForFrameList
 (
 UIDRef parent, 
 IFrameList* frameList, 
 bool16 atEnd = kTrue,
 ClassID frameItem = kFrameItemBoss
 ) = 0;

 virtual ErrorCode ConvertToTextFrameForFrameList
 (
 UIDRef parent, 
 IMultiColumnTextFrame * mcFrame, 
 bool16 insertAfter = kTrue,
 ClassID frameItem = kFrameItemBoss
 ) = 0;

 virtual void GetSplinePathDimensionsIf
 (
 PMReal splinePathWidth,
 PMReal splinePathHeight,
 PMReal strokeWeight,
 int32 strokeAlignment,
 PMReal leftTextInset,
 PMReal topTextInset,
 PMReal rightTextInset,
 PMReal bottomTextInset,
 bool16 storyIsVertical,
 int32 mcfNumColumns,
 PMReal mcfGutterWidth,
 PMReal& adjSplinePathWidth,
 PMReal& adjSplinePathHeight,
 PMReal& mcfVariableColWidth
 ) = 0;

 virtual void GetSplinePathDimensionsIf
 (
 PMReal splinePathWidth,
 PMReal splinePathHeight,
 PMReal strokeWeight,
 int32 strokeAlignment,
 PMReal leftTextInset,
 PMReal topTextInset,
 PMReal rightTextInset,
 PMReal bottomTextInset,
 bool16 storyIsVertical,
 PMReal textSize,
 PMReal charAki,
 PMReal lineAki,
 PMReal hScale,
 PMReal vScale,
 int32 mcfNumColumns,
 PMReal mcfGutterWidth,
 PMReal& adjSplinePathWidth,
 PMReal& adjSplinePathHeight,
 PMReal& mcfVariableColWidth,
 int32& mcfGridColCount,
 int32& mcfGridRowCount
 ) = 0;

 virtual void GetSplinePathDimensionsIf
 (
 PMReal splinePathWidth,
 PMReal splinePathHeight,
 PMReal strokeWeight,
 int32 strokeAlignment,
 PMReal leftTextInset,
 PMReal topTextInset,
 PMReal rightTextInset,
 PMReal bottomTextInset,
 bool16 storyIsVertical,
 PMReal mcfGutterWidth,
 PMReal mcfFixedColumnWidth,
 PMReal& adjSplinePathWidth,
 PMReal& adjSplinePathHeight,
 int32& mcfNumColumns
 ) = 0;


 virtual void GetSplinePathDimensionsIf
 (
 PMReal splinePathWidth,
 PMReal splinePathHeight,
 PMReal strokeWeight,
 int32 strokeAlignment,
 PMReal leftTextInset,
 PMReal topTextInset,
 PMReal rightTextInset,
 PMReal bottomTextInset,
 bool16 storyIsVertical,
 PMReal textSize,
 PMReal charAki,
 PMReal lineAki,
 PMReal hScale,
 PMReal vScale,
 PMReal mcfGutterWidth,
 PMReal mcfFixedColumnWidth,
 PMReal& adjSplinePathWidth,
 PMReal& adjSplinePathHeight,
 int32& mcfNumColumns,
 int32& mcfGridColCount,
 int32& mcfGridRowCount
 ) = 0;

 virtual void GetSplinePathDimensionsIf
 (
 PMReal splinePathWidth,
 PMReal splinePathHeight,
 PMReal strokeWeight,
 int32 strokeAlignment,
 PMReal leftTextInset,
 PMReal topTextInset,
 PMReal rightTextInset,
 PMReal bottomTextInset,
 bool16 storyIsVertical,
 PMReal mcfGutterWidth,
 PMReal mcfColumnWidthMin,
 PMReal mcfColumnWidthMax,
 PMReal& adjSplinePathWidth,
 PMReal& adjSplinePathHeight,
 int32& mcfNumColumns
 ) = 0;

 virtual void GetMinFlexibleColumnWidthIf
 (
 int32 numColumns, 
 PMReal gutterWidth, 
 PMReal maxFlexibleWidth,
 PMReal currentColumnWidth,
 PMReal& adjustedColumnWidth
 ) = 0;
 };

}

#endif // __ITextFrameFacade__