ISetMediaAttrCmdData.h

//========================================================================================
// 
// $File$
// 
// Owner: Bill Tislar
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// ADOBE CONFIDENTIAL
// 
// 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 __ISetMediaAttrCmdData__
#define __ISetMediaAttrCmdData__

#include "IPMUnknown.h"
#include "IMediaAttributes.h"
#include "MediaID.h"

#include <map>
#include <vector>

class ISetMediaAttrCmdData : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISETMEDIAATTRCMDDATA };
 // ***** Begin deprecated methods DO NOT USE ******
 virtual bool16 GetCustomPosterFromMedia() const = 0;
 virtual const PMString & GetDescription() const = 0;
 virtual bool16 GetEmbedOnPDFExport() const = 0;
 virtual bool16 GetDoNotPrintPoster() const = 0;
 virtual bool16 GetPlayOnPageTurn() const = 0;
 virtual int32 GetPosterTime() const = 0;
 virtual const PMString & GetTitle() const = 0;
 virtual bool16 GetTitleIsFrozen() const = 0;

 virtual bool16 IsSet_CustomPosterFromMedia() const = 0;
 virtual bool16 IsSet_Description() const = 0;
 virtual bool16 IsSet_EmbedOnPDFExport() const = 0;
 virtual bool16 IsSet_PlayOnPageTurn() const = 0;
 virtual bool16 IsSet_PosterTime() const = 0;
 virtual bool16 IsSet_DoNotPrintPoster() const = 0;
 virtual bool16 IsSet_Title() const = 0;
 virtual bool16 IsSet_TitleIsFrozen() const = 0;

 virtual void SetCustomPosterFromMedia( bool16 b ) = 0;
 virtual void SetDescription( const PMString & desc ) = 0;
 virtual void SetEmbedOnPDFExport( bool16 b ) = 0;
 virtual void SetDoNotPrintPoster( bool16 b ) = 0;
 virtual void SetPlayOnPageTurn( bool16 b ) = 0;
 virtual void SetPosterTime( int32 t ) = 0;
 virtual void SetTitle( const PMString & title ) = 0;
 virtual void SetTitleIsFrozen( bool16 b ) = 0;
 // ***** End deprecated methods ******
 
 
 virtual ErrorCode ApplyAttributes( IMediaAttributes * iMediaAttributes ) = 0;
 
 virtual void Clear() = 0;
 
 virtual ErrorCode CopyAttributes( ISetMediaAttrCmdData * destData ) const = 0;
 
 virtual bool HasChanged() = 0;
 
 // --- Mutators for each supported value type:

 virtual void SetAttribute( uint32 attributeID, int16 value ) = 0;

 virtual void SetAttribute( uint32 attributeID, int32 value ) = 0;

 virtual void SetAttribute( uint32 attributeID, uint32 value ) = 0;
 
 virtual void SetAttribute( uint32 attributeID, ClassID value ) = 0;

 virtual void SetAttribute( uint32 attributeID, const PMPoint & value ) = 0;

 virtual void SetAttribute( uint32 attributeID, const PMReal & value ) = 0;

 virtual void SetAttribute( uint32 attributeID, const PMRect & value ) = 0;

 virtual void SetAttribute( uint32 attributeID, const PMString & value ) = 0;

 virtual void SetAttribute( uint32 attributeID, const NamedUint32AttributeList & value ) = 0;
 
 virtual void SetFlag( uint32 attributeID, bool16 b ) = 0;

 virtual void ClearFlag( uint32 attributeID ) = 0;
 
 virtual void ClearInt16( uint32 attributeID ) = 0;
 
 virtual void ClearPMPoint( uint32 attributeID ) = 0;
 
}; // end ISetMediaAttrCmdData interface class


#endif