IReferencePointSuite.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.
// 
//========================================================================================

#ifndef __IREFERENCEPOINTSUITE__
#define __IREFERENCEPOINTSUITE__

#include "IReferencePointData.h"
#include "LayoutUIID.h"
#include "PMLine.h"
class IControlView;

class IReferencePointSuite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IREFERENCEPOINTSUITE };

// ----- Abilities

 virtual bool16 ViewHasReferencePoint( IControlView* view) const = 0;

 virtual IReferencePointData::ReferencePointPosition GetViewDefaultReferencePosition( IControlView* view) const = 0;

 virtual IReferencePointData::ReferencePointPosition GetViewReferencePointPosition( IControlView* view) const = 0;
 
 virtual IReferencePointData::ReferenceAppearance GetViewReferenceAppearance( IControlView* view) const = 0;

 virtual PMLine GetViewReferenceLine( IControlView* view) const = 0;

 virtual bool16 CanChangeViewReferencePoint( IControlView* view) const = 0;

 virtual PBPMPoint CalculateViewReferencePoint( IControlView* view, IReferencePointData::ReferencePointPosition position,
 PBPMRect* referenceFrame = nil) = 0; 

// ----- Manipulators

 virtual ErrorCode ChangeViewReferencePoint( IControlView* view, IReferencePointData::ReferencePointPosition newPosition,
 const PMPoint& newPoint,
 const PBPMRect& referenceFrame = kZeroRect) = 0;

 virtual ErrorCode ChangeViewReferencePosition( IControlView* view, IReferencePointData::ReferencePointPosition newPosition) = 0;

};


#endif // __IREFERENCEPOINTSUITE__