IPluginIDList Class Reference

#include <IPluginIDList.h>

Inheritance diagram for IPluginIDList:

Public Types
enum	{ kDefaultIID = IID_IPLUGINIDLIST }

Public Member Functions
virtual void	Set (const K2Vector< PluginID > &list)=0
virtual void	Add (IPluginIDList *copyThis)=0
virtual void	Add (PluginID addThis)=0
virtual void	Remove (PluginID removeThis)=0
virtual void	Clear ()=0
virtual bool16	IsInList (PluginID pluginID) const =0
virtual int32	Length () const =0
virtual PluginID	GetNth (int32 i) const =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

Data interface for storing a list of plug-in IDs values

Member Function Documentation

virtual void IPluginIDList::Add ( IPluginIDList *  copyThis )

pure virtual

Add every plug-in the supplied list to this

Parameters

copyThis

list to copy from.

virtual void IPluginIDList::Add ( PluginID  addThis )

pure virtual

Add a new plug-in to the list

Parameters

addThis

plug-in to add

virtual void IPluginIDList::Clear ( )

pure virtual

Empty the list.

virtual PluginID IPluginIDList::GetNth ( int32  i ) const

pure virtual

Fetch a plug-in from the list by index.

Parameters

i	index of the plug-in to fetch

Returns

plug-in ID at the i'th position in the list.

virtual bool16 IPluginIDList::IsInList ( PluginID  pluginID ) const

pure virtual

Returns whether the plug-in is in the list.

Parameters

pluginID

plug-in to check

Returns

kTrue if the plug-in is in the list, kFalse otherwise.

virtual int32 IPluginIDList::Length ( ) const

pure virtual

Returns the number of plug-ins in the list.

Returns

number of plug-ins in the list.

virtual void IPluginIDList::Remove ( PluginID  removeThis )

pure virtual

Remove a plug-in from the list.

Parameters

removeThis

plug-in to remove.

virtual void IPluginIDList::Set ( const K2Vector< PluginID > &  list )

pure virtual

Copy list into this

Parameters

list	- list to copy from.