HidTxtOwnedItem Class Reference

Inheritance diagram for HidTxtOwnedItem:

Public Member Functions
	HidTxtOwnedItem (IPMUnknown *boss)
virtual	~HidTxtOwnedItem ()
virtual ICommand *	QueryRemoveFromDocumentCmd () const
virtual ITextModelMemento *	QueryMemento () const
virtual int32	GetNumSpecialAnchorChars () const
virtual bool16	Moved (ITextModel *textModel, IParcelList *pl, const IWaxLine *waxLine, TextIndex ownedItemTextIndex, TextIndex waxLineTextIndex)
virtual void	MovedIntoOverset (IParcelList *pl)
virtual void	Applied (ITextModel *textModel, IParcelList *pl, const IWaxLine *waxLine, TextIndex ownedItemTextIndex, TextIndex waxLineTextIndex)
virtual void	Rebuilt (ITextModel *textModel, IParcelList *pl, const IWaxLine *waxLine, IWaxRun *waxRun, TextIndex ownedItemTextIndex, TextIndex waxLineTextIndex)
virtual void	ParcelMoved ()
Public Member Functions inherited from COwnedItem
	COwnedItem (IPMUnknown *boss)
virtual void	SetDiskPage (UID diskPage)
virtual UID	GetDiskPage () const
virtual TextIndex	GetTextIndex () const
virtual UID	GetTextModelUID () const
virtual ITextModel *	QueryTextModel () const
virtual UIDRef	GetFrameRef () const
virtual ITextFrameColumn *	QueryFrame () const
virtual PMRect	GetInkBounds (void) const
virtual bool16	GetIsParcelPositionDependent () const
virtual void	CollectStoryRanges (Text::StoryRangeList *rList, TextIndex hIndex, Text::HIndexList *hIndexList) const
virtual void	CollectChildren (VisitorHelperList *rList, const PMRect *pHitRect, const bool16 useParcelInkBounds) const
virtual void	CollectChildren (VisitorHelperList *rList) const
virtual void	StoryThreadChanged (UID newDictUID, uint32 newDictKey)
virtual void	StoryDirectionChanged ()
virtual IParagraphComposer *	QueryComposer () const
virtual void	StoryAccessChanged (TextStory_StoryAccess)
virtual bool16	GetAreAnchorCharsFindable () const
virtual bool16	GetHasStandOff () const
virtual void	Rebuilt (ITextModel *textModel, IParcelList *pl, const IWaxLine *waxLine, IWaxRun *waxRun, TextIndex ownedItemTextIndex, TextIndex waxLineTextIndex, bool16 *damagedBack)
virtual void	LayerChanged (const IDocumentLayer *newDocLayer)
virtual void	VisibilityChanged ()
virtual void	ZOrderChanged ()
virtual bool16	GetContainsOversetContent () const
virtual void	ParcelResized ()
virtual ITextStoryThread *	QueryStoryThread () const
virtual IParcelList *	QueryParcelList () const
virtual ITextParcelList *	QueryTextParcelList () const
bool16	GetCanReturnIScript () const
IScript *	QueryIScript (const ScriptInfo::RequestContext &context) const
void	ReadWrite (IPMStream *s, ImplementationID i)

Additional Inherited Members
Public Types inherited from IOwnedItem
enum	{ kDefaultIID = IID_IOWNEDITEM }
Protected Attributes inherited from COwnedItem
UID	fDiskPage

Detailed Description

Implements the owned item (IOwnedItem) that anchors hidden text (kHidTxtModelBoss) on a TextIndex in a story. Owned items are stored by the owned item strand (kOwnedItemStrandBoss) in the story's text model (ITextModel).

The IOwnedItem and ITextModelMemento implementations are the hooks that allow the hidden text to be managed when it is affected by text model operations. For example they allow the kHidTxtModelBoss object and its associated story thread to be deleted when the TextIndex on which the hidden text is anchored gets deleted.

This implementation also attaches this plug-ins text adornment (kHidTxtAnchorTextAdornmentBoss) to the wax when IOwnedItem::Moved is called.

Constructor & Destructor Documentation

HidTxtOwnedItem::HidTxtOwnedItem

(

IPMUnknown *

boss

)

Constructor.

Parameters

boss

HidTxtOwnedItem::~HidTxtOwnedItem ( )

virtual

Destructor.

Member Function Documentation

void HidTxtOwnedItem::Applied ( ITextModel *  textModel, IParcelList *  pl, const IWaxLine *  waxLine, TextIndex  ownedItemTextIndex, TextIndex  waxLineTextIndex  )

virtual

See Also

IOwnedItem and COwnedItem Implementations which don't have any position specific issues should override and stub out these methods to improve performance.

Reimplemented from COwnedItem.

int32 HidTxtOwnedItem::GetNumSpecialAnchorChars ( ) const

virtual

Returns

1, this owned item is anchored on a single character.

See Also

IOwnedItem and COwnedItem

Implements IOwnedItem.

bool16 HidTxtOwnedItem::Moved ( ITextModel *  textModel, IParcelList *  pl, const IWaxLine *  waxLine, TextIndex  ownedItemTextIndex, TextIndex  waxLineTextIndex  )

virtual

See Also

IOwnedItem and COwnedItem Implementations which don't have any position specific issues should override and stub out these methods to improve performance.

Reimplemented from COwnedItem.

void HidTxtOwnedItem::MovedIntoOverset ( IParcelList *  pl )

virtual

See Also

IOwnedItem and COwnedItem Implementations which don't have any position specific issues should override and stub out these methods to improve performance.

Reimplemented from COwnedItem.

void HidTxtOwnedItem::ParcelMoved ( )

virtual

See Also

IOwnedItem and COwnedItem Implementations which don't have any position specific issues should override and stub out these methods to improve performance.

Reimplemented from COwnedItem.

ITextModelMemento * HidTxtOwnedItem::QueryMemento ( ) const

virtual

Returns

interface pointer to a kHidTxtTextModelMementoBoss object.

See Also

IOwnedItem and COwnedItem

Implements IOwnedItem.

ICommand * HidTxtOwnedItem::QueryRemoveFromDocumentCmd ( ) const

virtual

Returns

interface pointer to a kHidTxtModelDeleteCmdBoss command.

See Also

IOwnedItem and COwnedItem

Implements IOwnedItem.

void HidTxtOwnedItem::Rebuilt ( ITextModel *  textModel, IParcelList *  pl, const IWaxLine *  waxLine, IWaxRun *  waxRun, TextIndex  ownedItemTextIndex, TextIndex  waxLineTextIndex  )

virtual

See Also

IOwnedItem and COwnedItem Implementations which don't have any position specific issues should override and stub out these methods to improve performance.

Reimplemented from COwnedItem.