IAdaptiveHelper.h

//========================================================================================
// 
// $File$
// 
// Owner: Sachin Singhal
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 2018 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: All information contained herein is, and remains
// the property of Adobe Systems Incorporated and its suppliers,
// if any. The intellectual and technical concepts contained
// herein are proprietary to Adobe Systems Incorporated and its
// suppliers and may be covered by U.S. and Foreign Patents,
// patents in process, and are protected by trade secret or copyright law.
// Dissemination of this information or reproduction of this material
// is strictly forbidden unless prior written permission is obtained
// from Adobe Systems Incorporated.
// 
//========================================================================================

#ifndef __IAdaptiveHelper__
#define __IAdaptiveHelper__

#include "IPMUnknown.h"
#include "AutoLayoutID.h"
#include "UIDList.h"
#include "ErrorUtils.h"
#include "IXPAttributeSuite.h"

//Move to AdaptiveCore
#define NORMAILZE_ERROR(err) if(err == kItemDoesNotIntersectBoundsError || err == kItemTooSmallError || err == kUnableToSetBoundingBoxError) \
 { ErrorUtils::PMSetGlobalErrorCode(kSuccess); err = kSuccess; }
#define SHOW_ERROR(err, msg) if (err != kSuccess) \
 ASSERT_FAIL(msg);
#ifdef DEBUG
#define HANDLE_ADAPTIVE_ERR(err, msg) NORMAILZE_ERROR(err) \
 SHOW_ERROR(err, msg);
#else 
#define HANDLE_ADAPTIVE_ERR(err, msg) NORMAILZE_ERROR(err);
#endif

enum OptionsFlag {
 kDefaultSettings = 0,
 kMaintainAspectRatioForNonRectangular = 1,
 kResizeIrrespectiveOfAspectRatio = 2,
};

class IAdaptiveHelper : public IPMUnknown
{
public:
 /* Default IID to be used by UseDefaultIID() */
 enum { kDefaultIID = IID_IADAPTIVEHELPER };

 virtual PMRect GetBoundsForPageItem(UIDRef pageItemRef) = 0;

 virtual PMRect GetFinalBoundsForPageItem(const UIDRef& pageItemRef, const PMRect& initialBounds, const uint32& options = 0) = 0;

 virtual void SetRecommendedBoundsForPageItem(UIDRef pageItemRef, PMRect recommendedBounds) = 0;

 virtual bool16 ShouldHandleHidden() = 0;

 virtual bool16 ShouldHandleLocked() = 0;

 virtual bool16 ShouldHandleText() = 0;

 virtual bool16 ShouldMaintainAspectRatioForNonRectangularPI() = 0;

 virtual bool16 ShouldMaintainAspectRatioForPI(UIDRef pageItemRef) = 0;

 virtual void RegisterMaxFontScaleOf(UID uid, PMReal fontScale) = 0;
 virtual PMReal GetBestPossibleTextScaleFactor(const UIDRef uidRef, const PMReal& hScale, const PMReal& vScale) = 0;
 virtual PMReal GetFontScale(UID itemUID) = 0;

 virtual bool16 LiesInsideMargin(const UIDRef& pageItemRef, const PMRect& initialBounds) = 0;

 virtual ErrorCode AdjustEffects(const UIDList& itemList, const PMRect& initialBounds, const PMRect& finalBounds) = 0;
 virtual PMPoint GetMinSizeOfObject(UIDRef pageItemRef) = 0;
 virtual PMRect GetRelativeFinalBounds(PMRect initialBounds, PMRect initialReferenceBounds, PMRect finalReferenceBounds) = 0;

 virtual PMReal GetMaxAllowedFontSize() = 0;
 virtual PMReal GetMinAllowedFontSize() = 0;
 virtual void PreprocessText(UIDRef uidRef) = 0;
 virtual UID GetSpreadUID(UIDRef pageItemUID) = 0;
};


#endif // __IAdaptiveHelper__