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

#include <IXMLImportOptions.h>

Inheritance diagram for IXMLImportOptions:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IXMLIMPORTOPTIONS }
 
enum  ImportStyle { kAppend = 0, kMerge, kPartial }
 

Public Member Functions

virtual bool16 GetImportIntoSelected () const =0
 
virtual void SetImportIntoSelected (bool16 importIntoSelected)=0
 
virtual ImportStyle GetImportStyle () const =0
 
virtual void SetImportStyle (ImportStyle importStyle)=0
 
virtual bool16 GetImportRuby (void) const =0
 
virtual void SetImportRuby (bool16 importRuby)=0
 
virtual bool16 ShouldUseImportFilter () const =0
 
virtual void UseImportFilter (const bool16 &useFilter=kTrue)=0
 
virtual void Copy (IXMLImportOptions *otherOptions)=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 representing preferences for import. Use command of type kChangeXMLImportOptionsCmdBoss to change prefs rather than calling mutators on the interface on the session or doc workspaces.

Member Enumeration Documentation

enum IXMLImportOptions::ImportStyle

Enumeration of ways that content can be imported.

Member Function Documentation

virtual void IXMLImportOptions::Copy (IXMLImportOptions * otherOptions)
pure virtual

Mutator, copy state from another preferences interface into this

Parameters
otherOptionsinterface to copy state from into this
virtual bool16 IXMLImportOptions::GetImportIntoSelected () const
pure virtual

Determine whether importer should import into tree at selected node

Returns
bool16 kTrue if should import into selected item in structure
virtual bool16 IXMLImportOptions::GetImportRuby (void ) const
pure virtual

Accessor for whether to import ruby with the W3C markup. If this is kTrue and the incoming XML with the W3C markup will be converted to InDesign ruby. If this is kFalse, The ruby tag will remain as a normal tag.

Returns
bool16 kTrue to import ruby
virtual ImportStyle IXMLImportOptions::GetImportStyle () const
pure virtual

Accessor for import style stored on this.

Returns
import style stored on this interface
virtual void IXMLImportOptions::SetImportIntoSelected (bool16 importIntoSelected)
pure virtual

Mutator for property specifying whether to import into logical structure tree at selected node

Parameters
importIntoSelected
virtual void IXMLImportOptions::SetImportRuby (bool16 importRuby)
pure virtual

Mutator for setting whether to import ruby with the W3C markup.

Parameters
importRubykTrue if importing ruby.
virtual void IXMLImportOptions::SetImportStyle (ImportStyle importStyle)
pure virtual

Mutator for import style stored on this interface

Parameters
importStylenew style to store
virtual bool16 IXMLImportOptions::ShouldUseImportFilter () const
pure virtual

Accessor indicating whether or not an import filter should be used.

Returns
import style stored on this interface
virtual void IXMLImportOptions::UseImportFilter (const bool16 & useFilter = kTrue)
pure virtual

Mutator for setting whether of not to use an import filter.

Parameters
importStylenew style to store