ICursorUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave 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 __ICursorUtils__
#define __ICursorUtils__

#include "IPMUnknown.h"

#include "CursorSpec.h"
#include "PMString.h"

#include "Utils.h"

#include "AppUIID.h"

class IControlView;
class IDynamicTrackerData;
class IDynamicTransformData;
class IGraphicsPort;

class ICursorUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ICURSORUTILS };

 enum CursorOptions
 {
 kDefaultCursor = 0, // do not modify the cursor
 kShowWidthHeight, // Add width/height information to cursor
 kShowXPosition, // Add X Position information to cursor (useful for vertical guides)
 kShowYPosition, // Add Y Position information to cursor (useful for horizontal guides)
 kShowXYPosition, // Add X,Y Position information to cursor
 kShowLineLength, // Add Line length information to cursor
 kShowScale, // Add Scale information to cursor
 kShowRotation, // Rotation in degrees
 kShowLiveCornerRadius, // Add live corner radius info to cursor
 kShowWidth, // Width only -- no height (for Gap Tool)
 kShowHeight, // Height only -- no width (for Gap Tool)
 kShowZoomFactor //show current layout zoom factor
 };

 virtual void InitCursor(const CursorOptions option) = 0;


 virtual void UpdateCursor(CursorSpec& adjustedCursorSpec) const = 0;

 virtual void ReleaseCursor() = 0;

 virtual IGraphicsPort* QueryGraphicsPortForBitmap(uchar* bitmapBuffer, uint32 bitmapWidth, uint32 bitmapHeight, bool16 hasAlpha, bool16 hiRes) const = 0;

 virtual IGraphicsPort* QueryGraphicsPortForBitmap(uchar* bitmapBuffer, uint32 bitmapWidth, uint32 bitmapHeight, bool16 hasAlpha, bool16 hiRes, float scaleFactor) const = 0;
};


#endif // __ICursorUtils__