IConditionalTextOptions Class Reference

#include <IConditionalTextOptions.h>

Inheritance diagram for IConditionalTextOptions:

Public Types
enum	{ kDefaultIID = IID_ICONDITIONALTEXTOPTIONS }
enum	ConditionIndicatorsMode { kShow = 0, kShowAndPrint, kHide }

Public Member Functions
virtual void	SetShowConditionIndicators (ConditionIndicatorsMode showIndicatorsMode)=0
virtual ConditionIndicatorsMode	GetShowConditionIndicators () const =0
virtual void	SetActiveConditionSet (UID conditionSetUID)=0
virtual UID	GetActiveConditionSet () 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

IConditionalTextPrefs is an interface used to set the prefs that control the behavior of conditional text.

Member Enumeration Documentation

enum IConditionalTextOptions::ConditionIndicatorsMode

Enum for specifying mode for condition indicators.

Enumerator
kShow	Condition indicators show.
kShowAndPrint	Condition indicators show and print.
kHide	Condition indicators hide.

Member Function Documentation

virtual UID IConditionalTextOptions::GetActiveConditionSet ( ) const

pure virtual

Get the active condition set UID. It's preferable to use the method IConditionalTextFacade::GetActiveTagSet instead of calling this routine.

Returns

UID of the active condition set, will be kInvalidUID if no set is active

virtual ConditionIndicatorsMode IConditionalTextOptions::GetShowConditionIndicators ( ) const

pure virtual

Get the conditional text indicators show mode.

Returns

ConditionIndicatorsMode The show mode for conditional text indicators.

virtual void IConditionalTextOptions::SetActiveConditionSet ( UID  conditionSetUID )

pure virtual

Set the active condition set. It's preferable to use the method in IConditionalTextFacade::SetActiveTagSet to do this which instead of calling this routine directly. The facade will fire the right command and update the UI properly this will do none of that.

Parameters

conditionSetUID

IN UID of condition set to make active, may be kInvalidUID if no set is desired to be active

virtual void IConditionalTextOptions::SetShowConditionIndicators ( ConditionIndicatorsMode  showIndicatorsMode )

pure virtual

Set the conditional text indicators show mode.

Parameters

showIndicatorsMode

IN The show mode for conditional text indicators.