InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IConditionTagSet Class Referenceabstract

#include <IConditionTagSet.h>

Inheritance diagram for IConditionTagSet:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ICONDITIONTAGSET }
 

Public Member Functions

virtual ErrorCode SetName (const WideString &name)=0
 
virtual ErrorCode GetName (WideString &name)=0
 
virtual ErrorCode SetConditionList (const IConditionalTextFacade::ConditionSetElementList &conditions)=0
 
virtual ErrorCode SetConditionList (const UIDList &conditions)=0
 
virtual ErrorCode GetConditionList (IConditionalTextFacade::ConditionSetElementList &conditions)=0
 
virtual ErrorCode RemoveCondition (UID conditionUID)=0
 
virtual ErrorCode AddCondition (const IConditionalTextFacade::ConditionSetElement &condition)=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 tag sets. These are known as "sets" in the conditional text UI. High-level operations are provided by the conditional text facade.

See Also
kConditionTagSetBoss
IConditionalTextFacade

Member Function Documentation

virtual ErrorCode IConditionTagSet::AddCondition (const IConditionalTextFacade::ConditionSetElement & condition)
pure virtual

Append a condition to the condition tag set's list of conditions.

Parameters
conditionIN A pair containing the condition UID and associated visibility flag.
Returns
ErrorCode kSuccess if successful.
See Also
IConditionalTextFacade
virtual ErrorCode IConditionTagSet::GetConditionList (IConditionalTextFacade::ConditionSetElementList & conditions)
pure virtual

Get the condition tag set's list of conditions.

Parameters
conditionsOUT A vector of pairs for the condition UID and associated visibility flag.
Returns
ErrorCode kSuccess if successful.
See Also
IConditionalTextFacade
virtual ErrorCode IConditionTagSet::GetName (WideString & name)
pure virtual

Get the name of the condition tag set.

Parameters
nameOUT The name for the condition tag set
Returns
ErrorCode kSuccess if successful.
virtual ErrorCode IConditionTagSet::RemoveCondition (UID conditionUID)
pure virtual

Remove a condition from the condition tag set.

Parameters
conditionUIDIN The UID of the condition to be removed.
Returns
ErrorCode kSuccess if successfully removed the condition; otherwise, kFailure.
virtual ErrorCode IConditionTagSet::SetConditionList (const IConditionalTextFacade::ConditionSetElementList & conditions)
pure virtual

Set up the condition tag set's list of conditions.

Parameters
conditionsIN A vector of pairs for the condition UID and desired visibility flag.
Returns
ErrorCode kSuccess if successful.
See Also
IConditionalTextFacade
virtual ErrorCode IConditionTagSet::SetConditionList (const UIDList & conditions)
pure virtual

Set up the condition tag set's list of conditions using the current visibility state for the specified conditions.

Parameters
conditionsIN A UIDList of the conditions to include in the set.
Returns
ErrorCode kSuccess if successful.
virtual ErrorCode IConditionTagSet::SetName (const WideString & name)
pure virtual

Set the name of the condition tag set.

Parameters
nameIN The new name for the condition tag set
Returns
ErrorCode kSuccess if successful.