Mako 8.2.0 API
MakoCore SDK API Documentation
Loading...
Searching...
No Matches
idommetadata.h
Go to the documentation of this file.
1/*
2* Copyright (C) 2007-2025 Global Graphics Software Ltd. All rights reserved.
3*/
4
5#ifndef __IDOMMETADATA_H__
6#define __IDOMMETADATA_H__
7
8#include <edl/edltypes.h>
9#include <edl/edlstring.h>
10#include <edl/iedlenum.h>
11#include <edl/edlproperty.h>
12
14
93
94class IDOMMetadata;
96
98{
99#define IDOMMetadataClassID 0x4bc2067b, 0x6b5644dc, 0xa6dd49d9, 0xc2c77c5b
100public:
101
103
118
131
137 static EDL_API IDOMMetadataPtr create(IEDLClassFactory *pFactory);
138
146 virtual bool getProperty(eType propertyType, const EDLSysString &propertyName, PValue &propertyValue) const = 0;
147
155 virtual bool setProperty(eType propertyType, const EDLSysString &propertyName, const PValue &propertyValue) = 0;
156
163 virtual bool removeProperty(eType propertyType, const EDLSysString &propertyName) = 0;
164
170 virtual IEDLSysStringCollectionEnumPtr getPropertyCollectionEnum(eType propertyType) = 0;
171
172};
173
174#define edlobj2IDOMMetadata(src) edl_cast((IDOMMetadata *)NULL, src)
175
176
178
179#endif // __IDOMMETADATA_H__
The IDOMMetadata interface provides access to the metadata attached to the DocumentSequence node....
Definition idommetadata.h:98
virtual bool removeProperty(eType propertyType, const EDLSysString &propertyName)=0
Removes a property, if it exists.
virtual bool getProperty(eType propertyType, const EDLSysString &propertyName, PValue &propertyValue) const =0
Retrieves the value of a named property.
virtual IEDLSysStringCollectionEnumPtr getPropertyCollectionEnum(eType propertyType)=0
Retrieves a navigable list of the property names in the metadata.
virtual bool setProperty(eType propertyType, const EDLSysString &propertyName, const PValue &propertyValue)=0
Sets value of a property.
DECLARE_CLASS_ID(IDOMMetadataClassID)
static EDL_API IDOMMetadataPtr create(IEDLClassFactory *pFactory)
Create a new IDOMMetadata object.
@ eDocumentInfo
Document information metadata (PDF document information dictionary)
Definition idommetadata.h:112
@ ePageView
PageLayout and PageMode entries of PDF catalog dictionary.
Definition idommetadata.h:114
@ eMetadataTypeCnt
The number of types defined by eType.
Definition idommetadata.h:116
@ eViewerPreferences
Viewer Preferences entry of PDF catalog dictionary.
Definition idommetadata.h:113
@ ePDFInfo
Version and Linearization entries defined for PDF document.
Definition idommetadata.h:115
@ eCoreProperties
Core properties metadata (XPS core properties)
Definition idommetadata.h:111
@ eXmpContainer_None
The PValue variant that indicates it is not an Xmp container.
Definition idommetadata.h:126
@ eXmpContainer_Alt
The PValue variant for storing a CEDLStringVect representing an Xmp Alt container.
Definition idommetadata.h:127
@ eXmpContainer_Seq
The PValue variant for storing a CEDLStringVect representing an Xmp Seq container.
Definition idommetadata.h:129
@ eXmpContainer_Bag
The PValue variant for storing a CEDLStringVect representing an Xmp Bag container.
Definition idommetadata.h:128
EDL Factory Interface allows one part of the EDL infrastructure to register class creation methods id...
Definition iedlfactory.h:31
IEDLObject is an abstract base class that is used by all classes that are intended to be created via ...
Definition iedlobject.h:53
Stores a "property" value that is tagged with an enumeration value that indicates the underlying type...
Definition edlproperty.h:31
#define _END_EDL_DOM_NAMESPACE
Definition edlnamespaces.h:110
#define _BEGIN_EDL_DOM_NAMESPACE
Definition edlnamespaces.h:109
EDL uses the concept of a "property" that can store a value that has one of a number of different typ...
EDLString and EDLSysString classes and associated EDL string manipulation functions.
std::string EDLSysString
Definition edlstring.h:158
EDL "standard" types including known bit-length signed and unsigned integer type[def]s and definition...
#define EDL_API
Definition edltypes.h:86
eType
Metadata types data type.
Definition idommetadata.h:110
eXmpContainerType
The variant values passed to PValue when storing a CEDLStringVect.
Definition idommetadata.h:125
#define IDOMMetadataClassID
Definition idommetadata.h:99
EDL iterator template classes designed to allow iteration over the contents of a collection....
#define DECL_SMART_PTR(cls)
Definition smartptr.h:211