IConditionTagSetList Class Reference

#include <IConditionTagSetList.h>

Inheritance diagram for IConditionTagSetList:

Public Types
enum	{ kDefaultIID = IID_ICONDITIONTAGSETLIST }

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

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

Condition sets are UID based objects that capture visibility states for each condition. These are maintained in lists on the application and document workspaces. Visibilities for condition(s) created after a set is created do not change when a set is made active. A set may be redefined to capture the visibilites for those conditions.

The list is maintained in ascending alphabetical order.

See Also

IConditionalTextFacade

Member Function Documentation

virtual void IConditionTagSetList::Add ( UID  set )

pure virtual

Add a new condition tag set at the (optionally) specified location. The condition set is added in ascending alphabetical order.

Parameters

tag	IN The condition tag set to add to the list.

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

pure virtual

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

Parameters

name	IN The name of the set to find.

Returns

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

virtual int32 IConditionTagSetList::GetCount ( ) const

pure virtual

Get the number of condition tag sets in the list.

Returns

int32 The number of sets.

virtual UID IConditionTagSetList::GetNthSet ( int32  index ) const

pure virtual

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

Parameters

index

IN The index of the set.

Returns

UID The UID of the set at the specified index.

virtual int32 IConditionTagSetList::GetSetIndex ( UID  set ) const

pure virtual

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

Parameters

tag	IN The UID of the set.

Returns

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

virtual void IConditionTagSetList::Move ( UID  set )

pure virtual

Move the condition tag set. This should be called after the condition set is renamed in order to maintain ascending alphabetical order.

Parameters

tag	IN The UID of the set to move.

virtual void IConditionTagSetList::Remove ( UID  set )

pure virtual

Remove the specified condition tag set from the list.

Parameters

tag	IN The set to remove from the list.

virtual WideString IConditionTagSetList::SuggestNewName ( ) const

pure virtual

Suggest a condition tag set name.

Returns

a unique new set name