IFormFieldUtils.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 __IFormFieldUtils_h__
#define __IFormFieldUtils_h__

#include "AGMImageAccessor.h"
#include "FormFieldTypes.h"
#include "K2Pair.h"
#include "K2Vector.h"
#include "FormFieldID.h"
#include "Utils.h"

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

class IDocument;
class IHierarchy;
class IFormFieldFactory;
class ISpread;
class IGraphicStyleAttributeBossList;
class IApplyMultAttributesCmdData;
class IAppearanceList;
class ILayoutSelectionSuite;

class IFormFieldUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IFORMFIELDUTILS };

 typedef K2Pair<UID, Form::AppearanceState> UIDStatePair;
 typedef K2Vector<UIDStatePair> UIDStatePairs;

 virtual bool16 CanPlaceInAnnotation(const UIDList *inItems) const = 0;

 virtual bool16 CanEditItems(const UIDList *inItems) const = 0;

 virtual bool16 CanEditFormItems(const UIDList *inItems) const = 0;

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

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

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

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

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

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

 virtual ErrorCode ProcessChangeStateCmd(const UIDRef& inItemRef, Form::AppearanceState inState ) const = 0;

 virtual UIDRef CreateFormPageItem (const UIDRef& inParent, const PMRect& inBounds, ClassID inFormFieldBoss ) const = 0;

 virtual ErrorCode AddFormFieldContent ( UIDRef& inFormField ) const = 0;
 
 virtual IFormFieldFactory* QueryFormFieldFactory (ClassID inFactoryBoss) const = 0;

 virtual ErrorCode SetAppearanceState(UIDRef& inPageItem, Form::AppearanceState inState) const = 0;

 virtual Form::AppearanceState GetChildAppearanceState( IPMUnknown* inPageItem, UIDRef* outAppearanceParent, Form::AppearanceState* outActiveState ) const = 0;
 
 virtual void AddFormFieldAttributes(IGraphicStyleAttributeBossList* inSrcList, IApplyMultAttributesCmdData* inApplyAttributesCmdData, const PMString& inStyleName) const = 0;

 virtual PMString GetDefaultStateName(const IAppearanceList* inAppearanceList, Form::AppearanceState inState) const = 0;

 virtual PMString GetDuplicateName(const IAppearanceList* inAppearanceList, Form::AppearanceState inState ) const = 0;
 
 enum NumberingStartValue { kStartNumberingWithStateNumber = -2, kStartNumberingWithNextStateNumber = -1, kStartNumberingWithOne = 1, kStartNumberingWithTwo = 2 };
 enum UniqueNamePolicy { kDoesNotNeedToEndInANumber, kMustEndInANumber };
 virtual void MakeNameUniqueInAppearanceList( const IAppearanceList* inAppearanceList, PMString& inName, NumberingStartValue inStartValue, UniqueNamePolicy inNamePolicy = kDoesNotNeedToEndInANumber) const = 0;

 virtual PMString GetTargetName( const IPMUnknown* inItem, const ClassID& inStartingAncestorType ) const = 0;

 virtual bool16 CanPlaceInState(const UIDList& inItems, const ClassID& inTargetClass) const = 0;

 virtual bool16 CanCreateFromItems(const UIDList& inItems, const ClassID& inTargetClass) const = 0;

 virtual UIDList GetAllFormItemsOfTypeInDocument(const UIDRef& docRef, const ClassID& classID) const = 0;

 virtual ErrorCode ResetAllMultiStateObjects(const UIDRef& docRef) const = 0;

 virtual ErrorCode ResetAllButtons(const UIDRef& docRef) const = 0;

 virtual UIDRef GetStateWrappingGroup(const UIDRef& inItemRef, Form::AppearanceState inState) const = 0;

 virtual bool16 IsItemOnlyInActiveStates(const UIDRef& inItemRef, UID* outTopmostHidingAncestor = nil) const = 0;

 virtual UIDStatePairs GetStatesForItem(const UIDRef& inItemRef) const = 0;

 virtual void SetStatesSoThatItemIsActive(const UIDRef& inItemRef) const = 0;

 virtual void SelectActiveState(const UIDList& inItems) const = 0;

 //These are to help identify casting (the use of which should be minimized)
 inline int32 StateToIndex(Form::AppearanceState inState) const { return (int32)inState; }
 inline Form::AppearanceState IndexToState(int32 inIndex) const { return Form::AppearanceState(inIndex); }

 //The following are general page item utils that happened to be used by forms...
 
 virtual UID GetSpreadUID(IHierarchy* inPageItemHier) const = 0;

 virtual void GetPageUIDs(IHierarchy* inPageItemHier, UIDList* outPageUIDs) const = 0;

 virtual bool16 IsOnPage(ISpread* inSpread, int32 inPagePos, UIDList* ioPageItems, UID inPageItemUID) const = 0;

 virtual void GetDescendents( IHierarchy* inHierarchy, const PMIID& inInterfaceID, UIDList *outResultList ) const = 0;

 virtual void GetDescendents( const UIDList& inUIDList, const PMIID& inInterfaceID, UIDList *outResultList ) const = 0;

 virtual UIDList ExtractPageItemsWithIID(const UIDList& inUIDList, PMIID inIID) const = 0;
 
 virtual bool16 GetFirstAncestorOfClass( const IPMUnknown* inItem, const ClassID& inClassToFind, UIDRef& outItemRef ) const = 0;

 enum {kFixUpList = kTrue, kDontFixUpList = kFalse };
 virtual ErrorCode UngroupSingleItemGroups(UIDList& inOutItems, bool16 fixUpItemList = kDontFixUpList) const = 0;

 virtual ErrorCode ChangeHierarchyPreservingTransform(UIDRef inItemToChange, UID inNewParent) const = 0;

 virtual ErrorCode GetAppearanceThumbnail(UIDRef inAppearanceItemRef, Form::AppearanceState inState, int32 inMaxWidth, int32 inMaxHeight, AGMImageAccessor** pOutAGMImage) const = 0;

 virtual bool16 HasButtonOrFormField(const UIDList& inItems, const ClassID& inTargetClass) const = 0;

 virtual void TakeActionOnMissingFontFormAdornment(ILayoutSelectionSuite * iLayoutSelectionSuite, UIDRef item, bool16 shiftKeyDown, bool16 altOptionKeyDown) = 0;
 
 virtual bool DoesHaveFontAttribute(const UIDRef& uidRef) = 0;
 
 virtual ErrorCode SetFontFamilyAttrCmd(const UIDList& uidList,const PMString& fontFamilyName) const = 0;

 virtual ErrorCode SetFontFamilyAttr(const UIDList& uidList, const PMString& fontFamilyName) const = 0;
 
 virtual ErrorCode SetFontFamilyUIDAttrCmd(const UIDList& uidList, const UID& fontUID) const = 0;
 
 virtual ErrorCode SetFontFamilyUIDAttr(const UIDList& uidList, const UID& fontUID) const = 0;
 
 virtual ErrorCode SetFontStyleAttributeCmd(const UIDList& uidList, const PMString& fontStyleName) const = 0;

 virtual ErrorCode SetFontStyleAttribute(const UIDList& uidList, const PMString& fontStyleName) const = 0;
 
 virtual bool16 GetFontFamilyUIDAttr(const UIDRef& uidRef, UID& FontUID) const = 0;

 virtual bool16 GetFontStyleAttribute(const UIDRef& uidRef, PMString& fontStyleName) const = 0;
};

/* This is the preamble that appears on all default predefined apprearances that signals
 that the name should be translated. */
#define kPredefinedAppearanceNamePreamble "$$$/PredefinedAppearanceName/"


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

#endif // __IFormFieldUtils_h__