IAdaptiveTransientData.h

//========================================================================================
// 
// $File$
// 
// Owner: Sachin Singhal
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 2019 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 __IAdaptiveTransientData__
#define __IAdaptiveTransientData__

#include "IPMUnknown.h"
#include "AutoLayoutID.h"

#include "PMRect.h"
#include "UIDList.h"

class AdapativePageItemData
{
public:
 UIDList fDependents;
 PMRect fInitialBounds, fFinalBounds, fRecommendedBounds;
 PMPoint fStartPoint, fEndPoint, fFinalStartPoint, fFinalEndPoint;
 UID fTOPUID, fSpreadUID;
 bool16 fUnlockThis, fLeftToRightBinding, fDependentsInitialised, fHasRecommendedBounds;

 AdapativePageItemData() : fDependentsInitialised(kFalse), fUnlockThis(kFalse), fTOPUID(kInvalidUID), fSpreadUID(kInvalidUID), fHasRecommendedBounds(false), fHasNewStartAndEndPointForTOP(false) {}
 ~AdapativePageItemData() {}

 bool16 HasNewStartAndEndPointForTOP() { return fHasNewStartAndEndPointForTOP; }

 void GetStartAndEndPointForTOP(PMPoint &startPoint, PMPoint &endPoint, bool reset = false)
 {
 if (fHasNewStartAndEndPointForTOP)
 {
 startPoint = fStartBracketPoint;
 endPoint = fEndBracketPoint;
 if (reset)
 fHasNewStartAndEndPointForTOP = false;
 }
 }

 void SetStartAndEndPointForTOP(PMPoint startPoint, PMPoint endPoint)
 {
 fStartBracketPoint = startPoint;
 fEndBracketPoint = endPoint;
 fHasNewStartAndEndPointForTOP = true;
 }

 bool HasRecommendedBounds() { return fHasRecommendedBounds; }

 virtual PMRect GetRecommendedBounds(bool reset = false)
 {
 PMRect returnRect = fRecommendedBounds;
 if (reset)
 {
 fRecommendedBounds = PMRect();
 fHasRecommendedBounds = false;
 }
 return returnRect;
 }

 void SetRecommendedBounds(PMRect bounds)
 {
 fRecommendedBounds = bounds;
 fHasRecommendedBounds = true;
 }

private:
 PMPoint fStartBracketPoint, fEndBracketPoint;
 bool fHasNewStartAndEndPointForTOP;
};

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

 virtual AdapativePageItemData* GetData(UID)= 0;

 virtual void Reset() = 0;
};

#endif // __IAdaptiveTransientData__