Inheritance diagram for Facade::IColorGroupFacade:

Public Types
enum	{ kDefaultIID = IID_ICOLORGROUPFACADE }

Public Member Functions
virtual UID	CreateAndAddColorGroup (IColorGroupList *colorGroupList, const PMString &name, int32 pos=-1)=0

virtual ErrorCode	MoveColorGroups (const UIDList &colorGroupList, int32 toPos)=0

virtual ErrorCode	SetColorGroupName (const UIDRef &colorGroup, const PMString &name)=0

virtual ErrorCode	AddMembers (const UIDRef &colorGroup, const UIDList &memberList, int32 pos=-1)=0

virtual ErrorCode	RemoveMembers (const UIDRef &colorGroup, const UIDList &memberList)=0

virtual ErrorCode	DeleteColorGroups (const UIDList &colorGroupList, bool16 deleteChildren=kFalse)=0

virtual ErrorCode	RemoveFromRespectiveColorGroups (const UIDList &memberList)=0

virtual ErrorCode	DuplicateColorGroups (const UIDList &colorGroupList, UIDList &newColorGroupList)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Function Documentation

virtual ErrorCode Facade::IColorGroupFacade::AddMembers	(	const UIDRef &	colorGroup,
		const UIDList &	memberList,
		int32	pos = `-1`
	)

pure virtual

Add members to a color group at the specified position. A member can be only in one color group. If it is already in any other color group then it would be removed from it.

Parameters

colorGroup	IN The color group to which members need to be added.
memberList	IN The ordered list of members that need to be added.
pos	IN 0 based starting position at which the members will be added. Specify -1 to add to the end.

Returns: kSuccess if the members were successfully added, else an error code.

virtual UID Facade::IColorGroupFacade::CreateAndAddColorGroup	(	IColorGroupList *	colorGroupList,
		const PMString &	name,
		int32	pos = `-1`
	)

pure virtual

Create and add a color group to the color group list.

Parameters

colorGroupList	IN the color group list in which the color group is created and added.
name	IN The name of the color group.
pos	IN 0 based position at which to add the color group. Specify -1 to add to the end.

Returns: UID of the added color group.

virtual ErrorCode Facade::IColorGroupFacade::DeleteColorGroups	(	const UIDList &	colorGroupList,
		bool16	deleteChildren = `kFalse`
	)

pure virtual

Deletes a list of color groups.

Parameters

colorGroupList	IN The list of color groups to be deleted
deleteChildren	IN kTrue means children will also be deleted otherwise it will be moved

Returns: kSuccess if the color groups were successfully deleted, else an error code.

virtual ErrorCode Facade::IColorGroupFacade::DuplicateColorGroups	(	const UIDList &	colorGroupList,
		UIDList &	newColorGroupList
	)

pure virtual

Parameters

colorGroupList	IN The list of color group that need to be duplicated.
newColorGroupList	OUT The list of newly color groups created.

Returns: kSuccess if the members were successfully duplicated, else an error code.

virtual ErrorCode Facade::IColorGroupFacade::MoveColorGroups	(	const UIDList &	colorGroupList,
		int32	toPos
	)

pure virtual

Move color groups to a new position within the same color group list.

Parameters

colorGroupList	IN The UIDList of color groups to be moved.
toPos	IN 0 based starting position to which the color groups will be moved.

Returns: kSuccess if the color groups were successfully moved, else an error code.

virtual ErrorCode Facade::IColorGroupFacade::RemoveFromRespectiveColorGroups ( const UIDList & memberList )

pure virtual

Parameters

memberList IN The list of members to be removed from respective color groups.

Returns: kSuccess if the members were successfully removed, else an error code.

virtual ErrorCode Facade::IColorGroupFacade::RemoveMembers	(	const UIDRef &	colorGroup,
		const UIDList &	memberList
	)

pure virtual

Remove members from a color group.

Parameters

colorGroup	IN The color group from which the members need to be removed.
memberList	IN The list of members that need to be removed.

Returns: kSuccess if the members were successfully removed, else an error code.

virtual ErrorCode Facade::IColorGroupFacade::SetColorGroupName	(	const UIDRef &	colorGroup,
		const PMString &	name
	)

pure virtual

Set the name of a color group.

Parameters

colorGroup	IN The color group to be renamed.
name	IN The name of the color group.

Returns: kSuccess if the color group name was successfully set, else an error code.

Public Types

Public Member Functions

Member Function Documentation