IWindowList Class Reference

#include <IWindowList.h>

Inheritance diagram for IWindowList:

Classes
class	iterator
class	reverse_iterator

Public Types
enum	{ kDefaultIID = IID_IWINDOWLIST }

Public Member Functions
virtual void	AddWindow (IWindow *newWin)=0
virtual void	WindowOpened (IWindow *win)=0
virtual void	WindowClosed (IWindow *win)=0
virtual void	CloseWindow (int32 index)=0
virtual void	CloseAll ()=0
virtual IPMUnknown *	GetPMUnknown (SysWindow window)=0
virtual bool16	IsWindowInList (IWindow *) const =0
iterator	begin ()
iterator	end ()
reverse_iterator	rbegin ()
reverse_iterator	rend ()
virtual IWindow *	GetNthWindow (int32 n)=0
virtual int32	WindowCount () const =0
virtual const K2Vector < IWindow * > &	GetZOrderSortedDocumentWindows () const =0
virtual void	MakeDocumentWindowTopmost (IWindow *docWindow)=0
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 a list of windows. There's an implementation of this interface on the application boss, holding all the application's windows, and another on the document boss, holding all the document's windows.

Member Function Documentation

virtual void IWindowList::AddWindow ( IWindow *  newWin )

pure virtual

Simply adds the window to the list.

Parameters

newWin

the window to add

virtual void IWindowList::CloseAll ( )

pure virtual

Close all the windows in the list by creating commands Note: Calling this method on an arbitrary set of IWindows, is not recommended.

virtual void IWindowList::CloseWindow ( int32  index )

pure virtual

Close the window at position index by creating a command Note: Calling this method on an arbitrary IWindow, is not recommended.

Parameters

index

the index of the window to close

virtual IWindow* IWindowList::GetNthWindow ( int32  n )

pure virtual

Return the n'th window

Parameters

n	which window

Returns

the requested window

virtual IPMUnknown* IWindowList::GetPMUnknown ( SysWindow  window )

pure virtual

Returns the object associated with the SysWindow. Usually this will be an IWindow, although it could be another interface, if the object doesn't have an associated IWindow. Returns nil if the SysWindow is not in the list.

Parameters

window

the OS window you're interested in.

Returns

a pointer to an interface on that window's boss.

virtual const K2Vector<IWindow *>& IWindowList::GetZOrderSortedDocumentWindows ( ) const

pure virtual

Returns the list of document windows sorted in z-order.

Returns

list of sorted document windows.

virtual bool16 IWindowList::IsWindowInList ( IWindow *  ) 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 IWindowList::MakeDocumentWindowTopmost ( IWindow *  docWindow )

pure virtual

Set docWindow to topmost in the sorted list

virtual void IWindowList::WindowClosed ( IWindow *  win )

pure virtual

Notify window list that "win" was closed. Adds window to list if not already there, and sends out a broadcast to let others know that a window has been removed from the list.

Parameters

win	the window which was closed

virtual int32 IWindowList::WindowCount ( ) const

pure virtual

Return the number of windows in the list.

Returns

count of windows

virtual void IWindowList::WindowOpened ( IWindow *  win )

pure virtual

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

Parameters

win	the window which was opened