BaseHitTestHandler.h

//========================================================================================
// 
// $File$
// 
// Owner: Rich Gartland
// 
// $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 __BASEHITTESTHANDLER__
#define __BASEHITTESTHANDLER__

#include "IPMUnknown.h"
#include "IBaseHandler.h"

#include "LayoutUIID.h"
#include "HelperInterface.h"
#include "IAdornmentShape.h"


class BaseHitTestHandlerImpl : public IBaseHandler
{
 public:
 typedef enum { 
 kDontSeeLockedItems = 0, 
 kSeeLockedItems
 } LockedItemTreatment;
 
 typedef enum { 
 kDontSeeLockedLayers = 0, 
 kSeeLockedLayers
 } LockedLayerTreatment;
 
 typedef enum { 
 kDontSeeMPItems = 0, 
 kSeeAndOverrideMPItems, 
 kOnlySeeMPItems, 
 kSeeAndOverrideMPItemsAndThreads
 } MasterPageHandlerTreatment;

 BaseHitTestHandlerImpl(IPMUnknown *boss);
 ~BaseHitTestHandlerImpl();

 virtual void InitHandler(GraphicsData* gd, IShape* theShape);

 virtual void TerminateHandler(void);

 virtual const PMRect GetHandlerIntersectionRect(void) const ;

 virtual const GraphicsData* GetHandlerGraphicsDataPtr(void) const { return fHitTestHandlerGrarphicsData; }

 virtual bool16 HandleSpread(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleSpreadLayer(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleInlineItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleSplineItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleMultiColumnFrameItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleFrameItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleGroupItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleGuideItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandlePage(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleImageItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleHTMLItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleEPSTextItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleEPSItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandlePICTItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleWMFItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandlePDFItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleTOPItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleOwnedItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleWaxAnchoredElementItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleParcelItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 HandleUnknownItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 protected:
 virtual bool16 HandleAdornments(IAdornmentShape::AdornmentDrawOrder drawOrder, IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);
 
 class ConcatTransformInScope
 {
 public:
 ConcatTransformInScope(BaseHitTestHandlerImpl* handler, IShape* theShape)
 {
 fHandler = handler;
 if (fHandler)
 {
 fHandler->AddRef();
 fHandler->SetupHitTestHandlerPort(theShape);
 }
 }
 ConcatTransformInScope(BaseHitTestHandlerImpl* handler, const PMMatrix& toPasteboard)
 {
 fHandler = handler;
 if (fHandler)
 {
 fHandler->AddRef();
 fHandler->SetupHitTestHandlerPort(toPasteboard);
 }
 }

 ~ConcatTransformInScope()
 {
 if (fHandler)
 {
 fHandler->CleanupHitTestHandlerPort();
 fHandler->Release();
 }
 }

 private:
 ConcatTransformInScope(const ConcatTransformInScope& other);
 ConcatTransformInScope& operator=(const ConcatTransformInScope& other);

 //---- Data
 BaseHitTestHandlerImpl* fHandler;
 };

 friend class ConcatTransformInScope;

 //---- Helpers
 void InitAssociatedData(void); 

 virtual bool16 StandardPageItemHandler(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 StandardLeafNodeHandler(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor); 

 virtual bool16 HitTestTextOnPath( IShape* iShape, IAdornmentShape::AdornmentDrawOrder drawOrder, GraphicsData* gd, const PMRect& r /*in view coordinates*/) const ;

 virtual bool16 HandleSpreadOMP(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor);

 virtual bool16 DoHandleSpreadLayer(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor, MasterPageHandlerTreatment mph, LockedLayerTreatment llt = kDontSeeLockedLayers);

 virtual bool16 DoHandleSplineItem(IVisitorHelper* pVisitable, IBaseVisitor* theVisitor, LockedItemTreatment lit = kDontSeeLockedItems);

 /* Checks to see if an item is locked. It looks for the IID_ILOCKPOSITION interface and checks the lock state.
 @param item pointer to an impl on the boss of the item to check.
 @return kTrue if locked. kFalse if unlocked or the interface is not there.
 */
 virtual bool16 IsItemLocked(IPMUnknown * item);

 //---- Data
 GraphicsData* fHitTestHandlerGrarphicsData; 
 PMRect fTheHitTestRectangle;//view coordinates -- is this ever modified ? set up in BaseHitTestHandlerImpl::InitAssociatedData from theData->GetHitTestRectangle()
 UIDList* fThingsHit;
 IShape* fShape;

 
private:
 void SetupHitTestHandlerPort(IShape* theShape);
 void SetupHitTestHandlerPort(const PMMatrix& toPasteboard);
 void CleanupHitTestHandlerPort(void);
};


#endif