IConditionTagSuite Class Reference

#include <IConditionTagSuite.h>

Inheritance diagram for IConditionTagSuite:

Public Types
enum	{ kDefaultIID = IID_ICONDITIONTAGSUITE }

Public Member Functions
virtual ErrorCode	GetAppliedConditionTags (UIDList &tagsAppliedToAllChars, UIDList &tagsAppliedToSomeChars, bool16 *rangeHasUnconditionalChars=nil)=0
virtual ErrorCode	ApplyConditionTags (const K2Vector< UID > &tagsToApply, bool16 removeExisting)=0
virtual bool16	CanApplyConditionTags ()=0
virtual ErrorCode	UnapplyConditionTags (const K2Vector< UID > &tagsToUnapply)=0
virtual bool16	CanUnapplyConditionTags ()=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

Suite to manipulate condition tags for the current selection.

Member Function Documentation

virtual ErrorCode IConditionTagSuite::ApplyConditionTags ( const K2Vector< UID > &  tagsToApply, bool16  removeExisting  )

pure virtual

Applies the specified condition tag(s) to the current selection.

Parameters

tagsToApply	IN The condition tags to applied to the current selection.
removeExisting	IN Whether or not condition tags already applied are removed.

Returns

ErrorCode kSuccess if operation could be completed successfully.

virtual bool16 IConditionTagSuite::CanApplyConditionTags ( )

pure virtual

Determine whether or not the current selection can have a condition tag applied.

Returns

bool16 kTrue if can apply condition tag to the selection.

virtual bool16 IConditionTagSuite::CanUnapplyConditionTags ( )

pure virtual

Determine whether or not the current selection can have a condition tag unapplied.

Returns

bool16 kTrue if can unapply condition tag to the selection.

virtual ErrorCode IConditionTagSuite::GetAppliedConditionTags ( UIDList &  tagsAppliedToAllChars, UIDList &  tagsAppliedToSomeChars, bool16 *  rangeHasUnconditionalChars = nil  )

pure virtual

This method gathers the condition tags that are applied to either all of the characters in the selection or that are applied to some of the characters in the selection. These are returned in lists passed in by the callers.

Parameters

tagsAppliedToAllChars	The condition tags applied to all of the characters.
tagsAppliedToSomeChars	The condition tags applied to some of the characters.
rangeHasUnconditionalChars	A pointer to bool for whether or not the range has characters that are unconditional (i.e. have no conditions applied).

Returns

ErrorCode kSuccess unless an error occurred.

virtual ErrorCode IConditionTagSuite::UnapplyConditionTags ( const K2Vector< UID > &  tagsToUnapply )

pure virtual

Removes the specified condition tag(s) from the current selection. Tags applied that are not in the specified list of condition tag(s) to be unapplied will remain applied.

Parameters

tagsToApply

IN The condition tags to remove from the current selection.

Returns

ErrorCode kSuccess if operation could be completed successfully.