ITextFrameColumn.h

//========================================================================================
// 
// $File$
// 
// Owner: Zak_Williamson
// 
// $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.
// 
// 
// The ITextFrameColumn interface exists on a text frame boss.
// The text frame boss represents one column of text within a multi-column boss.
// 
// The ITextFrameColumn interface holds information on the relationship between this column of text and the story
// displayed in the column.
// 
//========================================================================================

#ifndef __ITextFrameColumn__
#define __ITextFrameColumn__

#include "IPMUnknown.h"
#include "TextID.h"
#include "CTextEnum.h"

class IFrameList;
class IMultiColumnTextFrame;
class IInlineData;
class IStoryOptions;
class ITextModel;
class ParcelKey;
class PMPoint;
class UIDList;

class ITextFrameColumn : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITEXTFRAMECOLUMN };

 virtual IMultiColumnTextFrame* QueryMultiColumnTextFrame() const = 0;

#ifdef ID_DEPRECATED

 virtual TextIndex TextStart() const = 0;

 virtual int32 TextSpan() const = 0;
#endif // ID_DEPRECATED

 virtual void SetFrameListUID(UID frameListUID) = 0;

 virtual UID GetFrameListUID() const = 0;

 virtual IFrameList* QueryFrameList() const = 0;

 virtual UID GetTextModelUID() const = 0;

 virtual ITextModel* QueryTextModel() const = 0;

 virtual IStoryOptions* QueryStoryOptions() const = 0;

 virtual PMReal HitTestFrame(const PMPoint & pPt,
 bool16 composeFirst,
 TextIndex *nextLine,
 bool16 primarySTOnly = kTrue) = 0;

 virtual bool16 GetIsEmpty() const = 0;

 virtual void GetHierarchyChildren(UIDList& childList) const = 0;

 virtual void AddHierarchyChild(const IInlineData* id) = 0;

 virtual void RemoveHierarchyChild(const IInlineData* id) = 0;

};

#endif