InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
FindMasterItemsIterator Class Reference

#include <CSprite.h>

Inheritance diagram for FindMasterItemsIterator:
ICallback

Public Member Functions

 FindMasterItemsIterator (const ISpread *drawingSpread, UIDList *masterItemsFound, const UIDList *candidates, PMMatrixCollection *masterInner2DrawingSpreadPBList)
 
virtual void ExecuteCallback (const PMMatrix *xform, IPMUnknown *iThing, int32 flags)
 
virtual int32 IterateChildren ()
 
virtual IDrawMgrGetCallbackDrawManager ()
 

Detailed Description

FindMasterItemsIterator is used to walk the hierarchy looking for master page items that belong to the 'candidates.' When such a page item is found, it is appended to the 'masterItemsFound' list and a Matrix that can be used to transform the master page item into pasteboard coordinates for the target drawing spread is appended to 'masterInner2DrawingSpreadPBList.'

Constructor & Destructor Documentation

FindMasterItemsIterator::FindMasterItemsIterator (const ISpreaddrawingSpread,
UIDListmasterItemsFound,
const UIDListcandidates,
PMMatrixCollectionmasterInner2DrawingSpreadPBList 
)
Parameters
drawingSpread[IN]: the target spread
masterItemsFound[OUT]: master page items from 'candidates' that are encountered while iterating the drawingSpread's draw hierarchy.
candidates[IN]: If the page item is not in 'candidates,' then it is ignored.
masterInner2DrawingSpreadPBList[OUT]: list of Matrices that can be used to transform the corresponding master page item in 'masterItemsFound' into pasteboard coordinates for the target drawing spread.

Member Function Documentation

virtual void FindMasterItemsIterator::ExecuteCallback (const PMMatrixxform,
IPMUnknowniThing,
int32 flags 
)
virtual

Callback is where all the logic lives

Implements ICallback.

virtual IDrawMgr* FindMasterItemsIterator::GetCallbackDrawManager ()
virtual

Grab the IDrawMgr for this iterator.

Implements ICallback.

virtual int32 FindMasterItemsIterator::IterateChildren ()
virtual

IterateChildren triggers the walking of the hierarchy.