IPresentationList Class Reference

#include <IPresentationList.h>

Inheritance diagram for IPresentationList:

Classes
class	iterator
class	reverse_iterator

Public Types
enum	{ kDefaultIID = IID_IPRESENTATIONLIST }

Public Member Functions
virtual void	AddPresentation (IDocumentPresentation *newPres)=0
virtual void	PresentationHasOpened (IDocumentPresentation *pres)=0
virtual void	PresentationHasClosed (IDocumentPresentation *pres)=0
virtual void	CloseNthPresentation (int32 n)=0
virtual void	CloseAllPresentations ()=0
iterator	begin ()
iterator	end ()
reverse_iterator	rbegin ()
reverse_iterator	rend ()
iterator	find (IDocumentPresentation *it)
int32	size () const
int32	empty () const
IDocumentPresentation *	at (int32 n)
virtual int32	Find (IDocumentPresentation *) const =0
virtual int32	Length () const =0
virtual IDocumentPresentation *	At (int32 index) const =0
IDocumentPresentation *	First () const
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Friends
class	iterator
class	reverse_iterator

Detailed Description

This interface maintains an unordered list of document presentations. It's primary use is on the document boss, where it keeps track of all of the presentations open on the document.

Also:

See Also

IWindowList (which served this purpose prior to CS4, and from which IPresentationList is derived)

IDocumentUIUtils (for ordered access to the open document presentations.

Member Function Documentation

virtual void IPresentationList::AddPresentation ( IDocumentPresentation *  newPres )

pure virtual

Adds the presentation to the list.

Parameters

newPres

the presentation to add

virtual void IPresentationList::CloseAllPresentations ( )

pure virtual

Close all the presentations in the list by creating commands

virtual void IPresentationList::CloseNthPresentation ( int32  n )

pure virtual

Close the nth presentation by creating a command

Parameters

index

the index of the presentation to close

virtual int32 IPresentationList::Find ( IDocumentPresentation *  ) const

pure virtual

Check if a particular window is in this list.

Returns

kTrue if the given window is in this window list, otherwise kFalse

virtual void IPresentationList::PresentationHasClosed ( IDocumentPresentation *  pres )

pure virtual

Notify the list that a presentation has closed. Removes window from list if there, and sends out a broadcast to let others know that a presentation has been removed from the list.

Parameters

win	the window which was closed

virtual void IPresentationList::PresentationHasOpened ( IDocumentPresentation *  pres )

pure virtual

Notify the list that a presentation has opened. Adds presentation to list if not already there, and sends out a broadcast to let others know that a presentation has been added to the list.

Parameters

pres	the presentation which was opened