InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IBoundsData Class Referenceabstract
Inheritance diagram for IBoundsData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IBOUNDSDATA }
 
enum  ContainmentType { kNoBoundsChecking = 0, kNoItemsCompletelyOutside = 1, kAllItemsCompletelyInside = 2, kUseDefaultBoundsChecking = 3 }
 

Public Member Functions

virtual void SetBoundsChecking (ContainmentType containmentType, const PMRect *bounds, const Transform::CoordinateSpace &coordinateSpace)=0
 
void SetDefaultBoundsChecking ()
 
void SetNoBoundsChecking ()
 
virtual ContainmentType GetBoundsChecking (PMRect *bounds, Transform::CoordinateSpace *coordinateSpace) const =0
 
virtual ContainmentType CalculateBoundsChecking (const UIDRef &item, PMRect *rect, UIDRef *rectParent)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual ContainmentType IBoundsData::CalculateBoundsChecking (const UIDRefitem,
PMRectrect,
UIDRefrectParent 
)
pure virtual

CalculateBoundsChecking returns the bounds checking used for a particular page item. Note that kUseDefaultBoundsChecking is resolved to a rectangle and one of kNoItemsCompletelyOutside or kAllItemsCompletelyInside. The parameter rectParent returns the ancestor of item in which coordinate system rect is defined.

virtual ContainmentType IBoundsData::GetBoundsChecking (PMRectbounds,
Transform::CoordinateSpacecoordinateSpace 
) const
pure virtual

GetBoundsChecking returns the values passed to SetBoundsChecking.

Parameters
bounds- the rectangle passed to SetBoundsChecking
coordinateSpace- the coordinate space passed to SetBoundsChecking
Returns
returns the ContainmentType passed to SetBoundsChecking
virtual void IBoundsData::SetBoundsChecking (ContainmentType containmentType,
const PMRectbounds,
const Transform::CoordinateSpacecoordinateSpace 
)
pure virtual

SetBoundsChecking specifies how and within what rectangle a page item is to be constrained during resize and transform commands.

Parameters
containmentType- one of kNoBoundsChecking, kNoItemsCompletelyOutside, kAllItemsCompletelyInside, kUseDefaultBoundsChecking
bounds- the rectangle within which the items are constrained
coordinateSpace- the coordinate space of bounds - usually Transform::SpreadCoordinates() Note for kNoItemsCompletelyOutside or kAllItemsCompletelyInside, bounds must be non-nil, for kNoBoundsChecking or kUseDefaultBoundsChecking bounds is stored, but ignored.
void IBoundsData::SetDefaultBoundsChecking ()
inline

SetDefaultBoundsChecking specifies that the default bounds checking should be used for each item. Typically this means that inlines are constrained within their text frames and other page items are constrained within the pasteboard.

void IBoundsData::SetNoBoundsChecking ()
inline

SetNoBoundsChecking turns off all bounds checking during execution of the command.