Accessibility
ISpreadList
API classesBoss classesText interfacesSample plug-insSamples by typeCommonSnippetsBuild number
                   

ISpreadList Class Reference

ISpreadList is an interface off the document containing a list of the ISpreads in the document. More...

#include <ISpreadList.h>

Inheritance diagram for ISpreadList:

IPMUnknownList of all members.

Public Types

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

Public Methods

virtual void InsertSpreads (const UIDList &spreadToInsert, int32 posForInsert)=0
 InsertSpreads - put the given spreads after the given position.

virtual void InsertOneSpread (const UID spreadToInsert, int32 posForInsert)=0
 InsertOneSpread - add one spread at the specified position.

virtual void RemoveSpreads (int32 firstIndex, int32 count)=0
 RemoveSpreads - delete 'count' spreads, starting at 'firstIndex'.

virtual void RemoveOneSpread (int32 posForRemove)=0
 RemoveOneSpread - remove one spread at the specified position.

virtual void MoveSpread (int32 from, int32 to)=0
 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.

virtual IGeometryQueryNthSpread (int32 spreadIndex)=0
 QueryNthSpread - return the IGeometry interface associated with the 'spreadIndex' spread.

virtual UID GetNthSpreadUID (int32 spreadIndex)=0
 GetNthSpreadUID - Returns the 'spreadIndex' spread's UID.

virtual int32 GetSpreadCount () const=0
 GetSpreadCount - Return the number of spreads in this list (ie in the document).

virtual int32 GetSpreadIndex (IGeometry *spread)=0
 GetSpreadIndex - Given a spread's IGeometry, return its index into the spread list.

virtual int32 GetSpreadIndex (UID spreadUID)=0
 GetSpreadIndex - Given a spread's UID, return the spread's index into the spread list.

virtual IIteratorNewPageIterator ()=0
 NewPageIterator - create a page iterator & return the generic IIterator to the caller NOTE : The caller is responsible for deleteing the returned iterator.


Detailed Description

ISpreadList is an interface off the document containing a list of the ISpreads in the document.

Master spreads are in the IMasterSpreadList interface.


Member Enumeration Documentation

anonymous enum
 

Enumeration values:
kDefaultIID 

00046 { kDefaultIID = IID_ISPREADLIST };

anonymous enum
 

Enumeration values:
kAtTheEnd 

00048 { kAtTheEnd = -1 };

Member Function Documentation

virtual UID GetNthSpreadUID int32   spreadIndex [pure virtual]
 

GetNthSpreadUID - Returns the 'spreadIndex' spread's UID.

Parameters:
spreadIndex 
Returns:
UID

virtual int32 GetSpreadCount   [pure virtual]
 

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

Returns:
int32

virtual int32 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 int32 GetSpreadIndex IGeometry  spread [pure virtual]
 

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

Parameters:
spread 
Returns:
int32

virtual void InsertOneSpread const UID   spreadToInsert,
int32   posForInsert
[pure virtual]
 

InsertOneSpread - add one spread at the specified position.

Parameters:
spreadToInsert 
posForInsert 

virtual void InsertSpreads const UIDList  spreadToInsert,
int32   posForInsert
[pure virtual]
 

InsertSpreads - put the given spreads after the given position.

Parameters:
spreadToInsert 
posForInsert 

virtual void 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* 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* 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 RemoveOneSpread int32   posForRemove [pure virtual]
 

RemoveOneSpread - remove one spread at the specified position.

Parameters:
posForRemove 

virtual void RemoveSpreads int32   firstIndex,
int32   count
[pure virtual]
 

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

Parameters:
firstIndex 
count 

The documentation for this class was generated from the following file:

Boss classes that aggregate this interface