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

#include <IRefPointShape.h>

Inheritance diagram for IRefPointShape:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IREFPOINTSHAPE }
 
enum  { kSize = 13 }
 

Public Member Functions

virtual void Path (IGraphicsPort *gPort, const PBPMPoint &center)=0
 
virtual void Draw (IGraphicsContext *gc, const PMPoint &center)=0
 
virtual void Invalidate (IGraphicsContext *gc, const PMPoint &center, bool16 forceInval=kFalse)=0
 
virtual PMRect GetBounds (IGraphicsContext *gc, const PMPoint &center)=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

Interface class that handles drawing the actual reference point shape on the screen. In general, these methods are only used internally since the management of the reference point is handled via higher-level calls.

See Also
IRefPointUIUtils.h

Member Enumeration Documentation

anonymous enum

Enum that controls the size of the reference point (in pixels).
Enumerator
kSize 

Bounds of the reference point shape.

Member Function Documentation

virtual void IRefPointShape::Draw (IGraphicsContextgc,
const PMPointcenter 
)
pure virtual

Description

Parameters
gc[IN] IGraphicsContext pointer for drawing.
center[IN] the point in pasteboard coordinates to center the reference point drawing on.
virtual PMRect IRefPointShape::GetBounds (IGraphicsContextgc,
const PMPointcenter 
)
pure virtual

Return the bounds of the reference point shape.

Parameters
gc[IN] IGraphicsContext pointer for drawing.
center[IN] the point in pasteboard coordinates of the middle of reference point shape.
Returns
PMRect the bounds of the reference point shape in pasteboard coordinates
virtual void IRefPointShape::Invalidate (IGraphicsContextgc,
const PMPointcenter,
bool16 forceInval = kFalse 
)
pure virtual

Invalidate the area of the screen where the reference point shape is.

Parameters
gc[IN] IGraphicsContext pointer for drawing.
center[IN] the point in pasteboard coordinates to center the reference point invalidation on.
forceInval,kTrueto force the invalidation even if the reference point is hidden, kFalse to only invalidate when shown.
virtual void IRefPointShape::Path (IGraphicsPortgPort,
const PBPMPointcenter 
)
pure virtual

Method that does the actual drawing of the reference point shape.

Parameters
gPort[IN] the port to draw into.
center[IN] the point in pasteboard coordinates to center the reference point drawing on.