PrefsScriptProvider.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 _H_PrefsScriptProvider
#define _H_PrefsScriptProvider

#include "CScriptProvider.h"
#include "KeyValuePair.h"

class SingletonScriptProvider : public RepresentScriptProvider
{
protected:
 typedef RepresentScriptProvider Inherited ;

 SingletonScriptProvider( IPMUnknown* boss ) ;
 virtual ~SingletonScriptProvider() {}

 virtual void GetObject( IScriptRequestData* data, IScript* parent ) ;

 virtual int32 GetNumObjects( const IScriptRequestData* data, IScript* parent ) ;

 virtual ErrorCode AppendNthObject( const IScriptRequestData* data, IScript* parent, int32 n, ScriptList& objectList ) ; //0-based index

 virtual ErrorCode AccessProperty( ScriptID propID, IScriptRequestData* data, IScript* script ) ;

 void DefineSingleton( const ScriptID& objectID, const ScriptID& propID, const ClassID& bossID ) ;

 virtual ErrorCode AccessSingleton( ScriptID propID, IScriptRequestData* data, IScript* parent ) ;
 virtual bool16 CanAccessSingleton( ScriptID propID, IScript* parent ) const ;

 virtual IScript* QuerySingleton( const IScriptRequestData* data, IScript* parent, const ScriptID& propID ) ;

private:
 struct SingletonData
 {
 ScriptID fObjectID ;
 ClassID fBossID ;

 SingletonData( ScriptID objectID, ClassID bossID ) : 
 fObjectID( objectID ), fBossID( bossID ) {}
 bool16 operator==( const SingletonData& other ) const
 { return ( fObjectID == other.fObjectID && fBossID == other.fBossID ) ; }
 } ;
 typedef K2Vector< KeyValuePair<ScriptID, SingletonData> > SingletonIDs ;

 SingletonIDs fSingletonIDs ;
};

DECLARE_BASE_TYPE( SingletonScriptProvider::SingletonData ) ;

class PrefsScriptProvider : public SingletonScriptProvider
{
public:
 typedef SingletonScriptProvider Inherited ;

 PrefsScriptProvider( IPMUnknown* boss ) : Inherited( boss ) {}
 virtual ~PrefsScriptProvider() {}

protected:
 virtual int32 GetNumObjects( const IScriptRequestData* data, IScript* parent ) ;

 virtual ErrorCode AppendNthObject( const IScriptRequestData* data, IScript* parent, int32 n, ScriptList& objectList ) ; //0-based index

 virtual ErrorCode AppendAllObjects( const IScriptRequestData* data, IScript* parent, ScriptList& objectList ) ;

 virtual ErrorCode AccessProperty( ScriptID propID, IScriptRequestData* data, IScript* script ) ;

 void DefinePreference( const ScriptID& objectID, const ScriptID& propID, const ClassID& bossID = kBasePrefsScriptObjectBoss ) ;

 virtual ErrorCode AccessPreference( ScriptID propID, IScriptRequestData* data, IScript* parent ) ;
 virtual bool16 CanAccessPreference( ScriptID propID, IScript* parent ) const ;

 virtual IScript* QueryPrefScript( const IScriptRequestData* data, IScript* parent, const ScriptID& propID ) ;

 static IPMUnknown* QueryPreferences( const IScriptRequestData* data, const IScript* prefsScript, const PMIID& prefInterfaceID ) ;
};

#endif /* _H_PrefsScriptProvider */