InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ISnapToSelectionSuite Class Referenceabstract

#include <ISnapToSelectionSuite.h>

Inheritance diagram for ISnapToSelectionSuite:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISNAPTOSELECTIONSUITE }
 

Public Member Functions

virtual bool16 CanDoSnapTo (IDocument *document, SnapFlags flags) const =0
 
virtual SnapType SnapToPoint (ISnapTo *snapTo, IControlView *theView, PMPoint &thePoint, const PMRect *theRect, SnapType snapType, PMReal snapToZone, ILayoutControlData *layoutData)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Defines the interface for a snap-to suite to be used in the new selection architecture

Member Function Documentation

virtual bool16 ISnapToSelectionSuite::CanDoSnapTo (IDocumentdocument,
SnapFlags flags 
) const
pure virtual

Is this selection suite enabled? Can SnapToPoint be called?

Parameters
*document
flagsISnapTo::SnapFlags
Returns
bool16 kTrue if enabled, kFalse otherwise
virtual SnapType ISnapToSelectionSuite::SnapToPoint (ISnapTosnapTo,
IControlViewtheView,
PMPointthePoint,
const PMRecttheRect,
SnapType snapType,
PMReal snapToZone,
ILayoutControlDatalayoutData 
)
pure virtual

Snap the given point to the selection.

Parameters
snapToISnapTo interface
theViewview doing the snapping
thePointin/out point that might be snapped
theRect
snapTypehow thePoint was snapped (one of SnapType enum values)
snapToZone
layoutData
Returns