IPageTransition.h

//========================================================================================
// 
// $File$
// 
// Owner: DBerggren
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 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. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IPageTransition_h__
#define __IPageTransition_h__

#include "IPMUnknown.h"
#include "DynamicDocumentsID.h"

class IPageTransition : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPAGETRANSITION };

 enum PageTransitionDirection
 {
 kNA = 0, // Not Applicable

 kDown, // Top to Bottom
 kLeft, // Left to Right
 kLeftDown, // Top Right to Bottom Left
 kLeftUp, // Bottom Right to Top Left
 kRight, // Right to Left
 kRightDown, // Top Left to Bottom Right
 kRightUp, // Bottom Left to Top Right
 kUp, // Bottom to Top

 kIn, // Inward
 kOut, // Outward

 kHorizontal, // Horizontal
 kVertical, // Vertical

 kHorizontalIn, // Horizontal Inward
 kHorizontalOut, // Horizontal Outward
 kVerticalIn, // Vertical Inward
 kVerticalOut, // Vertical Outward
 };

 static const uint32 kPageTransitionsSlowSpeedTime = 60; // 1 second * 60 = 60 ticks
 static const uint32 kPageTransitionsMediumSpeedTime = 40; // 0.6666 second * 60 = 40 ticks
 static const uint32 kPageTransitionsFastSpeedTime = 20; // 0.3333 second * 60 = 20 ticks
 static const uint32 kDefaultDurationTime = kPageTransitionsMediumSpeedTime; // Use the medium speed time

 virtual PMString GetName(bool bTranslateName = false) const = 0;

 virtual uint32 GetDefaultDuration() const = 0;

 virtual uint32 GetDefaultDirection() const = 0;

 virtual uint32 GetNumberOfDirections() const = 0;

 virtual uint32 GetNthDirection(uint32 index) const = 0;

 virtual IDFile GetSWFStaticRepresentation() const = 0;

 virtual void GetSWFDynamicRepresentation(uint32 const &direction, uint32 const &duration, IDFile &localFile) const = 0;

};

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


#endif // __IPageTransition_h__

// IPageTransition.h.