InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
VOS_RedlineObject Class Reference
Inheritance diagram for VOS_RedlineObject:
VOS_Object

Public Member Functions

 VOS_RedlineObject (int32 length=0)
 
 VOS_RedlineObject (int32 length, const VOSRedlineChange &change)
 
virtual int32 VirtualLength () const
 
virtual VOS_ObjectDuplicate () const
 
virtual VOS_ObjectDivide (int32 atOffset)
 
virtual bool16 JoinWith (VOS_Object *next)
 
virtual VOS_ObjectSplit ()
 
void SetLength (int32 len)
 
void AdjustLength (int32 delta)
 
int32 NumberOfChanges () const
 
const VOSRedlineChangeGetChange (int32 n) const
 
RedlineChangeUndoAcceptThrough (const VOSRedlineChange &change, IRedlineDataStrand *redline)
 
RedlineChangeUndoRejectChange (const VOSRedlineChange &change, IRedlineDataStrand *redline, TextIndex start, bool16 *removeObj)
 
void UndoChanges (RedlineChangeUndo *undo, bool16 undoReject, VOS_Cursor &cursor, int32 len)
 
void ReadWrite (IPMStream *s, ImplementationID prop)
 
RedlineChangeUndoMoveChangeRecord (VOS_Cursor &cursor)
 
bool16 UndoMoveChangeRecord (RedlineChangeUndo *undo)
 
void AppendChangeRecord (const VOSRedlineChange &change)
 
void RemoveChangeRecord (int32 changeIndex)
 
void ClearChangeStack ()
 
- Public Member Functions inherited from VOS_Object
VOS_Objectoperator= (const VOS_Object &rhs)=delete
 
virtual void Release ()
 
virtual void AddRef ()
 
virtual void SetDiskPage (IVOSDiskPage *block)
 
IVOSDiskPageGrabDiskPage ()
 
IDataBaseGetDataBase () const
 
void InsertObj (VOS_Object *newone)
 
void AppendObj (VOS_Object *newone)
 
void AdjustObjectLength (int32 delta)
 
void PreDirty (bool8 dbModified=kTrue)
 
bool16 IsDirty () const
 
int32 VirtualKey () const
 
SnapshotID GetSnapshotID () const
 
void SetSnapshot (scoped_snapshotdataref &snapshot)
 
bool16 IsSnapshotUptodate () const
 
void SetSnapshotNotuptodate ()
 

Static Public Member Functions

static const PMString CurrentUser (VOS_RedlineObject *qThis)
 
static void Insert (VOS_Cursor &cursor, IRedlineDataStrand *redline, int32 len, bool16 trackInsert, const VOSRedlineChange *useThisChange, bool16 pasting, bool16 isNoteChar, bool16 isTableContinuation=kFalse, bool16 isSaveBack=kFalse)
 
static RedlineUndoChangeAttribute (VOS_Cursor &cursor, int32 len)
 
static RedlineUndoDoReplace (VOS_Cursor &cursor, IRedlineDataStrand *redline, TextIndex pos, int32 len, const WideString *newData)
 
static IStrandPastePieceCut (VOS_Cursor &cursor, IRedlineDataStrand *redline, TextIndex pos, int32 len, bool16 trackThisEdit)
 
static void InsertSavedData (VOS_Cursor &cursor, VOS_SavedData *data, IRedlineDataStrand *redline)
 
static void UnreplaceSavedData (VOS_Cursor &cursor, VOS_SavedData *data)
 
static bool16 CanApplyDeleteChange (VOS_Cursor &cursor, int32 len)
 
static void UndoSimpleChange (VOS_Cursor &cursor, int32 len)
 
static bool16 CanApplyDeleteChange (VOS_Cursor &cursor, int32 len, const PMString &user)
 
- Static Public Member Functions inherited from VOS_Object
static void InsertSavedData (VOS_Cursor &cursor, VOS_SavedData *datalist)
 

Protected Member Functions

 VOS_RedlineObject (const VOS_RedlineObject &copy)
 
- Protected Member Functions inherited from VOS_Object
 VOS_Object (const VOS_Object &copy)
 

Member Function Documentation

virtual VOS_Object* VOS_RedlineObject::Divide (int32 atOffset)
virtual

Splits the object in 2 and returns the bottom portion of the object.

Parameters
atOffsetis the split point, 0 < atOffset < VirtualLength().
Returns
the second half of the object.

Implements VOS_Object.

virtual VOS_Object* VOS_RedlineObject::Duplicate () const
virtual

Create a copy of the object. It is not placed in the data structures, only copied.

Returns
a new copy.

Implements VOS_Object.

virtual bool16 VOS_RedlineObject::JoinWith (VOS_Objectnext)
virtual

Called during Write(), allows two adjacent objects that have become identical to combine.

Parameters
nextis the object that occurs next in the data structure.
Returns
true when the 2 objects should be joined. If so the next object isn't written out.

Implements VOS_Object.

void VOS_RedlineObject::ReadWrite (IPMStreams,
ImplementationID prop 
)
virtual

The object needs to read or write itself to disk.

Parameters
sis the IPMStream.
propis the implementationID of the object.

Implements VOS_Object.

virtual int32 VOS_RedlineObject::VirtualLength () const
virtual

How many characters does this object represent?

Returns
the number of characters.

Implements VOS_Object.