IPageItemBoundsList.h

//========================================================================================
// 
// $File$
// 
// Owner: jargast
// 
// $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.
// 
//========================================================================================

#ifndef __IPageItemBoundsList__
#define __IPageItemBoundsList__

#include "IPMUnknown.h"
#include "GenericID.h"
#include "PMRect.h"
#include "UIDList.h"
#include "IHierarchy.h"

// Return kTrue to abort the operation, kFalse to continue..
typedef bool8 (*PageItemIntersectCallback)(const UIDRef& uidRef, void *data);

class IPageItemBoundsList : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPAGEITEMBOUNDSLIST };

 virtual void Add (IPMUnknown* iUnknown, int32 at) = 0;
 
 virtual void Move (IPMUnknown* iUnknown, int32 from, int32 to) = 0;
 
 virtual void Remove (IPMUnknown* iUnknown, int32 at) = 0;
 
 virtual bool16 Invalidate (IPMUnknown* iUnknown) = 0;
 
 virtual bool16 InvalidateAll () = 0;
 
 virtual int32 Length() const = 0;
 
 virtual PMRect GetNthBounds (int32 n) const = 0;
 
 virtual UIDList GetIntersectingItems (const PMRect& rect, UID uidBelowThis = kInvalidUID) const = 0;

 virtual void GetIntersectingItems (const PMRect& rect, PageItemIntersectCallback callback, void *data) const = 0;
 
 
 
#if 0
 class iterator
 {
 friend class PageItemBoundsList;
 public:
 bool16 operator==(const iterator& rhs) const { return n == rhs.n;}
 bool16 operator!=(const iterator& rhs) const { return !(*this == rhs);}
 

 private:
 UIDRef operator*() const;
 iterator& operator++();
 InterfacePtr<const IHierarchy> h;
 PageItemBoundsList* p;
 int32 n, length;
 PMRect r;
 
 iterator();
 iterator( PageItemBoundsList* p, const PMRect& r, int32 n, int32 l);
 };

 virtual iterator begin( const PMRect& rect) = 0;
 virtual iterator end( const PMRect& rect) = 0;
// virtual UIDRef next( iterator& i) = 0;
#endif
};


#endif