IPageTransitionFacade.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.
// 
// 
// ADOBE CONFIDENTIAL
// 
//========================================================================================

#ifndef __IPageTransitionFacade__
#define __IPageTransitionFacade__

#include "DynamicDocumentsID.h"

class IPageTransition;
class IDocument;

namespace Facade
{
 class IPageTransitionFacade : public IPMUnknown
 {
 public:
 enum { kDefaultIID = IID_IPAGETRANSITIONFACADE };

 // ***********************
 // Spread based page transition helper routines
 // ***********************

 virtual bool SpreadHasPageTransition(UIDRef const &spreadRef) const = 0;

 virtual bool SpreadsHavePageTransition(UIDList const &spreadList) const = 0;

 virtual ErrorCode GetSpreadPageTransitionDetails(UIDRef const &spreadRef, ClassID* classID = nil, uint32* direction = nil, uint32* duration = nil) const = 0;

 virtual ErrorCode SetSpreadPageTransitionDetails(UIDList const &uidList, ClassID const &classID, uint32 direction, uint32 duration) const = 0;

 virtual bool AllSpreadsHaveSamePageTransition(UIDList const &spreadList, ClassID& resultTransitionClass) const = 0;

 virtual ErrorCode ApplyPageTransitionToAllSpreads(UIDList const &spreads, const ClassID &transitionClass, uint32 const &direction, uint32 const &speed) const = 0;

 // ***********************
 // Page Transition List Routines
 // ***********************

 virtual uint32 GetPageTransitionCount() const = 0;

 virtual ClassID GetNthPageTransitionClassID(int32 index) const = 0;

 virtual PMString GetNthPageTransitionName(int32 index, bool translateName = false) const = 0;

 virtual IPageTransition *QueryNthPageTransition(int32 index) const = 0;

 virtual IPageTransition *QueryPageTransition(ClassID const &classID) const = 0;

 virtual int32 FindPageTransitionIndex(ClassID const &classID) const = 0;

 virtual int32 FindPageTransitionIndex(PMString const &name, bool useTranslatedNames = false) const = 0;

 virtual ClassID GetPageTransitionClassID(PMString const &name, bool useTranslatedNames = false) const = 0;

 virtual PMString GetPageTransitionName(ClassID const &classID, bool translateName = false) const = 0;

 virtual bool ValidPageTransitionDirection(ClassID const &classID, const uint32 direction) const = 0;

 };
}


#endif // __IPageTransitionFacade__