IDragDropTextUtils.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.
// 
// 
// Purpose:
// Utilities for use for dealing with drag and drop of text.
// 
//========================================================================================

#ifndef __IDragDropTextUtils__
#define __IDragDropTextUtils__

#include "Utils.h"
#include "TextEditorID.h"
#include "DragDropConstants.h"

class IDataExchangeHandler;
class IDragDropController;
class IEvent;
class UIDRef;
class RangeData;
class IDragDropSource;
class IParcel;
class ILayoutControlData;

class IDragDropTextUtils : public IPMUnknown
{
 public:
 enum {kDefaultIID = IID_IDRAGDROPTEXTUTILS};

 virtual bool16 StartTextDrag(IControlView* view, IDragDropSource* dragSource, IEvent* theEvent) = 0;

 virtual IParcel* QueryTextParcelAtPoint(IControlView* view, const SysPoint mousePt, const IPMUnknown* hitObj, const IParcel* previousParcel, UIDRef& storyUIDRef, RangeData& range, PMReal* hitIndex = nil, PMReal* adjustedHitIndex = nil) = 0;

 virtual void DrawCaretAtDropLocation(IControlView* view, UIDRef& storyUIDRef, RangeData& range, bool16 flushDrawing = kTrue) = 0;

 virtual ErrorCode ProcessDragDropTextCommand(IControlView* view, IDragDropController* controller, const UIDRef& storyUIDRef, RangeData& range, DragDrop::eCommandType type,bool16 ignoreAttributes = kFalse) = 0;

 virtual ErrorCode PrepareForTextFrameDrop(IControlView* view, IDragDropController* controller, PMPoint& dropPoint, UIDRef& parent) = 0;

 virtual ErrorCode MakeFrame(const PBPMPoint& location, const UIDRef& parent, const UIDRef& storyUIDRef, UIDRef& createdFrame) = 0;

 virtual ErrorCode SendDragDropTextSignal(ServiceID id,
 IControlView* sourceView,
 IControlView* destinationView,
 const UIDRef& sourceStoryRef, 
 RangeData& sourceRange,
 const UIDRef& destinationStoryRef, 
 RangeData& destinationRange,
 RangeData& droppedRange,
 DragDrop::eCommandType type,
 IDataExchangeHandler* handler) = 0;

 virtual ICommand* MakeNewTextFrameCmdForDrop(ILayoutControlData* layoutData, IDataExchangeHandler* texthandler, const bool16 ignoreAttributes ) = 0;

};
 
#endif // __IDragDropTextUtils__