IAdornmentHandleShape.h

//========================================================================================
// 
// $File$
// 
// Owner: jargast
// 
// $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.
// 
// 
// Purpose:
// This is the handle shape interface for page item adornments. This interface can
// return trackers just like a normal handle shape. Keep in mind, however, that
// it is the page item which is in the selection, not the adornment. 
// 
//========================================================================================

#ifndef __IAdornmentHandleShape__
#define __IAdornmentHandleShape__

#include "IPMUnknown.h"
#include "GraphicsData.h"
#include "IHandleShape.h"

class ITip;

class IAdornmentHandleShape : public IPMUnknown
{
//XFIssue this api called only in:
// source/public/pageitems/basicinterfaces/CHandleShape.cpp
// source/components/pageitems/generic/PageItemAdornmentList.cpp
// as of May 2006
public:
 
 enum AdornmentDrawOrder
 {
 // These values represent when the adornment is to be drawn.
 // Upon calling AddAdornment, the adornment is inserted into
 // the list based when it is to be drawn. If more the one of
 // the flags are & together, the adornment is put on the list
 // in all specified locations.
 kBeforeShape = 1,
 kAfterShape = 2,
 kAllAdornmentFlags = 3
 };

 enum AdornmentDrawNumber
 {
 kNumberOfAdornments = 2
 };

 enum AdornmentDrawMode
 {
 // These values represent when the adornment is to be drawn.
 
 kNonTouchDrawMode = 0, // draw in non touch mode
 kTouchDrawMode, // draw only in touch mode 
 kBothDrawMode // draw in both modes
 };

 virtual AdornmentDrawOrder GetDrawOrderBits() = 0;

 virtual void DrawAdornmentHandleShape
 (
 IHandleShape* iHandleShape, // The owning page item
 AdornmentDrawOrder adornmentDrawOrder, // In case this adornment is used more than once
 GraphicsData* gd,
 IConcreteSelection* concreteSelection,
 int32 flags = 0
 ) = 0;
 
 virtual void DrawControlPointPath
 (
 IHandleShape* iHandleShape, // The owning page item
 AdornmentDrawOrder adornmentDrawOrder, // In case this adornment is used more than once
 GraphicsData* gd, 
 int32 flags = 0
 ) = 0;

 virtual bool16 HitTest
 (
 IHandleShape* iHandleShape, // The owning page item
 AdornmentDrawOrder adornmentDrawOrder, // In case this adornment is used more than once
 GraphicsData* gd, 
 const PMRect& r, 
 PointSelector* handleIndex,
 bool16 bDragging = kFalse
 ) = 0;
 
 virtual bool16 HitTestControlPointPath
 (
 IHandleShape* iHandleShape, // The owning page item
 AdornmentDrawOrder adornmentDrawOrder, // In case this adornment is used more than once
 GraphicsData* gd, 
 const PMRect& r
 ) = 0;

 virtual PMRect GetPaintedAdornmentHandleBounds
 (
 IHandleShape* iHandleShape, // The owning page item
 AdornmentDrawOrder adornmentDrawOrder, // In case this adornment is used more than once
 const PMRect& itemBounds, // This is the painted bounds of the page item
 const PMMatrix& innertoview // NOTE: this is inner to view, not pb to view
 ) = 0;
 
 virtual ITracker* QueryTracker
 (
 IHandleShape* iHandleShape, // The owning page item
 AdornmentDrawOrder adornmentDrawOrder, // In case this adornment is used more than once
 IControlView* layView, 
 const PBPMPoint& where, 
 int32 selectionMode, 
 const PointSelector& index
 ) = 0;

 virtual ITip* QueryTip
 (
 const PointSelector* handleIndex
 ) = 0;

 virtual AdornmentDrawMode GetAdornmentDrawMode() = 0;

protected:

 virtual void DrawAdornmentHandleShapeModeChecked
 (
 IHandleShape* iHandleShape, // The owning page item
 AdornmentDrawOrder adornmentDrawOrder, // In case this adornment is used more than once
 GraphicsData* gd,
 IConcreteSelection* concreteSelection,
 int32 flags = 0
 ) = 0;
};

#endif