IOwnedItemIcons.h

//========================================================================================
// 
// $File$
// 
// Owner: Kevin Van Wiel
// 
// $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.
// 
// 
// ADOBE CONFIDENTIAL
// 
//========================================================================================

#ifndef __IOwnedItemIcons__
#define __IOwnedItemIcons__

#include "IPMUnknown.h"
#include "ILayoutViewLineData.h"

#include "WritingModeUIID2.h"
#include "UIDRef.h"

class IWaxLine;
class IGraphicsContext;
class LineDescription;
class IGraphicsPort;

class IOwnedItemIcons : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IOWNEDITEMICONS };

 enum ItemType {
 kTable = 0,
 kInlineFrame,
 kHyperlink,
 kIndexMarker,
 kTextPageNum,
 kXMLBeginTag,
 kXMLEndTag,
 kNoteTag,
 kOtherType,
 kXMLStoryTag,
 kFootnoteTag,
 kFootnoteCharacter,
 kEndnoteCharacter,
 kAutoText,
 kHiddenText
 };

 virtual ItemType GetItemType(UIDRef textModelRef, UTF32TextChar character, TextIndex position, UID storyThreadUID = kInvalidUID) = 0;

 virtual PMReal GetIconWidth(ItemType type, UIDRef textModelRef, TextIndex position, UID storyThreadUID = kInvalidUID) = 0;

 virtual void Draw(ItemType type, const PMRect &itemRect, PMReal textYPosition, IGraphicsPort *gPort, UIDRef textModelRef,
 TextIndex position, int32 lineIndex, UID storyThreadUID = kInvalidUID) = 0;

};

#endif // __IOwnedItemIcons__