IConditionTag Class Reference

#include <IConditionTag.h>

Inheritance diagram for IConditionTag:

Public Types
enum	{ kDefaultIID = IID_ICONDITIONTAG }
enum	IndicatorMethod { kUnderline = 0, kHighlight = 1 }
enum	UnderlineIndicatorAppearance { kSingleWavy = 0, kSolid = 1, kDashed = 2 }

Public Member Functions
virtual WideString	GetName () const =0
virtual void	SetName (const WideString &name)=0
virtual bool16	IsVisible () const =0
virtual void	SetVisible (bool16 visible)=0
virtual UID	GetColor () const =0
virtual void	SetColor (UID colorUID)=0
virtual IndicatorMethod	GetMethod () const =0
virtual void	SetMethod (IndicatorMethod method)=0
virtual UnderlineIndicatorAppearance	GetAppearance () const =0
virtual void	SetAppearance (UnderlineIndicatorAppearance appearance)=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

Interface to get and set data associated with condition tags. These are known as "conditions" in the conditional text UI. High-level operations are provided by the conditional text facade.

See Also

kConditionTagBoss

IConditionalTextFacade

Member Function Documentation

virtual UnderlineIndicatorAppearance IConditionTag::GetAppearance ( ) const

pure virtual

Get the appearance of the underline indicator for text with this condition tag applied.

Returns

UnderlineIndicatorAppearance The appearance for the underline indicator

virtual UID IConditionTag::GetColor ( ) const

pure virtual

Get the display color for text with this condition tag applied.

Returns

UID The UID of the color

virtual IndicatorMethod IConditionTag::GetMethod ( ) const

pure virtual

Get the method of indicator for text with this condition tag applied.

Returns

IndicatorMethod The method for the indicator

virtual WideString IConditionTag::GetName ( ) const

pure virtual

Get the name of the condition tag.

Returns

WideString The name of the condition tag

virtual bool16 IConditionTag::IsVisible ( ) const

pure virtual

Get the visibility for text with this condition tag applied.

Parameters

none

Returns

bool16

virtual void IConditionTag::SetAppearance ( UnderlineIndicatorAppearance  appearance )

pure virtual

Set the appearance of the underline indicator for the text with this condition tag applied.

Parameters

appearance

The appearance setting for the underline indicator

virtual void IConditionTag::SetColor ( UID  colorUID )

pure virtual

Set the display color for the text with this condition tag applied.

Parameters

colorUID

The UID of the color

virtual void IConditionTag::SetMethod ( IndicatorMethod  method )

pure virtual

Set the method of indicator for the text with this condition tag applied.

Parameters

method

The method for the indicator

virtual void IConditionTag::SetName ( const WideString &  name )

pure virtual

Set the name of the condition tag.

Parameters

name	IN The new name for the condition tag

virtual void IConditionTag::SetVisible ( bool16  visible )

pure virtual

Set the visiblity for text with this condition tag applied.

Parameters

visible

The kTrue if the text with this condition tag applied should who or kFalse if it should hide