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

#include <ISetAdobeCoreMDCmdData.h>

Inheritance diagram for ISetAdobeCoreMDCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISETADOBECOREMDCMDDATA }
 

Public Member Functions

virtual void Set (IPMUnknown *targetObject, const UnspecifiableOf< PMString > &title=kUnspecified, const UnspecifiableOf< K2Vector< PMString > > &authors=kUnspecified, const UnspecifiableOf< PMString > &description=kUnspecified, const UnspecifiableOf< K2Vector< PMString > > &keywords=kUnspecified, const UnspecifiableOf< XMP_DateTime > &metadataDate=kUnspecified, const UnspecifiableOf< XMP_DateTime > &modifyDate=kUnspecified, const UnspecifiableOf< XMP_DateTime > &createDate=kUnspecified, const UnspecifiableOf< metadata::AgentName > &creatorTool=kUnspecified, const UnspecifiableOf< metadata::URI > &baseURL=kUnspecified, const UnspecifiableOf< PMString > &nickname=kUnspecified)=0
 
virtual IPMUnknownQueryTargetObject (const PMIID &iid) const =0
 
virtual UnspecifiableOf< PMStringGetTitle () const =0
 
virtual UnspecifiableOf
< K2Vector< PMString > > 
GetAuthors () const =0
 
virtual UnspecifiableOf< PMStringGetDescription () const =0
 
virtual UnspecifiableOf
< K2Vector< PMString > > 
GetKeywords () const =0
 
virtual UnspecifiableOf
< XMP_DateTime > 
GetMetadataDate () const =0
 
virtual UnspecifiableOf
< XMP_DateTime > 
GetModifyDate () const =0
 
virtual UnspecifiableOf
< XMP_DateTime > 
GetCreateDate () const =0
 
virtual UnspecifiableOf
< metadata::AgentName
GetCreatorTool () const =0
 
virtual UnspecifiableOf
< metadata::URI
GetBaseURL () const =0
 
virtual UnspecifiableOf< PMStringGetNickname () 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

A data interface used by SetAdobeCoreMetaDataCmd.

Member Function Documentation

virtual UnspecifiableOf< K2Vector<PMString> > ISetAdobeCoreMDCmdData::GetAuthors () const
pure virtual

Returns a list of author names in order of precedence defined by 'xap:Authors' property.

Returns
List of author names.
virtual UnspecifiableOf<metadata::URI> ISetAdobeCoreMDCmdData::GetBaseURL () const
pure virtual

Returns the base URL for relative URLs in the document content defined by 'xap:BaseURL' property.

Returns
the base URL.
virtual UnspecifiableOf<XMP_DateTime> ISetAdobeCoreMDCmdData::GetCreateDate () const
pure virtual

Returns the date and time the document was originally created defined by 'xap:CreateDate' property.

Returns
kTrue if 'xap:CreateDate' property exist. kFalse otherwise.
virtual UnspecifiableOf<metadata::AgentName> ISetAdobeCoreMDCmdData::GetCreatorTool () const
pure virtual

Returns the name of the original tool used to create the resource (at least the first known tool) defined by 'xap:CreatorTool' property.

Returns
The name of the original tool used to create the resource.
virtual UnspecifiableOf<PMString> ISetAdobeCoreMDCmdData::GetDescription () const
pure virtual

Returns a textual description of the content of the resource defined by 'xap:Description' property.

Returns
A textual description of the content of the resource.
virtual UnspecifiableOf< K2Vector<PMString> > ISetAdobeCoreMDCmdData::GetKeywords () const
pure virtual

Returns an unordered list of descriptive phrases or keywords that specify the topic of the content of the resource defined by 'xap:Keywords' property.

Returns
An unordered list of descriptive phrases or keywords.
virtual UnspecifiableOf<XMP_DateTime> ISetAdobeCoreMDCmdData::GetMetadataDate () const
pure virtual

Returns the Date and time that any metadata for this resource was last changed defined by 'xap:MetadataDate' property.

Returns
kTrue if the 'xap:MetadataDate' property exist. kFalse otherwise.
virtual UnspecifiableOf<XMP_DateTime> ISetAdobeCoreMDCmdData::GetModifyDate () const
pure virtual

Returns the date and time the resource was last modified defined by 'xap:ModifyDate' property.

Returns
kTrue if 'xap:ModifyDate' property exist. kFalse otherwise.
virtual UnspecifiableOf<PMString> ISetAdobeCoreMDCmdData::GetNickname () const
pure virtual

Returns the short informal name for the resource, specified by 'xap:Nickname' property.

Returns
The short informal name.
virtual UnspecifiableOf<PMString> ISetAdobeCoreMDCmdData::GetTitle () const
pure virtual

Returns the title of the document, or the name given to the resource specified by 'xap:Title' property.

Returns
The title of the document.
virtual IPMUnknown* ISetAdobeCoreMDCmdData::QueryTargetObject (const PMIIDiid) const
pure virtual

Query an interface on the target object.

Parameters
iidIN The ID of the interface to query.
Returns
IPMUnknown pointer to the interface iid or nil, if interface iid doesn't exist.
virtual void ISetAdobeCoreMDCmdData::Set (IPMUnknowntargetObject,
const UnspecifiableOf< PMString > & title = kUnspecified,
const UnspecifiableOf< K2Vector< PMString > > & authors = kUnspecified,
const UnspecifiableOf< PMString > & description = kUnspecified,
const UnspecifiableOf< K2Vector< PMString > > & keywords = kUnspecified,
const UnspecifiableOf< XMP_DateTime > & metadataDate = kUnspecified,
const UnspecifiableOf< XMP_DateTime > & modifyDate = kUnspecified,
const UnspecifiableOf< XMP_DateTime > & createDate = kUnspecified,
const UnspecifiableOf< metadata::AgentName > & creatorTool = kUnspecified,
const UnspecifiableOf< metadata::URI > & baseURL = kUnspecified,
const UnspecifiableOf< PMString > & nickname = kUnspecified 
)
pure virtual

Set the command data.

Parameters
targetObjectIN The target object of the command. It must have a IID_IADOBECOREMETADATA interface.
titleIN The title of the document.
authorsIN List of author names.
descriptionIN A textual description of the content of the resource.
keywordsIN An unordered list of descriptive phrases or keywords.
metadataDateIN kTrue if the 'xap:MetadataDate' property exist. kFalse otherwise.
modifyDateIN if 'xap:ModifyDate' property exist. kFalse otherwise.
createDateIN if 'xap:CreateDate' property exist. kFalse otherwise.
creatorToolIN The name of the original tool used to create the resource.
baseURLIN The base URL.
nicknameIN The short informal name.
See Also
IID_IADOBECOREMETADATA