ITextWrapFacade.h

//========================================================================================
// 
// $File$
// 
// Owner: David Stephens
// 
// $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 __ITextWrapFacade__
#define __ITextWrapFacade__

// ----- Interfaces -----

#include "IDocumentLayer.h"
#include "IPMUnknown.h"
#include "ISpread.h"
#include "ISpreadList.h"
#include "IStandOff.h"
#include "IStandOffContourWrapSettings.h"

// ----- Utility files -----

#include "Utils.h"

// ----- ID.h files -----

#include "StandOffID.h"

namespace Facade
{
 class ITextWrapFacade : public IPMUnknown
 {
 public:

 enum { kDefaultIID = IID_ITEXTWRAPFACADE };
 enum { kUnchanged = 0xFFFF };
 typedef enum {
 kDoNotIgnore = 0,
 kIgnore = 1,
 kLeaveUnchanged
 } IgnoreEnum;

 virtual IStandOff::mode GetMode(const UIDRef& pageItem) const = 0;

 virtual bool32 GetUserModified(const UIDRef& pageItem) const = 0;

 virtual ErrorCode SetMode( const UIDList& pageItems, IStandOff::mode mode,
 bool16 setUserModified = kFalse,
 bool16 doAutoSelect = kFalse ) const = 0;


 virtual ErrorCode SetContourWrapSettings( const UIDList& imageItems, IStandOffContourWrapSettings::ContourWrapType contourType,
 int16 pathIndex,
 int16 alphaIndex,
 PMReal tolerance,
 uint8 threshhold,
 bool8 allowHoles ) const = 0;

 virtual ErrorCode GetContourWrapSettings( const UIDRef& imageItem, IStandOffContourWrapSettings::ContourWrapType* contourTypePtr,
 int16* pathIndexPtr = nil,
 int16* alphaIndexPtr = nil,
 PMReal* tolerancePtr = nil,
 uint8* threshholdPtr = nil,
 bool8* allowHolesPtr = nil ) const = 0;

 virtual ErrorCode SetInvert(const UIDList& textWrapItems, bool8 bInvert) const = 0;

 virtual ErrorCode GetInvert(const UIDRef& textWrapItem, bool8& bInvert) const = 0;

 virtual ErrorCode SetMargins(const UIDList& textWrapItems, const PMReal& topMargin,
 const PMReal& leftMargin,
 const PMReal& bottomMargin,
 const PMReal& rightMargin) const = 0;

 virtual ErrorCode GetMargins(const UIDRef& textWrapItem, PMReal& topMargin,
 PMReal& leftMargin,
 PMReal& bottomMargin,
 PMReal& rightMargin,
 bool8& singleDistance) const = 0;

 virtual ErrorCode SetActiveFromMaster(const UIDList& textWrapItems, bool16 bActive) const = 0;

 virtual ErrorCode GetActiveFromMaster(const UIDRef& textWrapItem, bool16& bActive) const = 0;

 virtual ErrorCode SetSide(const UIDList& textWrapItems, IStandOff::side Side) const = 0;

 virtual ErrorCode GetSide(const UIDRef& textWrapItem, IStandOff::side& Side) const = 0;

 virtual ErrorCode SetIgnoreWrap(const UIDList& ignoreWrapItems, bool8 bIgnore) const = 0;

 virtual ErrorCode GetIgnoreWrap(const UIDRef& ignoreWrapItem, bool8& ignore) const = 0;

 virtual ErrorCode GetSkipByLeadingHeight(const UIDRef& workspace, bool16& skipByLeading) const = 0;

 virtual ErrorCode SetSkipByLeadingHeight(const UIDRef& workspace, bool16 skipByLeading) const = 0;

 virtual ErrorCode GetZOrderBasedTextWrap(const UIDRef& workspace, bool16& zOrder) const = 0;

 virtual ErrorCode SetZOrderBasedTextWrap(const UIDRef& workspace, bool16 useZOrder) const = 0;

 virtual void CopyTextWrap(const UIDRef& srcPageItem, const UIDRef& dstPageItem) const = 0;
 
 virtual ErrorCode GetModifyIndentsAroundTextWrap(const UIDRef& workspace, bool16& modifyIndent) const = 0;
 
 virtual ErrorCode SetModifyIndentsAroundTextWrap(const UIDRef& workspace, bool16 modifyIndent) const = 0;

 };
}

#endif // __ITextWrapFacade__