IConditionTagList Class Reference

#include <IConditionTagList.h>

Inheritance diagram for IConditionTagList:

Public Types
enum	{ kDefaultIID = IID_ICONDITIONTAGLIST }

Public Member Functions
virtual void	Add (UID condition)=0
virtual void	Remove (UID condition)=0
virtual void	Move (UID condition)=0
virtual int32	GetCount () const =0
virtual UID	GetNthCondition (int32 index) const =0
virtual int32	GetConditionIndex (UID condition) const =0
virtual UID	FindByName (const WideString &name)=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

An interface off the workspace (document or session) that holds a list of IConditionTag.

The list is maintained in ascending alphabetical order.

See Also

IConditionalTextFacade

IConditionTag

Member Function Documentation

virtual void IConditionTagList::Add ( UID  condition )

pure virtual

Add a new condition tag. The condition is added in ascending alphabetical order.

Parameters

tag	IN The condition to add to the list.

virtual UID IConditionTagList::FindByName ( const WideString &  name )

pure virtual

Get the UID of the condition tag with the specified name.

Parameters

name	IN The name of the condition to find.

Returns

UID The UID of the condition found, kInvalidUID if not found.

virtual int32 IConditionTagList::GetConditionIndex ( UID  condition ) const

pure virtual

Get the index of the specified condition tag in the list.

Parameters

tag	IN The UID of the condition.

Returns

int32 The index of the condition (0-based), or -1 if not found.

virtual int32 IConditionTagList::GetCount ( ) const

pure virtual

Get the number of tags in the list.

Returns

int32 The number of conditions.

virtual UID IConditionTagList::GetNthCondition ( int32  index ) const

pure virtual

Get the UID of the condition tag at the specified index in the list.

Parameters

index

IN The index of the condition.

Returns

UID The UID of the condition at the specified index.

virtual void IConditionTagList::Move ( UID  condition )

pure virtual

Move the condition tag. This should be called after the condition's name is changed in order to maintain ascending alphabetical order.

Parameters

tag	IN The UID of the condition to move.

virtual void IConditionTagList::Remove ( UID  condition )

pure virtual

Remove the specified condition tag from the list.

Parameters

tag	IN The condition to remove from the list.