IAppearanceList.h

//========================================================================================
// 
// $File$
// 
// Owner: Tim Wright
// 
// $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 __IAppearanceList_h__
#define __IAppearanceList_h__

#include "IPMUnknown.h"
#include "FormFieldTypes.h"
#include "FormFieldID.h"
#include "BravoForwardDecl.h"

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

class IAppearanceList : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IAPPEARANCELIST };
 enum
 {
 kInvalidate = kTrue,
 kDontInvalidate = kFalse,
 kInvalidStateID = -1,
 kLastInOrder = -1
 };

 typedef int32 StateID;


 virtual Form::AppearanceState GetActiveState() const = 0;

 virtual StateID GetStateID(Form::AppearanceState inState) const = 0;

 virtual StateID GetActiveStateID() const = 0;

 virtual Form::AppearanceState GetIDState(IAppearanceList::StateID inStateID) const = 0;

 virtual void SetActiveState( Form::AppearanceState inState ) = 0;

 virtual Form::AppearanceState GetChildState( const UID& inChildUID ) const = 0;

 virtual Form::AppearanceState GetActiveStateTemp() const = 0;

 virtual Form::AppearanceState GetStateFromName(const PMString& name) const = 0;

 virtual Form::AppearanceState GetNextAvailableState() const = 0;
 
 virtual void SetActiveStateTemp( Form::AppearanceState inState, bool16 inInvalCaches=IAppearanceList::kInvalidate ) = 0;

 virtual int32 NumStates() const = 0;

 virtual bool16 HasAppearance( Form::AppearanceState inState ) const = 0;

 virtual void AddAppearance( Form::AppearanceState inState, const Form::Appearance& inAppearance, int32 position = kLastInOrder ) = 0;

 virtual void RemoveAppearance( Form::AppearanceState inState, Form::Appearance* outRemovedAppearance ) = 0;

 virtual void ChangeState( Form::AppearanceState inState, Form::AppearanceState inNewState) = 0;

 virtual void Move( Form::AppearanceState inState, int32 inPosition) = 0;
 
 virtual bool16 CanAddState( Form::AppearanceState inState ) const = 0;

 virtual bool16 GetAppearance( Form::AppearanceState inState, Form::Appearance* outAppearance ) const = 0;

 virtual void SetAppearance( Form::AppearanceState inState, const Form::Appearance& inAppearance ) = 0;

 virtual Form::AppearanceState GetNthState( int32 inStateIndex ) const = 0;

 virtual int32 GetStatePosition ( Form::AppearanceState inState ) const = 0;
 
 virtual void Clear() = 0; 

 virtual ErrorCode GetThumbnail( Form::AppearanceState inState, int32 inMaxWidth, int32 inMaxHeight, AGMImageRecord* outAGMRecord ) = 0;
 
 virtual void InvalidateThumbnail( Form::AppearanceState inState ) = 0;

 virtual void DisposeThumbnail( Form::AppearanceState inState ) = 0;

 virtual void ForceRemoveAppearance( Form::AppearanceState inState, Form::Appearance* outRemovedAppearance ) = 0;
};

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

class StSetStateTemp
{

public:
 StSetStateTemp(IAppearanceList* inAppList, Form::AppearanceState inState, bool16 inInvalCaches=IAppearanceList::kInvalidate )
 :
 fAppList(inAppList), fInvalCaches(inInvalCaches), fOrigState(Form::kStateInvalid)
 {
 if ( fAppList ) {
 fOrigState = inAppList->GetActiveStateTemp();
 fAppList->SetActiveStateTemp(inState,fInvalCaches);
 fAppList->AddRef();
 }
 }
 
 ~StSetStateTemp()
 {
 if ( fAppList ) {
 fAppList->SetActiveStateTemp(fOrigState,fInvalCaches);
 fAppList->Release();
 }
 }
 
private:
 IAppearanceList* fAppList;
 Form::AppearanceState fOrigState;
 bool16 fInvalCaches;
};

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

#endif // __IAppearanceList_h__

// IAppearanceList.h.