Facade::IPageItemVisibilityFacade Class Reference

Inheritance diagram for Facade::IPageItemVisibilityFacade:

Public Types
enum	{ kDefaultIID = IID_IPAGEITEMVISIBILITYFACADE }

Public Member Functions
virtual bool16	CanHide (const UIDRef &targetItem) const =0
virtual bool16	CanAnyHide (const UIDList &targetItemList) const =0
virtual bool16	GetVisibleState (const UIDRef &targetItem) const =0
virtual bool16	IsHidden (const UIDRef &targetItem) const =0
virtual bool16	AreAnyHidden (const UIDList &targetItemList) const =0
virtual bool16	AreAllHidden (const UIDList &targetItemList) const =0
virtual bool16	AreAnyHiddenOnSpread (const UIDRef &targetItem) const =0
virtual ErrorCode	Show (const UIDList &targetItemList)=0
virtual ErrorCode	Hide (const UIDList &targetItemList)=0
virtual ErrorCode	ShowAllInSpread (const UIDRef &targetSpread)=0
virtual ErrorCode	GetHiddenObjects (const UIDRef &targetSpread, UIDList &hiddenItems)=0
virtual bool16	IsVisibleOnCanvas (const UIDRef &targetItem) 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

Member Function Documentation

virtual bool16 Facade::IPageItemVisibilityFacade::AreAllHidden ( const UIDList &  targetItemList ) const

pure virtual

Description: Returns true if all of the target items or their ancestors are hidden.

Parameters

targetItemList

- the list of items in question

Returns

bool16 - Returns true if all of the target items or their ancestors are hidden.

virtual bool16 Facade::IPageItemVisibilityFacade::AreAnyHidden ( const UIDList &  targetItemList ) const

pure virtual

Description: Returns true if any of the target items or their ancestors are hidden.

Parameters

targetItemList

- the list of items in question

Returns

bool16 - Returns true if any of the target items or their ancestors are hidden.

virtual bool16 Facade::IPageItemVisibilityFacade::AreAnyHiddenOnSpread ( const UIDRef &  targetItem ) const

pure virtual

Description: Returns true if any items on the given spread are hidden.

Parameters

targetItem

- the spread in question

Returns

bool16 - Returns true if any of the target items or their ancestors are hidden.

virtual bool16 Facade::IPageItemVisibilityFacade::CanAnyHide ( const UIDList &  targetItemList ) const

pure virtual

Description:Tests to see if any of the target items can be hidden using the IID_IVISIBLE interface.

Parameters

targetItem

- the page item in question

Returns

bool16 - true if the interface exists

virtual bool16 Facade::IPageItemVisibilityFacade::CanHide ( const UIDRef &  targetItem ) const

pure virtual

Description:Tests to see if the target item can be hidden using the IID_IVISIBLE interface.

Parameters

targetItem

- the page item in question

Returns

bool16 - true if the interface exists

virtual ErrorCode Facade::IPageItemVisibilityFacade::GetHiddenObjects ( const UIDRef &  targetSpread, UIDList &  hiddenItems  )

pure virtual

Description: Get the list of hidden objects on a given spread. These are objects that have the visible flag on them

Parameters

[IN]	targetSpread - the spread to gather objects from
[IN/OUT]	hiddenItems - the returned list of hidden items

Returns

ErrorCode

virtual bool16 Facade::IPageItemVisibilityFacade::GetVisibleState ( const UIDRef &  targetItem ) const

pure virtual

Description:Gets the visible flag stored on the item. It does not go up the hierarchy to determine if the item is effectively visible. In other words, if a parent is hidden and its child visible and this is called on the child, it returns visible. If the object does not suppor the visible flag, it just returns true or visible

Parameters

targetItem

- the page item in question

Returns

bool16 - true if visible flag is true or if object doesn't support the flag. false if flag is false.

virtual ErrorCode Facade::IPageItemVisibilityFacade::Hide ( const UIDList &  targetItemList )

pure virtual

Description: Unlock the target page items

Parameters

targetItemList

- the list of items to operate on

Returns

ErrorCode

virtual bool16 Facade::IPageItemVisibilityFacade::IsHidden ( const UIDRef &  targetItem ) const

pure virtual

Description: returns true if the item or any of it's ancestors have the visibility flag false.

Parameters

targetItemList

- the list of items in question

Returns

bool16 - true if the item or any of it's ancestors have the visibility flag false.

virtual bool16 Facade::IPageItemVisibilityFacade::IsVisibleOnCanvas ( const UIDRef &  targetItem ) const

pure virtual

Description: Returns if the target Item is visible on the canvas or not

Parameters

[IN]	targetItem - the page item in question

Returns

bool16 - kTrue if the page item is visible on canvas

virtual ErrorCode Facade::IPageItemVisibilityFacade::Show ( const UIDList &  targetItemList )

pure virtual

Description: Show the page item. If an ancestor is hidden, this change will not be visible.

Parameters

targetItemList

- the list of items to operate on

Returns

ErrorCode

virtual ErrorCode Facade::IPageItemVisibilityFacade::ShowAllInSpread ( const UIDRef &  targetSpread )

pure virtual

Description: Show all hidden items in target spread

Parameters

targetSpread

- the spread to operate on

Returns

ErrorCode