ITextParcelListData.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 __ITextParcelListData__
#define __ITextParcelListData__

#include "IPMUnknown.h"
#include "ICompositionStyle.h"

#include "PMRect.h"
#include "PMMatrix.h"
#include "TextID.h"
#include "UIDList.h"
#include "CTextEnum.h"
#include "ParcelKey.h"
#include "TextWrapRef.h"

class ITextStoryThread;
class ISpread;


class ITextParcelListData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ITEXTPARCELLISTDATA };

 //
 // Composed state of the Text Parcel List
 //
 virtual IDataBase * GetDataBase() const = 0;
 virtual UID GetTextModelUID() const = 0;
 virtual UID GetFrameListUID() const = 0;

 virtual ITextStoryThread * QueryStoryThread() const = 0;

 virtual bool16 GetParcelIsDamaged(ParcelKey key) const = 0;
 virtual void SetParcelDamaged(ParcelKey key) = 0;
 virtual void ClearParcelDamage(ParcelKey key) = 0;

 virtual bool16 GetParcelNeedsWrapCheck(ParcelKey key) const = 0;

 virtual void SetParcelNeedsWrapCheck(ParcelKey key) = 0;

 virtual void ClearParcelNeedsWrapCheck(ParcelKey key) = 0;

 virtual TextIndex GetParcelTextStart(ParcelKey key) const = 0;
 virtual int32 GetParcelTextSpan(ParcelKey key) const = 0;
 virtual void SetParcelTextSpan(ParcelKey key, TextIndex span) = 0;
 // NOT lean left, we want where it really is
 virtual ParcelKey GetParcelContaining(TextIndex at) const = 0;

 //
 // The Content bounds of the Parcel is measured from the top of the
 // TOFLineHeight() of the first WaxLine to the GetContentBottom() of
 // the last WaxLine in the Content coordinates.
 //
 // Clients which do not cache this information may return a height of
 // 0.0 and TextParcelList::GetContentBounds() will compute it.
 //
 virtual void GetParcelVContentBounds(ParcelKey key, PMReal* pTop,
 PMReal* pBottom) const = 0;
 virtual void SetParcelVContentBounds(ParcelKey key, PMReal top,
 PMReal bottom) = 0;

 virtual bool16 GetParcelHasPositionDependentContent(ParcelKey key) const = 0;
 virtual void SetParcelHasPositionDependentContent(ParcelKey key, bool16 v) = 0;

 virtual bool16 GetParcelHasKeepsOn(ParcelKey key) const = 0;
 virtual void SetParcelHasKeepsOn(ParcelKey key, bool16 v) = 0;

 //
 // Indicates if the Parcel has valid post-processing of VJ using the
 // pre-4.0 style of VJ which did not have a separate Composition
 // YPosition. This will be cleared by the TextParcelList::Recompose()
 // when composition in the Parcel begins.
 //
 virtual bool16 GetParcelHasBeenVJed(ParcelKey key) const = 0;
 virtual void SetParcelHasBeenVJed(ParcelKey key, bool16 vj) = 0;

 //
 // Indicates if any WaxLines have GridAlignmentMetric other
 // than kGANone.
 //
 virtual bool16 GetParcelHasGridAlignedWax(ParcelKey key) const = 0;
 virtual void SetParcelHasGridAlignedWax(ParcelKey key, bool16 v) = 0;

 //
 // Indicates if any WaxLines have NeedsYPosPostProcessing() set
 // to kTrue.
 //
 virtual bool16 GetParcelHasNeedsPostProcessWax(ParcelKey key) const = 0;
 virtual void SetParcelHasNeedsPostProcessWax(ParcelKey key, bool16 v) = 0;

 virtual ParcelKey GetFirstLogicalParcelKey(int32* pIndex = nil) const = 0;

 virtual ParcelKey GetNextLogicalParcelKey(ParcelKey key,
 int32* pIndex = nil) const = 0;

 enum nextParcelType
 {
 npt_box,
 npt_anypage,
 npt_oddpage,
 npt_evenpage
 };

 virtual ParcelKey GetNextLogicalParcelKeyByType(ParcelKey key,
 nextParcelType pType,
 int32* pIndex = nil) const = 0;

 virtual ParcelKey GetPreviousLogicalParcelKey(ParcelKey key,
 int32* pIndex = nil) const = 0;

 virtual ParcelKey GetLastLogicalParcelKey(int32* pIndex = nil) const = 0;

 virtual ParcelKey GetLastLogicalNonOversetParcelKey(int32* pIndex = nil) const = 0;

 //
 // Text Parcel List Options
 //
 virtual Text::FirstLineOffsetMetric
 GetParcelFirstLineOffsetMetric(ParcelKey key) const = 0;
 virtual PMReal GetParcelMinFirstLineOffset(ParcelKey key) const = 0;
 virtual bool16 GetIsVertical() const = 0;
 virtual bool16 GetIsRightToLeft() const = 0;

 //
 // To disable Soft Bottom behavior simply return a value smaller or
 // equal to the Parcel height, such as 0.0.
 //
 virtual PMReal GetParcelMaxSoftBottomHeight(ParcelKey key) const = 0;
 virtual void SetParcelMaxSoftBottomHeight(ParcelKey key, PMReal maxHeight) = 0;

 virtual bool16 GetParcelIsValidStartBreakLocation(ParcelKey key,
 Text::StartBreakLocation mode) const = 0;
 virtual bool16 GetHasAnyValidStartBreakLocation() const = 0;

 virtual bool16 GetParcelSupportsWrap(ParcelKey key) const = 0;

 virtual bool16 GetParcelIgnoringWrap(ParcelKey key) const = 0;

 virtual int32 GetWaxAnchoredElementCount() const = 0;

 virtual int32 GetWaxAnchoredElementIndex(UID uid) const = 0;

 virtual void InsertNthWaxAnchoredElement(int32 n, UID uid) = 0;

 virtual void RemoveNthWaxAnchoredElement(int32 n) = 0;

 virtual UID GetNthWaxAnchoredElementUID(int32 n) const = 0;

 virtual ParcelKey GetNthWaxAnchoredElementParcelKey(int32 n) const = 0;

 virtual void SetNthWaxAnchoredElementParcelKey(int32 n,
 ParcelKey Key) = 0;

 virtual int32 GetWaxAnchoredElementsIn(ParcelKey key,
 UIDList* list = nil) const = 0;

 virtual ParcelKey GetFirstDamagedParcel() const = 0;

 virtual void GetFirstKeyIndexes(int32& damagedKeyIndex,
 int32& needWrapCheckKeyIndex) const = 0;

 //
 // See ITextParcelList::ShouldFakeTabAlignToChar for more info.
 //
 virtual bool16 ShouldFakeTabAlignToChar() const = 0;

 //
 // Invalidate composed cached state for the Parcel including the ink
 // bounds and pass info. This method will be called whenever the Parcel
 // goes from the damaged state to the undamaged state.
 //
 virtual void InvalidateParcelComposedState(ParcelKey key) = 0;

 //
 // This method will be called when the TextParcelList is notified that
 // the inkBounds within the specified Parcel have changed outside of
 // composition. The callee should notify the Parent containing Parcel,
 // if any, by calling ITextParcelList::NotifyInkBoundsChanged().
 //
 virtual void NotifyParcelParentInkBoundsChanged(ParcelKey key) = 0;

 virtual int32 GetParcelsOnSpread(const ISpread* spread,
 K2Vector<ParcelKey>& keyList) const = 0;

 virtual int32 GetNonInlineWrapsForParcel(ParcelKey key,
 TextWrapRefList& sodList) const = 0;

 virtual void AddParcelWrap(ParcelKey key,
 const TextWrapRef& sodRef,
 bool16 isActive,
 bool16 isNonInline,
 bool16 isInlineToParcel) = 0;

 virtual bool16 GetParcelWrapActive(ParcelKey key,
 const TextWrapRef& sodRef) const = 0;

 virtual void SetParcelWrapActive(ParcelKey,
 const TextWrapRef& sodRef) = 0;

 virtual void ClearParcelWrapActive(ParcelKey key,
 const TextWrapRef& sodRef) = 0;

 virtual bool16 GetParcelWrapIsNonInline(ParcelKey key,
 const TextWrapRef& sodRef) const = 0;

 virtual bool16 GetParcelWrapIsInlineToParcel(ParcelKey key,
 const TextWrapRef& sodRef) const = 0;

 virtual bool16 GetParcelWrapHasOverlappedRange(ParcelKey key,
 const TextWrapRef& sodRef) const = 0;

 virtual void GetParcelWrapOverlappedRange(ParcelKey key,
 const TextWrapRef& sodRef,
 PMReal& waxYTop,
 PMReal& waxYBottom) const = 0;

 virtual void SetParcelWrapOverlappedRange(ParcelKey key,
 const TextWrapRef& sodRef,
 const PMReal& waxYTop,
 const PMReal& waxYBottom) = 0;

 virtual bool16 GetParcelHasWraps(ParcelKey key) const = 0;

 virtual int32 GetParcelWraps(ParcelKey key,
 TextWrapRefList& sodList) const = 0;

 virtual bool16 GetParcelHasActiveNonInlineWraps(ParcelKey key) const = 0;

 virtual int32 GetParcelActiveNonInlineWraps(ParcelKey key,
 TextWrapRefList& sodList) const = 0;

 virtual bool16 GetParcelHasActiveInlineWraps(ParcelKey key) const = 0;

 virtual int32 GetParcelActiveInlineWraps(ParcelKey key,
 TextWrapRefList& sodList) const = 0;

 virtual void RemoveParcelWrap(ParcelKey key,
 const TextWrapRef& sodRef) = 0;

 virtual bool16 GetSupportsColumnSpanType(ICompositionStyle::SpanColumnsTypeOptions spanType) const = 0;

};

#endif // __ITextParcelListData__