InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IPageItemBoundsList Class Referenceabstract

#include <IPageItemBoundsList.h>

Inheritance diagram for IPageItemBoundsList:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPAGEITEMBOUNDSLIST }
 

Public Member Functions

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
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This interface stores the bounds of children in the same order as IHierarchy stores

the UIDs of children

Member Function Documentation

virtual void IPageItemBoundsList::Add (IPMUnknown * iUnknown,
int32 at 
)
pure virtual
Add the page item to the bounds list.
Parameters
*iUnknown- The page item to add (specifically needs an ISpread interface)
at- The location (-1 Adds it at the end)
virtual UIDList IPageItemBoundsList::GetIntersectingItems (const PMRect & rect,
UID uidBelowThis = kInvalidUID 
) const
pure virtual
Returns a list of page items whose bounds intersect with the

passed in rectangle.

Parameters
&rect- The bounds you want to test for intersection with in inner coordinates of the boss holding this implementation. Currently that means layer or group coordinates.
uidBelowThis- Optional UID of the page item that returned items must be below in the z-order
Returns
UIDList - A list of page items that intersect with the PMRect
virtual void IPageItemBoundsList::GetIntersectingItems (const PMRect & rect,
PageItemIntersectCallback callback,
void * data 
) const
pure virtual
Finds all page items whose bounds intersect with the

passed in rectangle and passes it and the void *data to callback.

Parameters
&rect- The bounds you want to test for intersection with in inner coordinates of the boss holding this implementation. Currently that means layer or group coordinates.
callback- The callback method to use (If this method returns kTrue operation will be aborted.
*data- Additional data to pass to the callback
virtual PMRect IPageItemBoundsList::GetNthBounds (int32 n) const
pure virtual
Return the bounds for the nth page item
Parameters
n- The item whose bounds you want
Returns
PMRect - The bounds of the object in the coordinate system of the boss holding this implementation. Currently that means layer or group coordinates.
virtual bool16 IPageItemBoundsList::Invalidate (IPMUnknown * iUnknown)
pure virtual
Tell the bounds list that a page item's bounds have changed.
Parameters
*iUnknown- The page item that has changed (specifically needs an ISpread interface)
Returns
kTrue if the item had valid state
virtual bool16 IPageItemBoundsList::InvalidateAll ()
pure virtual
Tell the bounds list that all the items have changed.
Returns
kTrue if any of the items had valid state
virtual int32 IPageItemBoundsList::Length () const
pure virtual
Return the number of page items
Returns
int32 - The number of items in the list
virtual void IPageItemBoundsList::Move (IPMUnknown * iUnknown,
int32 from,
int32 to 
)
pure virtual
Move the item in the z-order
Parameters
*iUnknown- The page item to move (specifically needs an ISpread interface)
from- The location to move the item from
to- The location to move the item to (-1 moves it to the end)
virtual void IPageItemBoundsList::Remove (IPMUnknown * iUnknown,
int32 at 
)
pure virtual
Remove the page item to the bounds list.
Parameters
*iUnknown- The page item to remove (specifically needs an ISpread interface)
at- The location of the item to remove (-1 removes it from the end)