IFrame.h

Go to the documentation of this file.

/******************************************************************************
* ADOBE CONFIDENTIAL
* ___________________
*
*  Copyright [2013] Adobe Systems Incorporated
*  All Rights Reserved.
*
* NOTICE:  All information contained herein is, and remains
* the property of Adobe Systems Incorporated and its suppliers,
* if any.  The intellectual and technical concepts contained
* herein are proprietary to Adobe Systems Incorporated and its
* suppliers and are protected by all applicable intellectual 
* property laws, including trade secret and copyright laws.
* Dissemination of this information or reproduction of this material
* is strictly forbidden unless prior written permission is obtained
* from Adobe Systems Incorporated.
******************************************************************************/

#ifndef IFRAME_H_
#define IFRAME_H_

#include "FCMPreConfig.h"
#include "FCMPluginInterface.h"


/* -------------------------------------------------- Forward Decl */

namespace FCM
{
    FORWARD_DECLARE_INTERFACE(IFCMList);
};

namespace DOM
{
    FORWARD_DECLARE_INTERFACE(ITween);
}


/* -------------------------------------------------- Enums */

namespace DOM
{
    enum KeyFrameLabelType
    {
        KEY_FRAME_LABEL_NONE,

        KEY_FRAME_LABEL_NAME,

        KEY_FRAME_LABEL_COMMENT,

        KEY_FRAME_LABEL_ANCHOR
    };
}


/* -------------------------------------------------- Macros / Constants */

namespace DOM
{
    FCM::ConstFCMIID IID_IFRAME =
        {0x386cb02e, 0x74d0, 0x4114, {0x9e, 0x10, 0xcb, 0xe8, 0xe8, 0xd1, 0x64, 0xa7}};
}


/* -------------------------------------------------- Class Decl */

namespace DOM 
{

    BEGIN_DECLARE_INTERFACE(IFrame, IID_IFRAME)

        
        virtual FCM::Result _FCMCALL GetDuration(FCM::U_Int32& duration) = 0;

    
        virtual FCM::Result _FCMCALL GetFrameElements(PIFCMList& pFrameElementsList) = 0;


        virtual FCM::Result _FCMCALL GetFrameElementsByType(
            ConstFCMIID& iid, 
            PIFCMList& pFrameElementsList) = 0; 


        virtual FCM::Result _FCMCALL GetStartFrameIndex(FCM::U_Int32& frameIndex) = 0;


        virtual FCM::Result _FCMCALL GetLabel(FCM::StringRep16* ppLabel) = 0;


        virtual FCM::Result _FCMCALL GetLabelType(KeyFrameLabelType& labelType) = 0;
        

        virtual FCM::Result _FCMCALL GetScript(FCM::StringRep16* ppScript) = 0;
    
    
        virtual FCM::Result _FCMCALL GetTween(PITween& pTween) = 0;

    END_DECLARE_INTERFACE 
};


/* -------------------------------------------------- Inline / Functions */


#include "FCMPostConfig.h"

#endif // IFRAME_H_