IItemLockData Class Reference

#include <IItemLockData.h>

Inheritance diagram for IItemLockData:

Public Types
enum	{ kDefaultIID = IID_IITEMLOCKDATA }

Public Member Functions
virtual void	SetInsertLock (bool8 lock)=0
virtual bool8	GetInsertLock (bool8 checkParent=kTrue) const =0
virtual void	SetAttributeLock (bool8 lock)=0
virtual bool8	GetAttributeLock (bool8 checkParent=kTrue) 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

This class is used to determine if an object is editable. If it is locked for insert then it's content cannot edited (inserted, deleted, etc), if it is locked for attribute then attribute changes cannot be applied to the content.

The object is added into the kTextStoryBoss and the kSplineItemBoss, it replaces the ITextLockData.

Member Function Documentation

virtual bool8 IItemLockData::GetAttributeLock ( bool8  checkParent = kTrue ) const

pure virtual

Get the attribute lock. If item is an inline the parent's lock is returned unless otherwise specified.

Parameters

checkParent

kFalse to return inline's lock rather than it's parent's lock

Returns

kTrue if locked

virtual bool8 IItemLockData::GetInsertLock ( bool8  checkParent = kTrue ) const

pure virtual

Get the insert lock. If item is an inline the parent's lock is returned unless otherwise specified.

Parameters

checkParent

kFalse to return inline's lock rather than it's parent's lock

Returns

kTrue if locked

virtual void IItemLockData::SetAttributeLock ( bool8  lock )

pure virtual

Sets the attribute lock used to determine is attribute changes are allowed.

Parameters

lock	kTrue to set the attribute lock

virtual void IItemLockData::SetInsertLock ( bool8  lock )

pure virtual

Sets the insert lock used to determine is editing is allowed.

Parameters

lock	kTrue to set the insert lock