![]() | InDesign SDK 20.5 |

Public Types | |
| enum | { kDefaultIID = IID_ITEXTPARCELLISTDATA } |
| enum | nextParcelType { npt_box, npt_anypage, npt_oddpage, npt_evenpage } |
Public Member Functions | |
| 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 |
| virtual ParcelKey | GetParcelContaining (TextIndex at) const =0 |
| 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 |
| virtual bool16 | GetParcelHasBeenVJed (ParcelKey key) const =0 |
| virtual void | SetParcelHasBeenVJed (ParcelKey key, bool16 vj)=0 |
| virtual bool16 | GetParcelHasGridAlignedWax (ParcelKey key) const =0 |
| virtual void | SetParcelHasGridAlignedWax (ParcelKey key, bool16 v)=0 |
| 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 |
| 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 |
| 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 |
| 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 |
| virtual bool16 | ShouldFakeTabAlignToChar () const =0 |
| virtual void | InvalidateParcelComposedState (ParcelKey key)=0 |
| 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 |
Public Member Functions inherited from IPMUnknown | |
| virtual IPMUnknown * | QueryInterface (PMIID interfaceID) const =0 |
| virtual void | AddRef () const =0 |
| virtual void | Release () const =0 |
| pure virtual |
| ParcelKey | |
| sodRef | TextWrapRef to wrap boss with active IStandOff |
| isActive | kTrue if the Wrap can be tiled against |
| isNonInline | kTrue if the Wrap is not the child of an Inline |
| isInlineToParcel | kTrue if the Wrap is the child of an Inline that is anchored in the Parcel. If kTrue, then sodRef.fX/YOffset are expected to be zero. |
Implemented in HidTxtParcelListData.
| pure virtual |
Clears the wrap check from the specified Parcel. During composition the TextParcelList will cause this to be cleared when it processes a Parcel following the one currently being composed. It is the responsiblity of the implementation to process the Parcel in which composition begins.
| key | Parcel to search in. |
Implemented in HidTxtParcelListData.
| pure virtual |
| key | Parcel to search in. |
| sodUID | UID of wrap boss with active IStandOffData interface |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns the ParcelKey of the first Parcel in the ParcelList which is is damaged. If no Parcel is damaged then an invalid ParcelKey returned. Note that this only refers to Parcels which are damaged, NOT those that need wrap check.
Implemented in HidTxtParcelListData.
| pure virtual |
This method returns information about the first Parcel which is damaged and the first Parcel which needs wrap check.
| damagedKeyIndex | Reference to int32 which will be filled in with the index of the first Parcel which is damaged, or -1 if none |
| needWrapCheckKeyIndex | Reference to int32 which will be filled in with the index of the first Parcel which needs wrap check, or -1 if none |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns the ParcelKey of the Parcel logicaly first. In terms of this API, a logical Parcel is one that text can be composed in. Typical implementations have these as one-to-one with all the Parcels in the IParcelList but implementations such as Table Header and Footer cells have only the first Parcel as logically composable and the rest have no Text content at all.
| pIndex | Optional pointer which will be filled in with the index of the returned ParcelKey. If the returned Parcel is invalid then pIndex will be set to -1. |
Implemented in HidTxtParcelListData.
| pure virtual |
This method allows the implementation to control the meaning of overset. Implementations which do not support overmatter Parcels will return the same value for this method as GetLastLogicalParcelKey(). Those that do support overmatter Parcel should return the ParcelKey of the last Parcel before the first overmatter Parcel. ITextParcelList::GetIsOverset() will use the returned ParcelKey as the measure of overset content.
| pIndex | Optional pointer which will be filled in with the index of the returned ParcelKey. If the returned Parcel is invalid then pIndex will be filled in with the count of Parcels in the IParcelList. |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns the ParcelKey of the Parcel logicaly last.
| pIndex | Optional pointer which will be filled in with the index of the returned ParcelKey. If the returned Parcel is invalid then pIndex will be set to the count of Parcels in the IParcelList. |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns the ParcelKey of the Parcel logically after the specified key. If the key is invalid, an invalid key will be returned.
| key | |
| pIndex | Optional pointer which will be filled in with the index of the returned ParcelKey. If the returned Parcel is invalid then pIndex will be filled in with the count of Parcels in the IParcelList. |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns the ParcelKey of the specified Parcel Type logically after the specified key. If the specified Key is already the type of Parcel desired then the key returned will be unchanged. If the key is invalid, an invalid key will be returned.
| key | |
| pType | Type of Parcel the caller wishes to move to. If the |
| pIndex | Optional pointer which will be filled in with the index of the returned ParcelKey. If the returned Parcel is invalid then pIndex will be filled in with the count of Parcels in the IParcelList. |
Implemented in HidTxtParcelListData.
| pure virtual |
Fills in the specfied list with all the non-Inline Wraps which the implementation determines are possible overlaps for the specified Parcel. Note that this is expected to be the same as or superset of the Wraps currently known to the Parcel as returned by GetParcelWraps(). The TextParcelList will be responsible for adding these Wraps to the Parcel in a separate step.
| key | Parcel to search in. |
| sodList | Reference to TextWrapRefList to be filled in |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns the ParcelKey of the Nth element.
| n | An index into the internal list. Must be greater than or equal to zero and less then the value returned by GetWaxAnchoredElementCount(). |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns the UID of the Nth element.
| n | An index into the internal list. Must be greater than or equal to zero and less then the value returned by GetWaxAnchoredElementCount(). |
Implemented in HidTxtParcelListData.
| pure virtual |
Fills in the specfied list with all the Wraps currently added to the Parcel which report being active and are a child of an Inline.
| key | Parcel to search in. |
| sodList | Reference to TextWrapRefList to be filled in |
Implemented in HidTxtParcelListData.
| pure virtual |
Fills in the specfied list with all the Wraps currently added to the Parcel which report being active and are not the child of an Inline.
| key | Parcel to search in. |
| sodList | Reference to TextWrapRefList to be filled in |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns kTrue if the specified Parcel has any active Wraps which are a child of an Inline.
| key | Parcel to search in. |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns kTrue if the specified Parcel has any active Wraps which are not a child of an Inline. added to it.
| key | Parcel to search in. |
Implemented in HidTxtParcelListData.
| pure virtual |
The TextParcelList will set this value if the contents of the Parcel has any keeps on
Implemented in HidTxtParcelListData.
| pure virtual |
The TextParcelList will set this value if the contents of the Parcel, including Wax, OwnedItems, WaxAnchoredElements and even Wraps require it.
Implemented in HidTxtParcelListData.
| pure virtual |
Returns kTrue if the specified Parcel has any Wraps added to it.
| key | Parcel to search in. |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns kTrue if the Parcel is ignoring the effect of all Wraps. Note that the Wraps will still be added to the Parcel, but they will be handled as invalid due to ZOrder.
| key | Parcel to search in. |
Implemented in HidTxtParcelListData.
| pure virtual |
A Parcel with TextDamage needs recomposition.
Implemented in HidTxtParcelListData.
| pure virtual |
Parcels which are marked as needing Wrap check are suspected of having new intersecting Wraps available through GetNonInlineWrapsForParcel().
| key | Parcel to search in. |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns the list of Parcels that are on the specified ISpread.
Implemented in HidTxtParcelListData.
| pure virtual |
Returns kFalse if the Parcel does not support Wraps. This is different from ignoring in that one can stop ignoring sometime in the future whereas one will not suddenly support Wraps. Examples of implementations which do not support Wraps are TextOnPath.
| key | Parcel to search in. |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns the active state of the StandOff relative to the Parcel.
| key | Parcel to search in. |
| sodRef | TextWrapRef to wrap boss |
Implemented in HidTxtParcelListData.
| pure virtual |
| key | Parcel to search in. |
| sodRef | TextWrapRef to wrap boss |
Implemented in HidTxtParcelListData.
| pure virtual |
Wraps which are Inline to the Parcel are those that are anchored in the Parcel. Wraps that are children of Inlines that are NOt inline to the Parcel are anchored at a TextIndex previous to the start of the Parcel. This state is set when the Wrap is added to the Parcel.
| key | Parcel to search in. |
| sodRef | TextWrapRef to wrap boss |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns the non-inline state of the StandOff. Wraps which are non-inline are NOT children of an Inline - typically they are children of the Spread. This state is set when the Wrap is added to the Parcel.
| key | Parcel to search in. |
| sodRef | TextWrapRef to wrap boss |
Implemented in HidTxtParcelListData.
| pure virtual |
| key | Parcel to search in. |
| sodRef | TextWrapRef to wrap boss |
Implemented in HidTxtParcelListData.
| pure virtual |
Fills in the specfied list with all the Wraps currently added to the Parcel.
| key | Parcel to search in. |
| sodList | Reference to TextWrapRefList to be filled in |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns the ParcelKey of the Parcel logically previous to the specified key. If the key is invalid, an invalid key will be returned.
| key | |
| pIndex | Optional pointer which will be filled in with the index of the returned ParcelKey. If the returned Parcel is invalid then pIndex will be set to -1. |
Implemented in HidTxtParcelListData.
| pure virtual |
All implementations must support ICompositionStyle::kSingleColumn.
| spanType | Span type to check |
Implemented in HidTxtParcelListData.
| pure virtual |
Implemented in HidTxtParcelListData.
| pure virtual |
Returns the index of the specified WaxAnchoredElement.
| uid | The UID of the desired WaxAnchoredElement boss. |
Implemented in HidTxtParcelListData.
| pure virtual |
Fills in the specified UIDList with UIDs of the WaxAnchoredElements in the specified Parcel.
| key | Parcel to search in. |
| list | Optional UIDList to append to. |
Implemented in HidTxtParcelListData.
| pure virtual |
A new WaxAnchoredElement is inserted into the list.
| n | An index into the internal list. Must be greater than or equal to zero and less than OR equal to the value returned by GetWaxAnchoredElementCount(). |
| uid | The UID of the WaxAnchoredElement. Must not already be known to the implementation. |
Implemented in HidTxtParcelListData.
| pure virtual |
The specified WaxAnchoredElement is removed from the list.
| n | An index into the internal list. Must be greater than or equal to zero and less then the value returned by GetWaxAnchoredElementCount(). |
Implemented in HidTxtParcelListData.
| pure virtual |
| key | Parcel to search in. |
| sodRef | TextWrapRef to wrap boss |
Implemented in HidTxtParcelListData.
| pure virtual |
| pure virtual |
It is the responsibility of the container implementation to mark Parcels as needing Wrap check through this method when it knowns that Wraps which are not Inline to the Parcel might affect it.
Typically this means that the implementation has to wait until the Parcel has finished its movement to determine the effect - it is not necessarily correct to simply mark all moving or resizing Parcels as needing Wrap check.
Furthermore, the implementation is also responsible for determing what appropriate "damage" is required in order to trigger evaluation of the Wrap. Parcels which are beyond the end of the composed Thread do not necessarily have to be composed
The TextParcelList ONLY calls this method when processing Wraps from Inlines via AddParcelInlineWraps().
| key | Parcel to search in. |
Implemented in HidTxtParcelListData.
| pure virtual |
| key | Parcel to search in. |
| sodRef | TextWrapRef to wrap boss |
Implemented in HidTxtParcelListData.
| pure virtual |
| key | Parcel to search in. |
| sodRef | TextWrapRef to wrap boss |
Implemented in HidTxtParcelListData.