ILayerUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Paul Sorrick
// 
// $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.
// 
// 
// Purpose:
// Utilities for use for dealing with layers.
// 
//========================================================================================

#ifndef __ILayerUtils__
#define __ILayerUtils__

#include "Utils.h"
#include "LayerID.h"

class UIDList;
class ICommand;
class IControlView;
class IDocument;
class IDocumentLayer;
class IHierarchy;
class ILayerList;
class ILayoutControlData;
class IScriptRequestData;
class ISpread;
class ISpreadLayer;

typedef int32 LayerFlags; // Used for return value for IsLayerUsed
 
/* Simple#defines (looking for only one attribute) involving CountLayers
 Usage is Utils<ILayerUtils>()->CountUILayers(layerList);
 */
#define CountLockedLayers(layerList) CountLayers(layerList, ILayerUtils::kFlagOn)
#define CountVisibleLayers(layerList) CountLayers(layerList, ILayerUtils::kDontCare, ILayerUtils::kFlagOn)
#define CountLockedGuideLayers(layerList) CountLayers(layerList, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kFlagOn)
#define CountVisibleGuideLayers(layerList) CountLayers(layerList, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kFlagOn)
#define CountUILayers(layerList) CountLayers(layerList, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kFlagOn)
#define CountExpendableLayers(layerList) CountLayers(layerList, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kFlagOn)
#define CountColoredLayers(layerList, uid) CountLayers(layerList, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kDontCare, uid)

/* More complex#defines, looking for a combination of attributes:
 Usage is Utils<ILayerUtils>()->CountUILayers(layerList);
 */
#define CountExpendableUILayers(layerList) CountLayers(layerList, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kFlagOn, ILayerUtils::kFlagOn)
#define CountLockedUILayers(layerList) CountLayers(layerList, ILayerUtils::kFlagOn, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kFlagOn)
#define CountVisibleUILayers(layerList) CountLayers(layerList, ILayerUtils::kDontCare, ILayerUtils::kFlagOn, ILayerUtils::kDontCare, ILayerUtils::kDontCare, ILayerUtils::kFlagOn)

class ILayerUtils : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ILAYERUTILS };

 enum CountLayersFlags { kFlagOff = ((int32)0), kFlagOn = ((int32)1), kDontCare = ((int32)0xFFFFFFFF) };
 
 
 enum
 {
 kLayerNotUsed = 0x0000,
 kLayerContainsArtwork = 0x0001,
 kLayerContainsGuides = 0x0002,
 kLayerHasPlaceGunOwnedItem = 0x0004,
 kLayerContainsBoth = kLayerContainsArtwork | kLayerContainsGuides
 };

 virtual LayerFlags IsLayerUsed(IDocumentLayer* docLayer) = 0;

 virtual int32 CountLayers(const ILayerList *layerList,
 int32 isLocked = kDontCare,
 int32 isVisible = kDontCare,
 int32 isGuideLocked = kDontCare,
 int32 isGuideVisible = kDontCare,
 int32 isUILayer = kDontCare,
 int32 isExpendable = kDontCare,
 UID colorUID = (UID)kDontCare) = 0;

 virtual bool16 AnyLayersHidden(IDocument* document, int32* numHidden = nil) = 0;

 virtual bool16 AnyLayersLocked(IDocument* document, int32* numLocked = nil) = 0;

 virtual bool16 AreLayersUnlockedAndVisible(const UIDList* pageItems) = 0;

 virtual bool16 IsActiveLayerUnlockedAndVisible(const ILayoutControlData* layoutData) = 0;

 virtual ICommand* MakeUnlockShowLayerCmd(IControlView *controlView, IDocumentLayer* docLayer = nil) = 0;

 virtual UID GetLayerUID(const IHierarchy *theItem) = 0;

 virtual IDocumentLayer* QueryDocumentActiveLayer(const IDocument* document) = 0;

 virtual ErrorCode GetDestinationLayers( IScriptRequestData* data, ISpread* spread, K2Vector< InterfacePtr<ISpreadLayer> >& destinationLayerList ) = 0;
};
 
#endif // __ILayerUtils__