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

#include <IXMLExportSessionOptions.h>

Inheritance diagram for IXMLExportSessionOptions:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IXMLEXPORTSESSIONOPTIONS }
 

Public Member Functions

virtual bool16 GetViewAfterExport () const =0
 
virtual void SetViewAfterExport (bool16 viewAfterExport)=0
 
virtual const IDFileGetXMLPreferredBrowser (void)=0
 
virtual void SetXMLPreferredBrowser (const IDFile &pBrowser)=0
 
virtual const IDFileGetXMLUserDefinedBrowser (int32 indx)=0
 
virtual void SetXMLUserDefinedBrowser (int32 indx, const IDFile &pBrowser)=0
 
virtual void Copy (IXMLExportSessionOptions *otherOptions)=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

Interface storing XML export options. Mutate the options stored on the session workspace t through the command kChangeXMLExportSOptionsCmdBoss rather than directly on the interface on the session workspace.

Member Function Documentation

virtual void IXMLExportSessionOptions::Copy (IXMLExportSessionOptionsotherOptions)
pure virtual

Mutate contents of this interface by copying state from another

Parameters
otherOptionsspecifies other interface whose state we'll copy from
virtual bool16 IXMLExportSessionOptions::GetViewAfterExport () const
pure virtual

Accessor for property specifying whether to view after exporting

Returns
bool16 specifying whether end-user wants to view exported XML-based content
virtual const IDFile& IXMLExportSessionOptions::GetXMLPreferredBrowser (void )
pure virtual

Accessor for viewer that is current user default

NOTE: This is a reference to internal data. Be sure to not let this interface go out of scope before you are done using the IDFile

Returns
IDFile giving path to exec browser
virtual const IDFile& IXMLExportSessionOptions::GetXMLUserDefinedBrowser (int32 indx)
pure virtual

Accessor for viewer set by end-user

NOTE: This is a reference to internal data. Be sure to not let this interface go out of scope before you are done using the IDFile

Parameters
indxspecifies index in browser-list of interest
Returns
IDFile giving path to exec user defined XML viewer
virtual void IXMLExportSessionOptions::SetViewAfterExport (bool16 viewAfterExport)
pure virtual

Mutator for property specifying whether to view after exporting

Parameters
viewAfterExportkTrue if should view after export, kFalse otherwise
virtual void IXMLExportSessionOptions::SetXMLPreferredBrowser (const IDFilepBrowser)
pure virtual

Mutator for viewer that's user's current default

Parameters
pBrowserspecifies new browser to set as preferred by end-user
virtual void IXMLExportSessionOptions::SetXMLUserDefinedBrowser (int32 indx,
const IDFilepBrowser 
)
pure virtual

Mutator for viewer set by end-user

Parameters
indxlocation to add this browser in list stored
pBrowserspecifies new browser to store on this interface