IAppearanceSuite.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 _IAppearanceSuite_
#define _IAppearanceSuite_

#include "FormFieldID.h"
#include "IAppearanceList.h"
#include "IAppearanceItemFacade.h"
#include "FormFieldTypes.h"
#include "BravoForwardDecl.h"

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

class IAppearanceList;
class ILibrary;
class AGMImageAccessor;

class IAppearanceSuite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IAPPEARANCESUITE };

 enum HowToAddStates { kAddItemsAsIndividualStates, kAddAllItemsToOneNewState, kAddItemsToActiveState };
 enum { kInvalidIndex = -1 };

 virtual Form::AppearanceState GetActiveState() const = 0;
 
 virtual ErrorCode SetActiveState( Form::AppearanceState inState ) const = 0;

 virtual void SelectActiveState() const = 0;
 
 virtual Form::AppearanceState GetNthState( int32 inStateIndex ) const = 0;
 
 virtual bool16 GetAppearance( Form::AppearanceState inState, Form::Appearance* outAppearance ) const = 0;
 
 virtual bool16 HasAppearance( Form::AppearanceState inState ) const = 0;
 
 virtual bool16 HasAppearanceContent( Form::AppearanceState inState ) const = 0;
 
 virtual ErrorCode SetAppearance( Form::AppearanceState inState, Form::AppearanceState inNewState, const Form::Appearance& inAppearance ) const = 0;
 
 virtual ErrorCode NewState( Form::AppearanceState inState, int32 inPosition = IAppearanceList::kLastInOrder ) const = 0;
 
 virtual ErrorCode DeleteState( Form::AppearanceState inState ) const = 0;
 
 virtual ErrorCode DeleteStateContent( Form::AppearanceState inState ) const = 0;
 
 virtual Form::AppearanceState GetNewState() const = 0;
 
 virtual bool16 CanAddState( Form::AppearanceState inState ) const = 0;

 virtual ErrorCode GetAppearanceThumbnail( Form::AppearanceState inState, int32 inMaxWidth, int32 inMaxHeight, AGMImageAccessor** pOutAGMImage ) const = 0;
 
 virtual ErrorCode SetAppearanceStyle(ILibrary* inLibrary, int32 inStyleIndex) const = 0;
 
 virtual ErrorCode RemoveAppearances() const = 0;

 virtual int32 NumStates() const = 0;
 
 virtual bool16 SelectionHasContentInAnyState() const = 0;
 
 virtual bool16 SelectionHasContentInActiveState() const = 0;
 
 virtual bool16 SelectionHasContentInState(Form::AppearanceState inState) const = 0;
 
 virtual bool16 HasStates() const = 0;

 virtual PMString GetStateName( Form::AppearanceState inState ) const = 0;

 virtual bool GetName(PMString& name) const = 0;

 virtual bool GetNameOfOnlyItemOfClass(PMString& name, const ClassID& classID) const = 0;
 
 virtual ErrorCode SetName(const PMString& newName) const = 0;

 virtual ErrorCode SetStateName(Form::AppearanceState state, const PMString& newName) const = 0;

 enum MultiItemSelectionPolicy {kHandleItemsAsAGroup, kHandleItemsIndividually};
 virtual ErrorCode CreateAppearanceItem (const ClassID& formFieldType, MultiItemSelectionPolicy multiItemSelectionPolicy = kHandleItemsIndividually) const = 0;

 virtual ErrorCode MoveState ( Form::AppearanceState state, int32 position ) const = 0;

 virtual ErrorCode DeleteAppearance( Form::AppearanceState state ) const = 0;

 virtual ErrorCode ReleaseAppearanceAsObject( Form::AppearanceState state ) const = 0;
 
 virtual ErrorCode ReleaseAllAppearancesAsObjects( ) const = 0;

 virtual int32 GetStatePosition(Form::AppearanceState state) const = 0;

 virtual bool16 CanPasteIntoState( const ClassID inAppearanceItemClass ) const = 0;
 
 virtual ErrorCode PasteIntoState(const ClassID inAppearanceItemClass, Form::AppearanceState inState) const = 0;

 virtual ErrorCode SetIsInitiallyHidden(bool16 inHidden) const = 0;

 virtual bool16 GetIsInitiallyHidden() const = 0;

 virtual bool16 IsAppearanceItemOfTypeSelected(const ClassID inAppearanceItemClass) const = 0;

 virtual ErrorCode SelectAssociatedAppearanceItemOfType(const ClassID inAppearanceItemClass) = 0;

 virtual bool16 IsActiveStateOfAppearanceItemOfTypeSelected(const ClassID inAppearanceItemClass) const = 0;
 
 virtual bool16 CanAddItemsAsStates(const ClassID& inClassToAddTo) const = 0;

 virtual ErrorCode AddItemsAsStates(const ClassID& inClassToAddTo, HowToAddStates inHowToAddStates) const = 0;

};

#endif // _IFormFieldSuite_