TXMPFiles.hpp

Go to the documentation of this file.

#ifndef __TXMPFiles_hpp__
#define __TXMPFiles_hpp__   1

#if ( ! __XMP_hpp__ )
    #error "Do not directly include, use XMP.hpp"
#endif

// =================================================================================================
// ADOBE SYSTEMS INCORPORATED
// Copyright 2002-2007 Adobe Systems Incorporated
// All Rights Reserved
//
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance with the terms
// of the Adobe license agreement accompanying it.
// =================================================================================================

//  ================================================================================================
//  ================================================================================================

//  ================================================================================================
//  ================================================================================================

template <class tStringObj>
class TXMPFiles {

public:
    
    //  ============================================================================================

    static void GetVersionInfo ( XMP_VersionInfo * versionInfo );

    
    static bool Initialize();
    static bool Initialize ( XMP_OptionBits options );


    static void Terminate();


    //  ============================================================================================
    
    
    TXMPFiles();
    virtual ~TXMPFiles() throw();

    
    TXMPFiles ( XMP_StringPtr  filePath,
                XMP_FileFormat format = kXMP_UnknownFile,
                XMP_OptionBits openFlags = 0 );

    TXMPFiles ( const tStringObj & filePath,
                XMP_FileFormat     format = kXMP_UnknownFile,
                XMP_OptionBits     openFlags = 0 );

    
    TXMPFiles ( const TXMPFiles<tStringObj> & original );

    void operator= ( const TXMPFiles<tStringObj> & rhs );

    
    TXMPFiles ( XMPFilesRef xmpFilesObj );
    
    XMPFilesRef GetInternalRef();

    
    //  ============================================================================================
    
    //  --------------------------------------------------------------------------------------------
    
    static bool GetFormatInfo ( XMP_FileFormat   format,
                                XMP_OptionBits * handlerFlags = 0 );

    
    //  ============================================================================================
    
    //  --------------------------------------------------------------------------------------------

    bool OpenFile ( XMP_StringPtr  filePath,
                    XMP_FileFormat format = kXMP_UnknownFile,
                    XMP_OptionBits openFlags = 0 );
    
    bool OpenFile ( const tStringObj & filePath,
                    XMP_FileFormat     format = kXMP_UnknownFile,
                    XMP_OptionBits     openFlags = 0 );

    //  --------------------------------------------------------------------------------------------
    
    void CloseFile ( XMP_OptionBits closeFlags = 0 );
    
    //  --------------------------------------------------------------------------------------------
    
    bool GetFileInfo ( tStringObj *     filePath = 0,
                       XMP_OptionBits * openFlags = 0,
                       XMP_FileFormat * format = 0,
                       XMP_OptionBits * handlerFlags = 0 );
    
    //  --------------------------------------------------------------------------------------------

    void SetAbortProc ( XMP_AbortProc abortProc,
                        void *        abortArg );

    
    //  ============================================================================================
    
    //  --------------------------------------------------------------------------------------------
    
    bool GetXMP ( SXMPMeta *       xmpObj = 0,
                  tStringObj *     xmpPacket = 0,
                  XMP_PacketInfo * packetInfo = 0 );
    
    //  --------------------------------------------------------------------------------------------
    
    bool GetThumbnail ( XMP_ThumbnailInfo * tnailInfo );
    
    //  --------------------------------------------------------------------------------------------
    
    void PutXMP ( const SXMPMeta & xmpObj );

    void PutXMP ( const tStringObj & xmpPacket );
    
    void PutXMP ( XMP_StringPtr xmpPacket,
                  XMP_StringLen xmpLength = kXMP_UseNullTermination );
    
    //  --------------------------------------------------------------------------------------------
    
    bool CanPutXMP ( const SXMPMeta & xmpObj );

    bool CanPutXMP ( const tStringObj & xmpPacket );
    
    bool CanPutXMP ( XMP_StringPtr xmpPacket,
                     XMP_StringLen xmpLength = kXMP_UseNullTermination );


    // =============================================================================================

private:
    XMPFilesRef xmpFilesRef;

};  // class TXMPFiles

// =================================================================================================

#endif // __TXMPFiles_hpp__

---