#include <IColorGroupList.h>

Inheritance diagram for IColorGroupList:

Public Types
enum	{ kDefaultIID = IID_ICOLORGROUPLIST }

Public Member Functions
virtual void	AddColorGroup (UID colorGroupUID, int32 pos=-1)=0

virtual void	RemoveColorGroup (UID colorGroupUID)=0

virtual void	RemoveNthColorGroup (int32 pos)=0

virtual void	RemoveAllColorGroups ()=0

virtual int32	CountColorGroups () const =0

virtual UIDRef	GetNthColorGroup (int32 pos) const =0

virtual int32	GetColorGroupPosition (UID colorGroupUID) const =0

virtual UIDRef	FindColorGroup (const PMString &name) 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

Provides access to the color groups in the color group list

Member Function Documentation

virtual void IColorGroupList::AddColorGroup	(	UID	colorGroupUID,
		int32	pos = `-1`
	)

pure virtual

Add a color group at the specified position in the color group list.

Parameters

colorGroupUID	IN the UID of the color group that needs to be added.
pos	IN 0 based position at which to add the color group. Specify -1 to add to the end.

virtual int32 IColorGroupList::CountColorGroups ( ) const

pure virtual

Get the number of color groups in the color group list.

Returns: the number of color groups.

virtual UIDRef IColorGroupList::FindColorGroup ( const PMString & name ) const

pure virtual

Find color group in the color group list by name.

Parameters

name	IN the name of the color group in the color group list.

Returns: the UIDRef of the color group.

virtual int32 IColorGroupList::GetColorGroupPosition ( UID colorGroupUID ) const

pure virtual

Get the position of the color group in the color group list.

Parameters

colorGroupUID IN the UID of the color group in the color group list.

Returns: the position of the color group.

virtual UIDRef IColorGroupList::GetNthColorGroup ( int32 pos ) const

pure virtual

Get the Nth color group UID from the color group list.

Parameters

pos	IN the 0 based index of the color group in the color group list.

Returns: the UID of the color group.

virtual void IColorGroupList::RemoveAllColorGroups ( )

pure virtual

Remove all color groups from the color group list.

virtual void IColorGroupList::RemoveColorGroup ( UID colorGroupUID )

pure virtual

Remove a color group from the color group list.

Parameters

colorGroupUID IN the UID of the color group that needs to be removed.

virtual void IColorGroupList::RemoveNthColorGroup ( int32 pos )

pure virtual

Remove a color group from the color group list.

Parameters

pos	IN the position of the color group in the color group list.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation