ILockPosition Class Reference

#include <ILockPosition.h>

Inheritance diagram for ILockPosition:

Public Types
enum	{ kDefaultIID = IID_ILOCKPOSITION }
enum	LockType { kUnlock = 0x00, kLock = 0x01 }

Public Member Functions
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
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Page item interface that controls if any item can have its position (or other geometry) changed or not.

Member Function Documentation

virtual int32 ILockPosition::GetLockPosition ( ) const

pure virtual

Return the lock position flag. In general, returns kUnlock or kLock based on the setting. However, for managed frames, additional logic comes into play. A content item is considered locked whenever its parent frame has an insert lock. This means that IItemLockData->GetInsertLock is returns kTrue. Also, for the graphic frame itself, InCopy will always consider the it locked–no frame manipulation allowed in InCopy.

Returns

bool16 Returns kUnlock or kLock

virtual int32 ILockPosition::GetLockState ( ) const

pure virtual

Return kTrue if the LockPosition flag is locked. This does not consider managed frames and just returns the state that was Set.

Returns

int32 kLock or kUnlock

virtual bool16 ILockPosition::IsLocked ( ) const

pure virtual

Return kTrue if the page item's position is considered locked.

Returns

bool16 Returns kTrue if GetLockPosition returns kLock, kFalse otherwise.

virtual bool16 ILockPosition::IsLockStateLocked ( ) const

pure virtual

return kTrue if the page item's locked state is set to locked. This does not consider managed frames.

Returns

kTrue if lock state is kLock

virtual bool16 ILockPosition::IsPageItemLocked ( bool16  selecting = kFalse ) const

pure virtual

return kTrue if the page item is locked. This includes all layout items and groups, but excludes guides.

Parameters

selecting

- if kTrue, it will check and honor the Prevent Selecting Locked Items preference.

Returns

kTrue if the item is appropriate and locked. if selecting is true then the preference above must be must also be kTrue before an item will be considered locked.

virtual bool16 ILockPosition::IsUnlocked ( ) const

pure virtual

Return kTrue if the page item's position is considered unlocked.

Returns

bool16 Returns kTrue if GetLockPosition returns kUnlock, kFalse otherwise.

virtual void ILockPosition::Set ( int32  lockFlag )

pure virtual

Set the lock position flag (kLock or kUnlock). Does not affect IItemLockData lock state. See kSetItemLockCmdBoss for more info.

Parameters

int32

- must be kLock or kUnlock.