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

#include <IClassIDListData.h>

Inheritance diagram for IClassIDListData:
IPMUnknownIEyeAttrFilter

Public Types

enum  { kDefaultIID = IID_ICLASSIDLISTDATA }
 
enum  _Placement { kBeginning = 0, kEnd = -2, kInvalidIndex = -1 }
 

Public Member Functions

virtual void AddClassID (const ClassID &newClassID, int32 at=kEnd)=0
 
virtual void RemoveClassID (int32 index)=0
 
virtual void Clear (void)=0
 
virtual ClassID GetClassID (int32 index) const =0
 
virtual void SetClassID (int32 index, const ClassID &replaceClassID)=0
 
virtual int32 GetIndex (const ClassID &classID) const =0
 
virtual int32 Length (void) const =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

Data interface to store a list of ClassID values.

Member Enumeration Documentation

Specifies how the new data should be inserted.
Enumerator
kEnd 

Insert at the beginning.

kInvalidIndex 

Insert at the end.

Member Function Documentation

virtual void IClassIDListData::AddClassID (const ClassIDnewClassID,
int32 at = kEnd 
)
pure virtual

Add the new class ID the specified position.

Parameters
newClassIDis the new class ID to add.
atis the position to add.

Implemented in IEyeAttrFilter.

virtual void IClassIDListData::Clear (void )
pure virtual

Clear the list.

Implemented in IEyeAttrFilter.

virtual ClassID IClassIDListData::GetClassID (int32 index) const
pure virtual

Return the class ID the specified position.

Parameters
indexis the nth position.
Returns
the nth class ID.

Implemented in IEyeAttrFilter.

virtual int32 IClassIDListData::GetIndex (const ClassIDclassID) const
pure virtual

Return the position for given class ID .

Parameters
classIDis class ID.
Returns
the position for the given class ID.

Implemented in IEyeAttrFilter.

virtual int32 IClassIDListData::Length (void ) const
pure virtual
Returns
the number of class ID in the list.

Implemented in IEyeAttrFilter.

virtual void IClassIDListData::RemoveClassID (int32 index)
pure virtual

Remove the new class ID at specified position.

Parameters
indexspecifies the position to remove.

Implemented in IEyeAttrFilter.

virtual void IClassIDListData::SetClassID (int32 index,
const ClassIDreplaceClassID 
)
pure virtual

Set the class ID for the specified position.

Parameters
indexis the nth position.
replaceClassIDis the new class ID.

Implemented in IEyeAttrFilter.