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

#include <IChromiumImportHelper.h>

Inheritance diagram for IChromiumImportHelper:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ICHROMIUMIMPORTHELPER }
 

Public Member Functions

virtual bool16 IsSupportingSourceAttributeInJsonData ()=0
 
virtual const char * GetSourceAttribute ()=0
 
virtual void ImportData (std::stringstream &jsonDataStringStream, UIFlags uiFlags)=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

A class deriving from IChromiumImportHelper interface gets invoked for importing incoming JSON data from CEP drag drop operations when the source attribute in the JSON data matches with the source attribute of that class.

Member Function Documentation

virtual const char* IChromiumImportHelper::GetSourceAttribute ()
pure virtual

Obtain the value of source attribute this import helper is interested in.

Returns
A non-null string indicating the expected value of the source attribute that this import helper is interested in. The string is owned by the import helper.
virtual void IChromiumImportHelper::ImportData (std::stringstream & jsonDataStringStream,
UIFlags uiFlags 
)
pure virtual

Import the incoming JSON data - only invoked if the import helper supports the source attribute and its source attribute matches the source attribute in the incoming JSON data.

Parameters
jsonDataStringStreamis the incoming JSON data.
uiFlagswhether the import operation can show UI or not.
virtual bool16 IChromiumImportHelper::IsSupportingSourceAttributeInJsonData ()
pure virtual

Whether the import helper supports the source attribute in JSON data or not. The import helper is ignored if it returns kFalse.

Returns
kTrue if the import helper supports the source attribute in JSON data.