IAppearanceItemFacade.h

//========================================================================================
// 
// $File$
// 
// Owner: Mitch Coleman
// 
// $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 __IAppearanceItemFacade__ 
#define __IAppearanceItemFacade__

#include "IPMUnknown.h"
#include "IAppearanceList.h"
#include "INewStateCmdData.h"

#include "FormFieldTypes.h"
#include "FormFieldID.h"

namespace Facade 
{
 class IAppearanceItemFacade : public IPMUnknown
 { 
 public: 

 enum { kDefaultIID = IID_IAPPEARANCEITEMFACADE };

 enum CopyItemsFlag { 
 kCopyItems = kTrue, 
 kDoNotCopyItems = kFalse 
 };

 enum { kInvalidIndex = -1 };

 virtual ErrorCode CreateAppearanceItem (
 const UIDList& inItems,
 const ClassID& inAppearanceItemClass,
 UIDList* outAppearanceItems = nil
 ) const = 0;

 virtual ErrorCode CreateNewState(
 const UIDList& inItems,
 Form::AppearanceState inState,
 int32 inPosition = IAppearanceList::kLastInOrder,
 CopyItemsFlag inCopyItems = kCopyItems,
 INewStateCmdData::NamePolicy inNamePolicy = INewStateCmdData::kUseDefaultName,
 const PMString* inNameString = nil
 ) const = 0;

 virtual ErrorCode MoveState (
 const UIDList& inAppearanceItems,
 Form::AppearanceState inState,
 int32 inPosition
 ) const = 0;

 virtual ErrorCode DeleteState(
 const UIDList& inAppearanceItems, 
 Form::AppearanceState inState
 ) const = 0;

 virtual ErrorCode DeleteAppearance(
 const UIDList& inAppearanceItems, 
 Form::AppearanceState inState
 ) const = 0;

 virtual ErrorCode SetActiveState(
 const UIDList& inAppearanceItems, 
 Form::AppearanceState inState
 ) const = 0;

 virtual ErrorCode AddItemsToAppearance(
 const UIDRef& inAppearanceItem, 
 const UIDList& inItemsToAdd, 
 Form::AppearanceState inState
 ) const = 0;

 virtual ErrorCode AddItemsAsState( 
 const UIDRef& inAppearanceItem, 
 const UIDList& inItemsToAdd,
 Form::AppearanceState inState
 ) const = 0;

 virtual ErrorCode AddItemsAsStates( 
 const UIDRef& inAppearanceItem, 
 const UIDList& inItemsToAdd 
 ) const = 0;

 virtual ErrorCode ReleaseAppearanceAsObject( 
 const UIDList& inAppearanceItems,
 Form::AppearanceState inState 
 ) const = 0;

 virtual ErrorCode ReleaseAllAppearancesAsObjects( 
 const UIDList& inAppearanceItems
 ) const = 0;

 virtual Form::AppearanceState GetActiveState(
 const UIDRef& inAppearanceItem
 ) const = 0;

 virtual Form::AppearanceState GetNthState(
 const UIDRef& inAppearanceItem,
 int32 inStateIndex 
 ) const = 0;

 virtual Form::AppearanceState GetNextAvailableState(
 const UIDRef& inAppearanceItem
 ) const = 0;

 virtual ErrorCode SetStateName(
 const UIDRef& inAppearanceItem, 
 Form::AppearanceState inState, 
 const PMString& inName
 ) const = 0;

 virtual PMString GetStateName(
 const UIDRef& inAppearanceItem,
 Form::AppearanceState inState
 ) const = 0;

 virtual int32 GetNumStates(
 const UIDRef& inAppearanceItem
 ) const = 0;

 virtual int32 GetStatePosition(
 const UIDRef& inAppearanceItem, 
 Form::AppearanceState inState
 ) const = 0;

 virtual bool16 HasState( 
 const UIDRef& inAppearanceItem, 
 Form::AppearanceState inState 
 ) const = 0;

 virtual bool16 CanAddState( 
 const UIDRef& inAppearanceItem,
 Form::AppearanceState inState
 ) const = 0;

 virtual ErrorCode PasteIntoState(
 const UIDRef& inAppearanceItem, 
 Form::AppearanceState inState,
 UIDList* outPastedItems = nil
 ) const = 0;

 virtual bool16 GetIsInitiallyHidden(
 const UIDRef& inItem
 ) const = 0;

 virtual ErrorCode SetIsInitiallyHidden(
 const UIDRef& inItem, 
 bool16 inHidden
 ) const = 0;

 };

};


#endif // __IAppearanceItemFacade