IFlowFacade.h

//========================================================================================
// 
// $File$
// 
// Owner: Paul Sorrick
// 
// $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.
// 
// 
// Note:
// 
//========================================================================================

#ifndef __IFlowFacade__
#define __IFlowFacade__

#include "MasterPageID.h"
#include "ILayoutObject.h"
#include "PMPageSize.h"

class IGraphicFrameData;
class IDocument;

namespace Flow
{
 //Note the last call wins. So a 'Set' will clear a previous 'Flip' request, 
 //and a 'Flip' will clear a previous 'Set' request. Further a 'Flip' will
 //clear a previous 'Flip' request thus leaving that constraint unchanged
 //during the command.

 enum Constraint { 
 kFlexibleDimension = 0, 
 kFixedDimension = 1, 
 kFlipDimension = 2, 
 kSkipDimension = 3}; 
 typedef K2Vector<Constraint> ConstraintList;

 enum ConstraintIndex
 {
 kLeftConstraint = 0,
 kFirstConstraint = kLeftConstraint,
 kFirstXConstraint = kLeftConstraint,
 
 kWidthConstraint = 1,
 
 kRightConstraint = 2,
 kLastXConstraint = kRightConstraint,
 
 kTopConstraint = 3,
 kFirstYConstraint = kTopConstraint,
 
 kHeightConstraint = 4,
 
 kBottomConstraint = 5,
 kLastYConstraint = kBottomConstraint,
 kLastConstraint = kBottomConstraint,
 kNumConstraints = 6
 };
}

namespace Facade
{
 class IFlowFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_IFLOWFACADE };
 
 virtual UIDRef GetStoryFromSpline(const UIDRef& splineFlowFrameRef) const = 0;

 virtual bool16 CanSetPrimaryTextFlowSpline
 (
 const UIDRef& masterSpreadRef,
 const UIDRef& splineFlowFrameRef
 ) const = 0;

 virtual bool16 CanSetPrimaryTextFlowStory
 (
 const UIDRef& masterSpreadRef,
 const UIDRef& storyRef
 ) const = 0;

 virtual ErrorCode SetPrimaryTextFlowSpline
 (
 const UIDRef& masterSpreadRef,
 const UIDRef& splineFlowFrameRef
 ) = 0;

 virtual UIDRef GetPrimaryTextFlowStory(const UIDRef& masterSpreadRef, const bool16 bWalkUpMasters = kFalse) const = 0;

 virtual ErrorCode SetPrimaryTextFlowStory
 (
 const UIDRef& masterSpreadRef,
 const UIDRef& storyRef
 ) = 0;

 virtual UIDList GetPrimaryTextFlowSplineListForPage(const UIDRef& pageRef, const UIDRef& masterRef) = 0;

 virtual UIDList GetPrimaryTextFlowSplineListForMaster(const UIDRef& pageOrSpreadMasterRef) = 0;

 virtual bool16 IsInPrimaryTextFlowStory(const UIDRef& masterRef, const UIDRef& splineRef) const = 0;

 virtual bool16 IsAPrimaryTextFlowStory(const UIDRef& storyRef, UIDRef* fromThisMaster = nil) const = 0;
 virtual bool16 IsAnOverriddenPrimaryTextFlowStory(const UIDRef& storyRef, UIDRef* fromThisMaster = nil) const = 0;

 virtual bool16 CanCreateAlternateLayout(const UIDList& spreadList) const = 0;

 virtual ErrorCode CreateAlternateLayout(const UIDList& spreadList,
 const PMString& name, 
 const PMPageSize& pageSize,
 const bool16 bCreateTextStyles,
 const bool16 bLinkTextStories,
 ILayoutObject::LayoutPolicy policy
 ) = 0;

 virtual bool16 CanDeleteAlternateLayout(const UIDRef& spreadRef) const = 0;
 
 virtual ErrorCode DeleteAlternateLayout(const UIDRef& spreadRef, bool16 bDeleteMasters = kTrue, bool16 bDeleteStyleGroups = kTrue) = 0;
 
 virtual ErrorCode DeletePrimaryTextFlowStory(const UIDRef& storyRef) = 0;

 virtual ErrorCode SetConstraints(const UIDList& itemList, const Flow::ConstraintList& list) = 0;

 virtual void GetConstraints(const UIDRef& oneItem, Flow::ConstraintList& outList) const = 0;

 virtual bool16 GetDuringCreateAlternateLayout(IDocument* document) const = 0;

 virtual void SetDuringCreateAlternateLayout(IDocument* document, const bool16 flag) = 0;

 };
}

DECLARE_BASE_TYPE(Flow::Constraint);

#endif // __IFlowFacade__