ILockPosition.h

//========================================================================================
// 
// $File$
// 
// Owner: Stacy Molitor
// 
// $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 of Interface:
// ILockPosition is an interface which specifies whether or not a page item's position is
// locked. If it's position is locked it cannot be moved, resized, deleted, etc.
// 
// All page items should have this interface, though if it's missing the page item is assumed
// to not be locked.
// 
//========================================================================================

#ifndef __ILockPosition__
#define __ILockPosition__

#include "IPMUnknown.h"
#include "GenericID.h"

class ILockPosition : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ILOCKPOSITION };

 typedef enum { kUnlock = 0x00, kLock = 0x01 } LockType;
 
 virtual void Set(int32 lockFlag) = 0;
 
 virtual int32 GetLockPosition() const = 0;
 
 virtual bool16 IsLocked() const = 0;
 
 virtual bool16 IsUnlocked() const = 0;

 virtual int32 GetLockState() const = 0;

 virtual bool16 IsLockStateLocked() const = 0;

 virtual bool16 IsPageItemLocked(bool16 selecting = kFalse) const = 0;

};

#endif //__ILockPosition__