IRefPointUIUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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 __IRefPointUIUtils__
#define __IRefPointUIUtils__

#include "AppUIID.h"
#include "IPMUnknown.h"
#include "Utils.h"

#include "PMString.h"
#include "PMPoint.h"
#include "PMPolygon4.h"
#include "IReferencePointData.h"
#include "TransformTypes.h"

class UIDList;
class ISpread;
class IControlView;
class ILayoutControlData;
class IGraphicsPort;
class IGraphicsContext;

class IRefPointUIUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IREFPOINTUIUTILS };

 virtual IReferencePointData* QueryRefPointData(ILayoutControlData* layoutData) = 0;

 virtual void ShowReferencePoint(ILayoutControlData* layoutData) = 0;

 virtual void HideReferencePoint(ILayoutControlData* layoutData) = 0;

 virtual void InvalidateReferencePoint(ILayoutControlData* layoutData, bool16 forceInval = kFalse) = 0;

 virtual bool16 IsReferencePointShown(ILayoutControlData* layoutData) = 0;

 virtual bool16 IsReferencePointLocked(ILayoutControlData* layoutData) = 0;

 virtual void LockReferencePoint(ILayoutControlData* layoutData) = 0;

 virtual void UnlockReferencePoint(ILayoutControlData* layoutData) = 0;

 virtual void SetReferencePointVisible(ILayoutControlData* layoutData) = 0;

 virtual void SetReferencePointInvisible(ILayoutControlData* layoutData) = 0;

 virtual bool16 IsReferencePointVisible(ILayoutControlData* layoutData) = 0;

 virtual ErrorCode ChangeReferencePoint(ILayoutControlData* layoutData, 
 IReferencePointData::ReferencePointPosition newPosition,
 const PMPoint& newPoint,
 const PBPMRect& referenceFrame = kZeroRect) = 0;

 virtual ErrorCode ChangeReferencePoint(ILayoutControlData* layoutData,
 IReferencePointData::ReferencePointPosition newPosition,
 const UIDList& items) = 0;

 virtual void SetReferencePositionAndPoint(ILayoutControlData* layoutData, 
 IReferencePointData::ReferencePointPosition position,
 const PBPMPoint& point) = 0;

 virtual PBPMPoint GetPasteboardReferencePoint( ILayoutControlData* layoutData) = 0;


 virtual bool16 PointInActiveReferencePoint(ILayoutControlData* layoutData, const PBPMPoint& point) = 0;

 virtual bool16 WindowPointInActiveReferencePoint(ILayoutControlData* layoutData, const PMPoint& point) = 0;
 
 virtual void SetDefaultState(ILayoutControlData* layoutData) = 0;

 virtual void SetDefaultPosition(ILayoutControlData* layoutData) = 0;

 virtual void SetReferencePointOffset(ILayoutControlData* layoutData, const PBPMPoint& offset) = 0;

 virtual PBPMPoint GetReferencePointOffset(ILayoutControlData* layoutData) = 0;

 virtual void SetReferenceFrame(ILayoutControlData* layoutData, const PBPMRect& referenceFrame) = 0;

 virtual PBPMRect GetReferenceFrame(ILayoutControlData* layoutData) = 0;

 virtual Transform::TransformOrigin GetReferencePointTransformOrigin( ILayoutControlData* layoutData) = 0;
 
 //move callers to GetReferencePointTransformOrigin
 virtual IReferencePointData::ReferencePointPosition GetReferencePointPosition( ILayoutControlData* layoutData) = 0;

};


#endif // __IRefPointUIUtils__