InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IRedlineDataStrand Class Referenceabstract
Inheritance diagram for IRedlineDataStrand:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IREDLINEDATASTRAND }
 
enum  RedlinePhase {
  kPhase_Normal, kPhase_Storage, kPhase_Rejecting, kPhase_MovingStory,
  kPhase_MovingStoryAndPreserve, kPhase_CreatingNote, kPhase_XMLDeleteMarker, kPhase_XMLInsertMarker,
  kPhase_TrackConvertNote, kPhase_ConvertingNote, kPhase_SkipTable, kPhase_IMEInsertResult,
  kPhase_IMEInsertComp
}
 
enum  ChangeStateTransition { kCST_Unknown, kCST_Insert, kCST_Remove }
 

Public Member Functions

virtual bool16 DoSyncToStory (UID story)=0
 
virtual UID GetTextModelUID () const =0
 
virtual void ApplyRedlineChange (VOSRedlineChange::RedlineChangeType type, TextIndex position, const uint64 &time, bool16 moved, int32 len, const PMString &user)=0
 
virtual void UndoChange (TextIndex pos, RedlineChangeUndo *undo, int32 changeLen, bool16 inserted, bool16 undoReject)=0
 
virtual RedlineChangeUndoDoAcceptChange (TextIndex position, const VOSRedlineChange &change, int32 *changeLen)=0
 
virtual RedlineChangeUndoDoRejectChange (TextIndex position, const VOSRedlineChange &change, int32 *changeLen, bool16 *inserted)=0
 
virtual void DoAcceptRedlineChangeRange (TextIndex position, int32 len)=0
 
virtual void UndoAcceptRedlineChangeFront (TextIndex position, int32 len)=0
 
virtual void UndoAcceptRedlineChangeBack (TextIndex position, int32 len)=0
 
virtual void UndoAcceptRedlineChangeMiddle (TextIndex position, int32 len)=0
 
virtual void RemoveRedlineChange (TextIndex objPosition, const VOSRedlineChange &changeToRemove)=0
 
virtual void ClearRedlineChanges (TextIndex objPosition)=0
 
virtual void PushPhase (RedlinePhase phase)=0
 
virtual void PopPhase ()=0
 
virtual RedlinePhase CurrentPhase ()=0
 
virtual RedlineIteratorNewRedlineIterator (TextIndex startingAt=0, int32 atChange=-1)=0
 
virtual RedlineIteratorNewRedlineDisplayOrderIterator (TextIndex startingAt=0, int32 atChange=-1)=0
 
virtual bool16 StoryHasChanges () const =0
 
virtual void UpdateChangeStatus (ChangeStateTransition transition)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual RedlineIterator* IRedlineDataStrand::NewRedlineDisplayOrderIterator (TextIndex startingAt = 0,
int32 atChange = -1 
)
pure virtual

Iterate track changes in display order. Used for ui code. There is more overhead for this method than the NewRedlineIterator().

Parameters
startingAtIN - where to start iteration at
atChangeIN a single location may have more than one change, if you know you want to start on a specific change index specify it with this.
Returns
iterator that allows traversal of the track changes in the order they appear on the screen in story and galley views.
virtual RedlineIterator* IRedlineDataStrand::NewRedlineIterator (TextIndex startingAt = 0,
int32 atChange = -1 
)
pure virtual

Iterate track changes in model order. Most code uses this rather than the NewRedlineDisplayOrderIterator() method.

Parameters
startingAtIN - where to start iteration at
atChangeIN a single location may have more than one change, if you know you want to start on a specific change index specify it with this.
Returns
iterator that allows traversal of the track changes in the order they appear in the text model
virtual bool16 IRedlineDataStrand::StoryHasChanges () const
pure virtual

Check whether the story contains tracked changes which are not in hidden conditional text.

Returns
bool16 kTrue if story contains tracked changes. Otherwise return kFalse.
virtual void IRedlineDataStrand::UpdateChangeStatus (ChangeStateTransition transition)
pure virtual

Updates StoryHasChanges flag if necessary.