Facade::IPageItemLockFacade Class Reference

Inheritance diagram for Facade::IPageItemLockFacade:

Public Types
enum	{ kDefaultIID = IID_IPAGEITEMLOCKFACADE }

Public Member Functions
virtual bool16	CanLock (UIDList targetItemList) const =0
virtual bool16	CanUnlock (UIDList targetItemList) const =0
virtual bool16	IsLockedAndNotSelectable (UIDList targetItemList) const =0
virtual bool16	IsAnyAncestorLocked (const UIDRef &oneItem) const =0
virtual bool16	AreItemsAllLocked (UIDList targetItemList) const =0
virtual ErrorCode	LockPageItems (UIDList targetItemList)=0
virtual ErrorCode	UnlockPageItems (UIDList targetItemList)=0
virtual bool16	AreAnyUnlockableOnSpread (const UIDRef &targetSpread) const =0
virtual bool16	AreAnyUnlockableInDocument (IDocument *theDoc) const =0
virtual ErrorCode	UnlockAllOnSpread (const UIDRef &targetSpread)=0
virtual ErrorCode	UnlockAllInDocument (IDocument *theDoc)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Function Documentation

virtual bool16 Facade::IPageItemLockFacade::AreAnyUnlockableInDocument ( IDocument *  theDoc ) const

pure virtual

Description: See if any items are locked on the target document. This walks all master and regular spreads.

Parameters

theDoc

- the document to operate on

Returns

ErrorCode

virtual bool16 Facade::IPageItemLockFacade::AreAnyUnlockableOnSpread ( const UIDRef &  targetSpread ) const

pure virtual

Description: See if any items are locked on the target spread.

Parameters

targetSpread

- Spread to check.

Returns

bool16 true if any items on the spread are locked.

virtual bool16 Facade::IPageItemLockFacade::AreItemsAllLocked ( UIDList  targetItemList ) const

pure virtual

Description: Are all of the target page item locked?

Parameters

targetItemList

- the list of items in question

Returns

bool16

virtual bool16 Facade::IPageItemLockFacade::CanLock ( UIDList  targetItemList ) const

pure virtual

Description:Can lock any of the target page items?

Parameters

targetItemList

- the list of items in question

Returns

bool16

virtual bool16 Facade::IPageItemLockFacade::CanUnlock ( UIDList  targetItemList ) const

pure virtual

Description: Can Unlock any of the target page items?

Parameters

targetItemList

- the list of items in question

Returns

bool16

virtual bool16 Facade::IPageItemLockFacade::IsAnyAncestorLocked ( const UIDRef &  oneItem ) const

pure virtual

Description: Is any ancestor(including the layer) locked

Parameters

oneItem

- the item in question

Returns

bool16

virtual bool16 Facade::IPageItemLockFacade::IsLockedAndNotSelectable ( UIDList  targetItemList ) const

pure virtual

Description: IsLockedAndNotSelectable

Parameters

targetItemList

- the list of items in question

Returns

bool16 kTrue if items are locked and can't be selected because of preference setting, kFalse if unlocked or if item is locked and CAN be selected.

virtual ErrorCode Facade::IPageItemLockFacade::LockPageItems ( UIDList  targetItemList )

pure virtual

Description: Lock the target page items

Parameters

targetItemList

- the list of items to operate on

Returns

ErrorCode

virtual ErrorCode Facade::IPageItemLockFacade::UnlockAllInDocument ( IDocument *  theDoc )

pure virtual

Description: Unlocks the page items on the target document. This walks all master and regular spreads.

Parameters

theDoc

- the document to operate on

Returns

ErrorCode

virtual ErrorCode Facade::IPageItemLockFacade::UnlockAllOnSpread ( const UIDRef &  targetSpread )

pure virtual

Description: Unlocks the page items on the target spread.

Parameters

targetSpread

- the Spread to operate on

Returns

ErrorCode

virtual ErrorCode Facade::IPageItemLockFacade::UnlockPageItems ( UIDList  targetItemList )

pure virtual

Description: Unlock the target page items

Parameters

targetItemList

- the list of items to operate on

Returns

ErrorCode