InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ISpreadList Class Referenceabstract

#include <ISpreadList.h>

Inheritance diagram for ISpreadList:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISPREADLIST }
 
enum  { kAtTheEnd = -1 }
 

Public Member Functions

virtual void InsertSpreads (const UIDList &spreadToInsert, int32 posForInsert)=0
 
virtual void InsertOneSpread (const UID spreadToInsert, int32 posForInsert)=0
 
virtual void RemoveSpreads (int32 firstIndex, int32 count)=0
 
virtual void RemoveOneSpread (int32 posForRemove)=0
 
virtual void MoveSpread (int32 from, int32 to)=0
 
virtual IGeometry * QueryNthSpread (int32 spreadIndex)=0
 
virtual UID GetNthSpreadUID (int32 spreadIndex)=0
 
virtual int32 GetSpreadCount () const =0
 
virtual int32 GetSpreadIndex (IGeometry *spread)=0
 
virtual int32 GetSpreadIndex (UID spreadUID)=0
 
virtual IIterator * NewPageIterator ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Represents a list of spreads (kSpreadBoss) in a given document (kDocBoss).

ISpreadList is an interface off the document (kDocBoss) containing a list of the spreads (kSpreadBoss) in the document. Master spreads are stored in the IMasterSpreadList interface. ISpreadList stores a list of spreads (as UIDs) in a given document; this list is persistent.

See Also
kDocBoss
kSpreadBoss
ISpread
IMasterSpreadList

Member Function Documentation

virtual UID ISpreadList::GetNthSpreadUID (int32 spreadIndex)
pure virtual

GetNthSpreadUID - Returns the 'spreadIndex' spread's UID

Parameters
spreadIndex
Returns
UID
virtual int32 ISpreadList::GetSpreadCount () const
pure virtual

GetSpreadCount - Return the number of spreads in this list (ie in the document)

Returns
int32
virtual int32 ISpreadList::GetSpreadIndex (IGeometry * spread)
pure virtual

GetSpreadIndex - Given a spread's IGeometry, return its index into the spread list

Parameters
spread
Returns
int32
virtual int32 ISpreadList::GetSpreadIndex (UID spreadUID)
pure virtual

GetSpreadIndex - Given a spread's UID, return the spread's index into the spread list.

Parameters
spreadUID
Returns
int32
virtual void ISpreadList::InsertOneSpread (const UID spreadToInsert,
int32 posForInsert 
)
pure virtual

InsertOneSpread - add one spread at the specified position

Parameters
spreadToInsert
posForInsert
virtual void ISpreadList::InsertSpreads (const UIDList & spreadToInsert,
int32 posForInsert 
)
pure virtual

InsertSpreads - put the given spreads after the given position

Parameters
spreadToInsert
posForInsert
virtual void ISpreadList::MoveSpread (int32 from,
int32 to 
)
pure virtual

MoveSpread - Move the spread at the from index to the to index in the list Note that the spread is first removed from the list, then inserted at the "to" position. Caller may need to adjust indexes in order to compensate for this behavior.

Parameters
from
to
virtual IIterator* ISpreadList::NewPageIterator ()
pure virtual

NewPageIterator - create a page iterator & return the generic IIterator to the caller NOTE : The caller is responsible for deleteing the returned iterator

Returns
IIterator*
virtual IGeometry* ISpreadList::QueryNthSpread (int32 spreadIndex)
pure virtual

QueryNthSpread - return the IGeometry interface associated with the 'spreadIndex' spread. This will add a ref count, and will instantiate the spread (if necessary).

Parameters
spreadIndex
Returns
IGeometry*
virtual void ISpreadList::RemoveOneSpread (int32 posForRemove)
pure virtual

RemoveOneSpread - remove one spread at the specified position

Parameters
posForRemove
virtual void ISpreadList::RemoveSpreads (int32 firstIndex,
int32 count 
)
pure virtual

RemoveSpreads - delete 'count' spreads, starting at 'firstIndex'.

Parameters
firstIndex
count