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

#include <ITextVariableFacade.h>

Inheritance diagram for ITextVariableFacade:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTVARIABLEFACADE }
 

Public Member Functions

virtual ErrorCode GetVariableTypeInfo (ITextVariableTable *varTable, ClassID variableClassID, VariableTypeInfo *typeInfo) const =0
 
virtual ErrorCode GetNumVariables (ITextVariableTable *varTable, int32 *n) const =0
 
virtual ErrorCode QueryNthVariable (ITextVariableTable *varTable, int32 n, ITextVariable *&var) const =0
 
virtual ErrorCode AddVariable (ITextVariableTable *varTable, const AddVariableInfo &newInfo) const =0
 
virtual ErrorCode RemoveVariable (ITextVariableTable *varTable, const WideString &varName) const =0
 
virtual ErrorCode InsertVariable (ITextVariableTable *varTable, const WideString &varName, const ModelRange &insertAt, UIDRef *newVarInstance, bool16 isINXContext=kFalse) const =0
 
virtual ErrorCode ChangeVariable (ITextVariableTable *varTable, const WideString &varName, const ChangeVariableInfo &chgInfo) const =0
 
virtual ErrorCode FindLocationsUsed (ITextVariableTable *varTable, const WideString *varName, const ModelRange *searchRange, bool16 hiddenStories, K2Vector< ModelRange > &results) const =0
 
virtual ErrorCode ChangeVariableInstance (IOwnedItem *ownedItem, const ChangeVariableInstanceInfo &chgInfo) const =0
 
virtual ErrorCode LoadVariables (ITextVariableTable *varTable, const IDFile &sourceFile, const std::map< PMString, bool32 > &importMap, const std::map< PMString, bool32 > &clashMap, const std::map< PMString, StyleClashResolutionTypes::StyleClashResolutionStrategy > &resolveMap, const StyleClashResolutionTypes::GlobalClashResolutionStrategy &gcrStrategy) const =0
 
virtual ErrorCode LoadVariables (ITextVariableTable *varTable, const std::string &assetRef, const std::map< PMString, bool32 > &importMap, const std::map< PMString, bool32 > &clashMap, const std::map< PMString, StyleClashResolutionTypes::StyleClashResolutionStrategy > &resolveMap, const StyleClashResolutionTypes::GlobalClashResolutionStrategy &gcrStrategy) 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

A high level API for dealing with Text Variables. To use this Facade, include this header file and the use the following example syntax: Utils<ITextVariableFacade>()->XXX( yyy );

Note
See ITextVariableSuite for descriptions of these methods as this is a mirror interface to that, with the exception that this takes a target ITextVariableTable
The Scripting module uses this interface directly, and the UI module(s) use this indirectly via the ITextVariableSuite, both of which determine and provide the varTable parameters