 |
XMP Toolkit SDK
6.0.0
|
Go to the documentation of this file. 1 #ifndef __WXMPFiles_hpp__
2 #define __WXMPFiles_hpp__ 1
17 #if XMP_StaticBuild // ! Client XMP_IO objects can only be used in static builds.
35 #define WrapCheckXMPFilesRef(result,WCallProto) \
36 WXMP_Result wResult; \
38 PropagateException ( wResult ); \
39 XMPFilesRef result = XMPFilesRef(wResult.ptrResult)
42 float elapsedTime,
float fractionDone,
float secondsToGo )
46 ok = (*proc) ( context, elapsedTime, fractionDone, secondsToGo );
60 ok = (*proc) ( context, filePath, severity, cause, message );
69 #define zXMPFiles_GetVersionInfo_1(versionInfo) \
70 WXMPFiles_GetVersionInfo_1 ( versionInfo )
72 #define zXMPFiles_Initialize_1(options) \
73 WXMPFiles_Initialize_1 ( options, &wResult )
75 #define zXMPFiles_Initialize_2(options,pluginFolder,plugins) \
76 WXMPFiles_Initialize_2 ( options, pluginFolder, plugins, &wResult )
78 #define zXMPFiles_Terminate_1() \
79 WXMPFiles_Terminate_1 ( )
81 #define zXMPFiles_CTor_1() \
82 WXMPFiles_CTor_1 ( &wResult )
84 #define zXMPFiles_GetFormatInfo_1(format,flags) \
85 WXMPFiles_GetFormatInfo_1 ( format, flags, &wResult )
87 #define zXMPFiles_CheckFileFormat_1(filePath) \
88 WXMPFiles_CheckFileFormat_1 ( filePath, &wResult )
90 #define zXMPFiles_CheckPackageFormat_1(folderPath) \
91 WXMPFiles_CheckPackageFormat_1 ( folderPath, &wResult )
93 #define zXMPFiles_GetFileModDate_1(filePath,modDate,format,options) \
94 WXMPFiles_GetFileModDate_1 ( filePath, modDate, format, options, &wResult )
96 #define zXMPFiles_GetAssociatedResources_1( filePath, resourceList, format, options, SetClientStringVector ) \
97 WXMPFiles_GetAssociatedResources_1 ( filePath, resourceList, format, options, SetClientStringVector, &wResult )
99 #define zXMPFiles_IsMetadataWritable_1( filePath, writable, format, options ) \
100 WXMPFiles_IsMetadataWritable_1 ( filePath, writable, format, options, &wResult )
102 #define zXMPFiles_OpenFile_1(filePath,format,openFlags) \
103 WXMPFiles_OpenFile_1 ( this->xmpFilesRef, filePath, format, openFlags, &wResult )
105 #if XMP_StaticBuild // ! Client XMP_IO objects can only be used in static builds.
106 #define zXMPFiles_OpenFile_2(clientIO,format,openFlags) \
107 WXMPFiles_OpenFile_2 ( this->xmpFilesRef, clientIO, format, openFlags, &wResult )
110 #define zXMPFiles_CloseFile_1(closeFlags) \
111 WXMPFiles_CloseFile_1 ( this->xmpFilesRef, closeFlags, &wResult )
113 #define zXMPFiles_GetFileInfo_1(clientPath,openFlags,format,handlerFlags,SetClientString) \
114 WXMPFiles_GetFileInfo_1 ( this->xmpFilesRef, clientPath, openFlags, format, handlerFlags, SetClientString, &wResult )
116 #define zXMPFiles_SetAbortProc_1(abortProc,abortArg) \
117 WXMPFiles_SetAbortProc_1 ( this->xmpFilesRef, abortProc, abortArg, &wResult )
119 #define zXMPFiles_GetXMP_1(xmpRef,clientPacket,packetInfo,SetClientString) \
120 WXMPFiles_GetXMP_1 ( this->xmpFilesRef, xmpRef, clientPacket, packetInfo, SetClientString, &wResult )
122 #define zXMPFiles_PutXMP_1(xmpRef,xmpPacket,xmpPacketLen) \
123 WXMPFiles_PutXMP_1 ( this->xmpFilesRef, xmpRef, xmpPacket, xmpPacketLen, &wResult )
125 #define zXMPFiles_CanPutXMP_1(xmpRef,xmpPacket,xmpPacketLen) \
126 WXMPFiles_CanPutXMP_1 ( this->xmpFilesRef, xmpRef, xmpPacket, xmpPacketLen, &wResult )
128 #define zXMPFiles_SetDefaultProgressCallback_1(proc,context,interval,sendStartStop) \
129 WXMPFiles_SetDefaultProgressCallback_1 ( WrapProgressReport, proc, context, interval, sendStartStop, &wResult )
131 #define zXMPFiles_SetProgressCallback_1(proc,context,interval,sendStartStop) \
132 WXMPFiles_SetProgressCallback_1 ( this->xmpFilesRef, WrapProgressReport, proc, context, interval, sendStartStop, &wResult )
134 #define zXMPFiles_SetDefaultErrorCallback_1(proc,context,limit) \
135 WXMPFiles_SetDefaultErrorCallback_1 ( WrapFilesErrorNotify, proc, context, limit, &wResult )
137 #define zXMPFiles_SetErrorCallback_1(proc,context,limit) \
138 WXMPFiles_SetErrorCallback_1 ( this->xmpFilesRef, WrapFilesErrorNotify, proc, context, limit, &wResult )
140 #define zXMPFiles_ResetErrorCallbackLimit_1(limit) \
141 WXMPFiles_ResetErrorCallbackLimit_1 ( this->xmpFilesRef, limit, &wResult )
151 const char* pluginFolder,
199 #if XMP_StaticBuild // ! Client XMP_IO objects can only be used in static builds.
200 extern void WXMPFiles_OpenFile_2 (
XMPFilesRef xmpFilesRef,
283 #endif // __WXMPFiles_hpp__
void WXMPFiles_GetFormatInfo_1(XMP_FileFormat format, XMP_OptionBits *flags, WXMP_Result *result)
void WXMPFiles_CloseFile_1(XMPFilesRef xmpFilesRef, XMP_OptionBits closeFlags, WXMP_Result *result)
void(* SetClientStringProc)(void *clientPtr, XMP_StringPtr valuePtr, XMP_StringLen valueLen)
void WXMPFiles_OpenFile_1(XMPFilesRef xmpFilesRef, XMP_StringPtr filePath, XMP_FileFormat format, XMP_OptionBits openFlags, WXMP_Result *result)
XMP Toolkit version information.
bool(* XMPFiles_ErrorCallbackProc)(void *context, XMP_StringPtr filePath, XMP_ErrorSeverity severity, XMP_Int32 cause, XMP_StringPtr message)
The signature of a client-defined callback for TXMPFiles error notifications.
void WXMPFiles_GetAssociatedResources_1(XMP_StringPtr filePath, void *resourceList, XMP_FileFormat format, XMP_OptionBits options, SetClientStringVectorProc SetClientStringVector, WXMP_Result *result)
void WXMPFiles_SetDefaultErrorCallback_1(XMPFiles_ErrorCallbackWrapper wrapperProc, XMPFiles_ErrorCallbackProc clientProc, void *context, XMP_Uns32 limit, WXMP_Result *wResult)
bool(* XMP_AbortProc)(void *arg)
The signature of a client-defined callback to check for a user request to abort a time-consuming oper...
#define ConvertBoolToXMP_Bool(a)
void WXMPFiles_SetProgressCallback_1(XMPFilesRef xmpFilesRef, XMP_ProgressReportWrapper wrapperproc, XMP_ProgressReportProc clientProc, void *context, float interval, XMP_Bool sendStartStop, WXMP_Result *result)
void WXMPFiles_ResetErrorCallbackLimit_1(XMPFilesRef xmpRef, XMP_Uns32 limit, WXMP_Result *wResult)
struct __XMPFiles__ * XMPFilesRef
An "ABI safe" pointer to the internal part of an XMP file-handling object. Use to pass an XMP file-ha...
void WXMPFiles_GetFileModDate_1(XMP_StringPtr filePath, XMP_DateTime *modDate, XMP_FileFormat *format, XMP_OptionBits options, WXMP_Result *result)
static XMP_Bool WrapFilesErrorNotify(XMPFiles_ErrorCallbackProc proc, void *context, XMP_StringPtr filePath, XMP_ErrorSeverity severity, XMP_Int32 cause, XMP_StringPtr message)
void WXMPFiles_CTor_1(WXMP_Result *result)
void WXMPFiles_SetAbortProc_1(XMPFilesRef xmpFilesRef, XMP_AbortProc abortProc, void *abortArg, WXMP_Result *result)
void WXMPFiles_CanPutXMP_1(XMPFilesRef xmpFilesRef, XMPMetaRef xmpRef, XMP_StringPtr xmpPacket, XMP_StringLen xmpPacketLen, WXMP_Result *result)
void WXMPFiles_IncrementRefCount_1(XMPFilesRef xmpFilesRef)
XMP_Bool(* XMPFiles_ErrorCallbackWrapper)(XMPFiles_ErrorCallbackProc clientProc, void *context, XMP_StringPtr filePath, XMP_ErrorSeverity severity, XMP_Int32 cause, XMP_StringPtr message)
static XMP_Bool WrapProgressReport(XMP_ProgressReportProc proc, void *context, float elapsedTime, float fractionDone, float secondsToGo)
void WXMPFiles_CheckFileFormat_1(XMP_StringPtr filePath, WXMP_Result *result)
Abstract base class for client-managed I/O with TXMPFiles.
void WXMPFiles_GetFileInfo_1(XMPFilesRef xmpFilesRef, void *clientPath, XMP_OptionBits *openFlags, XMP_FileFormat *format, XMP_OptionBits *handlerFlags, SetClientStringProc SetClientString, WXMP_Result *result)
void(* SetClientStringVectorProc)(void *clientPtr, XMP_StringPtr *arrayPtr, XMP_Uns32 stringCount)
void WXMPFiles_SetDefaultProgressCallback_1(XMP_ProgressReportWrapper wrapperproc, XMP_ProgressReportProc clientProc, void *context, float interval, XMP_Bool sendStartStop, WXMP_Result *result)
const typedef char * XMP_StringPtr
The type for input string parameters. A const char *, a null-terminated UTF-8 string.
void WXMPFiles_DecrementRefCount_1(XMPFilesRef xmpFilesRef)
void WXMPFiles_Initialize_1(XMP_OptionBits options, WXMP_Result *result)
struct __XMPMeta__ * XMPMetaRef
An "ABI safe" pointer to the internal part of an XMP object. Use to pass an XMP object across client ...
bool(* XMP_ProgressReportProc)(void *context, float elapsedTime, float fractionDone, float secondsToGo)
The signature of a client-defined callback for progress report notifications.
XMP_Uns32 XMP_StringLen
The type for string length parameters. A 32-bit unsigned integer, as big as will be practically neede...
XMP_Uns8 XMP_ErrorSeverity
void WXMPFiles_GetXMP_1(XMPFilesRef xmpFilesRef, XMPMetaRef xmpRef, void *clientPacket, XMP_PacketInfo *packetInfo, SetClientStringProc SetClientString, WXMP_Result *result)
void WXMPFiles_PutXMP_1(XMPFilesRef xmpFilesRef, XMPMetaRef xmpRef, XMP_StringPtr xmpPacket, XMP_StringLen xmpPacketLen, WXMP_Result *result)
void WXMPFiles_Terminate_1()
void WXMPFiles_CheckPackageFormat_1(XMP_StringPtr folderPath, WXMP_Result *result)
XMP_Bool(* XMP_ProgressReportWrapper)(XMP_ProgressReportProc proc, void *context, float elapsedTime, float fractionDone, float secondsToGo)
Internal: The signature of a client-side wrapper for the progress report callback.
void WXMPFiles_SetErrorCallback_1(XMPFilesRef xmpRef, XMPFiles_ErrorCallbackWrapper wrapperProc, XMPFiles_ErrorCallbackProc clientProc, void *context, XMP_Uns32 limit, WXMP_Result *wResult)
void WXMPFiles_IsMetadataWritable_1(XMP_StringPtr filePath, XMP_Bool *writable, XMP_FileFormat format, XMP_OptionBits options, WXMP_Result *result)
void WXMPFiles_Initialize_2(XMP_OptionBits options, const char *pluginFolder, const char *plugins, WXMP_Result *result)
XMP_Uns32 XMP_OptionBits
The type for a collection of 32 flag bits.
The expanded type for a date and time.
void WXMPFiles_GetVersionInfo_1(XMP_VersionInfo *versionInfo)
XMP_Uns32 XMP_FileFormat
Type for file format identification constants. See kXMP_PDFFile and following.