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

#include <IImportResourceCmdData.h>

Inheritance diagram for IImportResourceCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IIMPORTRESOURCECMDDATA }
 

Public Member Functions

virtual void Set (const IImportResourceCmdData *data)=0
 
virtual void Set (IDataBase *db, const URI &uri, UIFlags flags, bool16 retainFormat=kFalse, bool16 convertQuotes=kFalse, bool16 applyCJKGrid=kFalse, UID uidPreview=kInvalidUID)=0
 
virtual void Set (IDataBase *db, UID linkResourceUID, UIFlags flags, UID oldPageItem=kInvalidUID, bool16 retainFormat=kFalse, bool16 convertQuotes=kFalse, bool16 applyCJKGrid=kFalse)=0
 
virtual void SetFlags (UIFlags flags)=0
 
virtual IDataBaseGetDataBase () const =0
 
virtual const URI GetURI () const =0
 
virtual UIFlags GetFlags () const =0
 
virtual bool16 GetRetainFormat () const =0
 
virtual bool16 GetConvertQuotes () const =0
 
virtual bool16 GetApplyCJKGrid () const =0
 
virtual UID GetOldPageItem () const =0
 
virtual UID GetPreview () const =0
 
virtual UID GetLinkResourceUID () const =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 used to store data for commands that import resources. This is a container class, it can store either a link resource (by UID), or a URI identifying some resource. If the link resource is specified, the URI specified with the link resource is the one returned (in the case where there might be a conflict between the URI retained in the interface, and that in ILinkResource).

See Also
ImportResourceCmd, ImportAndLoadPlaceGunCmd, ImportAndPlaceCmd, ImportPIFromResourceCmd, InCopyOpenDocCmd

Member Function Documentation

virtual bool16 IImportResourceCmdData::GetApplyCJKGrid () const
pure virtual

Get the apply CJK grid flag

virtual bool16 IImportResourceCmdData::GetConvertQuotes () const
pure virtual

Get the convert quotes flag

virtual IDataBase* IImportResourceCmdData::GetDataBase () const
pure virtual

Get the database

virtual UIFlags IImportResourceCmdData::GetFlags () const
pure virtual

Get the UIFlags

virtual UID IImportResourceCmdData::GetLinkResourceUID () const
pure virtual

Get the link resource uid

virtual UID IImportResourceCmdData::GetOldPageItem () const
pure virtual

Get the old pageitem

virtual UID IImportResourceCmdData::GetPreview () const
pure virtual

Get the preview object

virtual bool16 IImportResourceCmdData::GetRetainFormat () const
pure virtual

Get the retain text format flag

virtual const URI IImportResourceCmdData::GetURI () const
pure virtual

Get the URI

virtual void IImportResourceCmdData::Set (const IImportResourceCmdDatadata)
pure virtual

Initialize this object from another object of the same type

virtual void IImportResourceCmdData::Set (IDataBasedb,
const URIuri,
UIFlags flags,
bool16 retainFormat = kFalse,
bool16 convertQuotes = kFalse,
bool16 applyCJKGrid = kFalse,
UID uidPreview = kInvalidUID 
)
pure virtual

Initialize this object manually from a URI

Parameters
dbIN database to be imported into (required)
uriIN identifying the resource to import.
flagsIN specifies how much UI to show during import
retainFormatIN retain text format, applies to text import
convertQuotesIN convert quotation mark types, applies to text import
applyCJKGridIN apply CJK grid if present, applies to text import
uidPreviewIN UID of preview object
virtual void IImportResourceCmdData::Set (IDataBasedb,
UID linkResourceUID,
UIFlags flags,
UID oldPageItem = kInvalidUID,
bool16 retainFormat = kFalse,
bool16 convertQuotes = kFalse,
bool16 applyCJKGrid = kFalse 
)
pure virtual

Initialize this object manually from a link resource

Parameters
dbIN database to be imported into (required)
linkResourceUIDIN the link resource to import from (required)
flagsIN specifies how much UI to show during import
oldPageItemIN UID of old page item or kInvalidUID when there is none. This page item contains the preference settings used the last time this item was imported and these preferences are used during this import.
retainFormatIN retain text format, applies to text import
convertQuotesIN convert quotation mark types, applies to text import
applyCJKGridIN apply CJK grid if present, applies to text import
uidPreviewIN UID of preview object
virtual void IImportResourceCmdData::SetFlags (UIFlags flags)
pure virtual

Update the UIFlags