IOwnedItem.h

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

#include "IPMUnknown.h"
#include "TextID.h"
#include "K2Vector.h"
#include "IVisitorHelper.h"
#include "RangeData.h" // for Text::StoryRangeList
#include "RequestContext.h"
#include "PMTextUtils.h" // for Text::HIndexList
#include "textstoryaccesstypes.h"

class ICommand;
class IDocumentLayer;
class ITextModel;
class ITextModelMemento;
class ITextFrameColumn;
class IWaxLine;
class IWaxRun;
class IParcelList;
class IParagraphComposer;
class IScript;
class ITextStoryThread;
class ITextParcelList;

typedef K2Vector<InterfacePtr<IVisitorHelper> > VisitorHelperList;

class IOwnedItem : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IOWNEDITEM };

 virtual void SetDiskPage(UID diskPage) = 0;

 virtual UID GetDiskPage() const = 0;

 virtual TextIndex GetTextIndex() const = 0;

 virtual UID GetTextModelUID() const = 0;

 virtual ITextModel* QueryTextModel() const = 0;

 virtual UIDRef GetFrameRef() const = 0;

 virtual ITextFrameColumn* QueryFrame() const = 0;

 virtual PMRect GetInkBounds(void) const = 0;

 virtual ICommand* QueryRemoveFromDocumentCmd() const = 0;

 virtual ITextModelMemento* QueryMemento() const = 0;

 virtual int32 GetNumSpecialAnchorChars() const = 0;

 virtual bool16 GetIsParcelPositionDependent() const = 0;

 virtual void CollectStoryRanges(Text::StoryRangeList* rList,
 TextIndex hIndex = kInvalidTextIndex,
 Text::HIndexList* hIndexList = nil
 ) const = 0;

 virtual void CollectChildren(VisitorHelperList* rList) const = 0;

 virtual void CollectChildren(VisitorHelperList* rList,
 const PMRect* pHitRect,
 const bool16 useParcelInkBounds
 ) const = 0;
 virtual bool16 Moved(ITextModel* textModel,
 IParcelList* pl,
 const IWaxLine* waxLine,
 TextIndex ownedItemTextIndex,
 TextIndex waxLineTextIndex) = 0;

 virtual void MovedIntoOverset(IParcelList* pl) = 0;

 virtual void Applied(ITextModel* textModel,
 IParcelList* pl,
 const IWaxLine* waxLine,
 TextIndex ownedItemTextIndex,
 TextIndex waxLineTextIndex) = 0;

 virtual void StoryThreadChanged(UID newDictUID, uint32 newDictKey) = 0;

 virtual void StoryDirectionChanged() = 0;
 
 virtual IParagraphComposer* QueryComposer() const = 0;

 virtual void StoryAccessChanged(TextStory_StoryAccess access) = 0;

 virtual bool16 GetAreAnchorCharsFindable() const = 0;

 virtual bool16 GetHasStandOff() const = 0;

 virtual void Rebuilt(ITextModel* textModel,
 IParcelList* pl,
 const IWaxLine* waxLine,
 IWaxRun* waxRun,
 TextIndex ownedItemTextIndex,
 TextIndex waxLineTextIndex) = 0;

 virtual void Rebuilt(ITextModel* textModel,
 IParcelList* pl,
 const IWaxLine* waxLine,
 IWaxRun* waxRun,
 TextIndex ownedItemTextIndex,
 TextIndex waxLineTextIndex,
 bool16* damagedBack) = 0;

 virtual void LayerChanged(const IDocumentLayer* newDocLayer) = 0;

 virtual void VisibilityChanged() = 0;

 virtual void ZOrderChanged() = 0;

 virtual bool16 GetContainsOversetContent() const = 0;

 virtual void ParcelMoved() = 0;

 virtual void ParcelResized() = 0;

 virtual ITextStoryThread* QueryStoryThread() const = 0;

 virtual IParcelList* QueryParcelList() const = 0;

 virtual ITextParcelList* QueryTextParcelList() const = 0;

 virtual bool16 GetCanReturnIScript() const = 0;

 virtual IScript* QueryIScript(const ScriptInfo::RequestContext& context) const = 0;

};

#endif