IWindowList.h

//========================================================================================
// 
// $File$
// 
// Owner: frits habermann
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Purpose: IWindowList provides an interface for collecting a set of windows. It also provides methods for opening
// and closing a window.
// 
//========================================================================================

#ifndef __IWINDOWLIST__
#define __IWINDOWLIST__

#include "IPMUnknown.h"
#include "ShuksanID.h"
#include "IWindow.h"

class IWindow;
class IWindowList : public IPMUnknown
{
public:
 enum {kDefaultIID = IID_IWINDOWLIST};

 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;
 
 

#ifdef ID_DEPRECATED

 virtual IWindow* GetFrontWindow() = 0;
#endif

 virtual bool16 IsWindowInList(IWindow *) const = 0;
 
 class iterator
 {
 friend class IWindowList;
 public:
 typedef std::ptrdiff_t difference_type;
 typedef IWindow* value_type;
 bool16 operator==(const iterator& rhs) const { return n == rhs.n && list == rhs.list;}
 bool16 operator!=(const iterator& rhs) const { return !(*this == rhs);}
 iterator& operator++() { ++n; return *this;}
 IWindow* operator*() const { return list->GetNthWindow(n);}
 private:
 IWindowList* list;
 int32 n;
 iterator();
 iterator(IWindowList* inList, int32 inN) : list(inList), n(inN) {}
 };
 class reverse_iterator
 {
 friend class IWindowList;
 public:
 typedef std::ptrdiff_t difference_type;
 typedef IWindow* value_type;
 bool16 operator==(const reverse_iterator& rhs) const { return n == rhs.n && list == rhs.list;}
 bool16 operator!=(const reverse_iterator& rhs) const { return !(*this == rhs);}
 reverse_iterator& operator++() { --n; return *this;}
 IWindow* operator*() const { return list->GetNthWindow(n-1);}
 private:
 IWindowList* list;
 int32 n;
 reverse_iterator();
 reverse_iterator(IWindowList* inList, int32 inN) : list(inList), n(inN) {}
 };
 friend class iterator;
 friend class reverse_iterator;

 iterator begin() { return iterator(this, 0);}
 iterator end(){ return iterator(this, WindowCount());}
 reverse_iterator rbegin() { return reverse_iterator(this, WindowCount());}
 reverse_iterator rend() { return reverse_iterator(this, 0);}


public://until I get everyone using the iterators

 virtual IWindow* GetNthWindow(int32 n ) = 0;
 
 virtual int32 WindowCount() const = 0;

 virtual const K2Vector<IWindow *>& GetZOrderSortedDocumentWindows() const = 0;

 virtual void MakeDocumentWindowTopmost(IWindow * docWindow) = 0;


#ifdef ID_DEPRECATED

 int32 Length() const {return WindowCount();};
#endif
};


#endif