InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ISpreadMultiColumnFrames Class Referenceabstract

#include <ISpreadMultiColumnFrames.h>

Inheritance diagram for ISpreadMultiColumnFrames:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISPREADMULTICOLUMNFRAMES }
 

Public Member Functions

virtual void Add (const IMultiColumnTextFrame *mcf)=0
 
virtual bool16 GetHas (UID mcfUID) const =0
 
virtual int32 GetAll (UIDList *pList=nil) const =0
 
virtual void Remove (const IMultiColumnTextFrame *mcf)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Interface for storing a list of UID to MCFs that are on the Spread.

Member Function Documentation

virtual void ISpreadMultiColumnFrames::Add (const IMultiColumnTextFramemcf)
pure virtual
Adds a value to the list. Duplicates are not allowed.

Parameters
mcfPointer to IMultiColumnTextFrame to add to the list
virtual int32 ISpreadMultiColumnFrames::GetAll (UIDListpList = nil) const
pure virtual
Returns the list of MultiColumnTextFrames previously added.

Parameters
pListPointer to UIDList of MCFs on the Spread.
Returns
Count of MCFs on the spread.
virtual bool16 ISpreadMultiColumnFrames::GetHas (UID mcfUID) const
pure virtual
Returns kTrue if the specified MultiColumnTextFrames is known.

Parameters
mcfUIDUID of MCF
Returns
kTrue/kFalse
virtual void ISpreadMultiColumnFrames::Remove (const IMultiColumnTextFramemcf)
pure virtual
Removes a previously added value from the list. The value must be valid.

Parameters
mcfPointer to IMultiColumnTextFrame to remove from the list