InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IXMLScriptUtils Class Referenceabstract

#include <IXMLScriptUtils.h>

Inheritance diagram for IXMLScriptUtils:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IXMLSCRIPTUTILS }
 

Public Member Functions

virtual IScriptCreateXMLItemProxyScriptObject (const ScriptInfo::RequestContext &context, const XMLReference &xmlItemRef, IPMUnknown *parent=nil)=0
 
virtual IScriptCreateXMLAttributeProxyScriptObject (const ScriptInfo::RequestContext &context, const XMLReference &xmlItemRef, const PMString &name, IPMUnknown *parent=nil)=0
 
virtual IIDXMLElementQueryXMLElement (IScript *script)=0
 
virtual void GetXMLItemTypeAndContent (const XMLReference &xmlItemRef, ScriptID *scriptID=nil, XMLContentReference::ContentType *contentType=nil)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Utilities for simplifying scripting XML items.

Member Function Documentation

virtual IScript* IXMLScriptUtils::CreateXMLAttributeProxyScriptObject (const ScriptInfo::RequestContextcontext,
const XMLReferencexmlItemRef,
const PMStringname,
IPMUnknownparent = nil 
)
pure virtual

Create a proxy script object to represent this XML attribute to the scripting world.

Parameters
xmlItemRefspecifies XML item of interest
nameidentifies the attribute of interest the parent script. Use the default value nil if the parent is unknown.
Returns
IScript interface ptr that has its reference-count incremented
virtual IScript* IXMLScriptUtils::CreateXMLItemProxyScriptObject (const ScriptInfo::RequestContextcontext,
const XMLReferencexmlItemRef,
IPMUnknownparent = nil 
)
pure virtual

Create a proxy script object to represent this XML item to the scripting world. It may be an element, comment, or a PI.

Parameters
xmlItemRefspecifies XML item of interest the parent script. Use the default value nil if the parent is unknown.
Returns
IScript interface ptr that has its reference-count incremented
virtual void IXMLScriptUtils::GetXMLItemTypeAndContent (const XMLReferencexmlItemRef,
ScriptIDscriptID = nil,
XMLContentReference::ContentTypecontentType = nil 
)
pure virtual

Get the scripting object id of the specified XML item. Also get the content that it points to.

Parameters
xmlItemRefspecifies XML item of interest
scriptIDIf not nil will be filled with the object's ScriptID
contentTypeIf not nil will be filled with the object's content type
virtual IIDXMLElement* IXMLScriptUtils::QueryXMLElement (IScriptscript)
pure virtual

Obtain the IIDXMLElement interface from a IScript interface; they are on different bosses

Parameters
scriptspecifies interface on script boss object
Returns
IIDXMLElement interface ptr that has its reference-count incremented