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

#include <IAdobeCoreMetaData.h>

Inheritance diagram for IAdobeCoreMetaData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IADOBECOREMETADATA }
 

Public Member Functions

virtual void SetAuthors (const K2Vector< PMString > &authors)=0
 
virtual K2Vector< PMStringGetAuthors () const =0
 
virtual void SetBaseURL (const metadata::URI &baseURL)=0
 
virtual metadata::URI GetBaseURL () const =0
 
virtual void SetCreateDate (const XMP_DateTime &date)=0
 
virtual bool32 GetCreateDate (XMP_DateTime &dt) const =0
 
virtual void SetCreatorTool (const metadata::AgentName &tool)=0
 
virtual metadata::AgentName GetCreatorTool () const =0
 
virtual void SetDescription (const PMString &description)=0
 
virtual PMString GetDescription () const =0
 
virtual void SetFormat (const metadata::MIMEType &format)=0
 
virtual metadata::MIMEType GetFormat () const =0
 
virtual K2Vector< PMStringGetKeywords () const =0
 
virtual void SetKeywords (const K2Vector< PMString > &keywords)=0
 
virtual void SetMetadataDate (const XMP_DateTime &date)=0
 
virtual bool32 GetMetadataDate (XMP_DateTime &dt) const =0
 
virtual void SetModifyDate (const XMP_DateTime &date)=0
 
virtual bool32 GetModifyDate (XMP_DateTime &dt) const =0
 
virtual void SetNickname (const PMString &description)=0
 
virtual PMString GetNickname () const =0
 
virtual void SetTitle (const PMString &title)=0
 
virtual PMString GetTitle () 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

This interface encapsulates routines of the XMPToolkit for accessing XMP Core Properties defined in 'xap' namespace.

See Also
IAdobeBasicJobMetaData
IAdobeMediaMgmtMetaData
IAdobeRightsMgmtMetaData
IMetaDataAccess
MetaDataTypes.h

Member Function Documentation

virtual K2Vector<PMString> IAdobeCoreMetaData::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 metadata::URI IAdobeCoreMetaData::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 bool32 IAdobeCoreMetaData::GetCreateDate (XMP_DateTime & dt) const
pure virtual

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

Parameters
dtOUT Date and time the document was originally created.
Returns
kTrue if 'xap:CreateDate' property exist. kFalse otherwise.
virtual metadata::AgentName IAdobeCoreMetaData::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 PMString IAdobeCoreMetaData::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 metadata::MIMEType IAdobeCoreMetaData::GetFormat () const
pure virtual

Returns the resource format (e.g. video, audio, etc.) defined by 'xap:Format' property.

Returns
The resource format.
virtual K2Vector<PMString> IAdobeCoreMetaData::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 bool32 IAdobeCoreMetaData::GetMetadataDate (XMP_DateTime & dt) const
pure virtual

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

Parameters
dtOUT The Date and time that any metadata for this resource was last changed.
Returns
kTrue if the 'xap:MetadataDate' property exist. kFalse otherwise.
virtual bool32 IAdobeCoreMetaData::GetModifyDate (XMP_DateTime & dt) const
pure virtual

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

Parameters
dtOUT The date and time the resource was last modified.
Returns
kTrue if 'xap:ModifyDate' property exist. kFalse otherwise.
virtual PMString IAdobeCoreMetaData::GetNickname () const
pure virtual

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

Returns
The short informal name.
virtual PMString IAdobeCoreMetaData::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 void IAdobeCoreMetaData::SetAuthors (const K2Vector< PMString > & authors)
pure virtual

Sets the 'xap:Authors' property with a list of author names in order of precedence.

Parameters
authorsIN List of author names which is to be set.
virtual void IAdobeCoreMetaData::SetBaseURL (const metadata::URIbaseURL)
pure virtual

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

Parameters
baseURLIN Base URL to be set.
virtual void IAdobeCoreMetaData::SetCreateDate (const XMP_DateTime & date)
pure virtual

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

Parameters
dateIN creation date to set.
virtual void IAdobeCoreMetaData::SetCreatorTool (const metadata::AgentNametool)
pure virtual

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

Parameters
toolIN The name of the original tool used to create the resource.
virtual void IAdobeCoreMetaData::SetDescription (const PMStringdescription)
pure virtual

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

Parameters
descriptionIN A textual description of the content of the resource.
virtual void IAdobeCoreMetaData::SetFormat (const metadata::MIMETypeformat)
pure virtual

Sets the resource format (e.g. video, audio, etc.) defined by 'xap:Format' property.

Parameters
formatIN The resource format to set.
virtual void IAdobeCoreMetaData::SetKeywords (const K2Vector< PMString > & keywords)
pure virtual

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

Parameters
keywordsIN An unordered list of descriptive phrases or keywords.
virtual void IAdobeCoreMetaData::SetMetadataDate (const XMP_DateTime & date)
pure virtual

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

Parameters
dateIN The Date and time that any metadata for this resource was last changed.
virtual void IAdobeCoreMetaData::SetModifyDate (const XMP_DateTime & date)
pure virtual

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

Parameters
dateIN The date and time the resource was last modified.
virtual void IAdobeCoreMetaData::SetNickname (const PMStringdescription)
pure virtual

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

Parameters
descriptionIN The short informal name.
virtual void IAdobeCoreMetaData::SetTitle (const PMStringtitle)
pure virtual

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

Parameters
titleIN The title of the document.