IScriptLabel.h

//========================================================================================
// 
// $File$
// 
// Owner: Jonathan W. Brown
// 
// $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 __IScriptLabel__
#define __IScriptLabel__

#include "IPMUnknown.h"
#include "KeyValuePair.h"
#include "ScriptingID.h"

class IScriptLabel : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISCRIPTLABEL };

 typedef PMString ScriptLabelKey ;
 typedef PMString ScriptLabelValue ;
 typedef KeyValuePair<ScriptLabelKey, ScriptLabelValue> ScriptLabelKeyValuePair ;
 typedef K2Vector<ScriptLabelKeyValuePair> ScriptLabelKeyValueList ;

 static ScriptLabelKey kDefaultScriptLabelKey ;

 virtual void SetTag( const ScriptLabelValue& string ) = 0 ;
 virtual ScriptLabelValue GetTag() const = 0 ;

 virtual void SetTag( const ScriptLabelKey& key, const ScriptLabelValue& value ) = 0 ;
 virtual ScriptLabelValue GetTag( const ScriptLabelKey& key ) const = 0 ;

 virtual void SetTags( const ScriptLabelKeyValueList& labels ) = 0 ;
 virtual ScriptLabelKeyValueList GetTags() const = 0 ;

 virtual void ClearTags() = 0 ;
};

#endif // __IScriptLabel__