IReferencePointData Class Reference

#include <IReferencePointData.h>

Inheritance diagram for IReferencePointData:

Public Types
enum	ReferencePointPosition {   kTopLeftReferencePoint = 0, kFirstReferencePointPosition = kTopLeftReferencePoint, kTopCenterReferencePoint = 1, kTopRightReferencePoint = 2,   kLeftCenterReferencePoint = 3, kCenterReferencePoint = 4, kRightCenterReferencePoint = 5, kBottomLeftReferencePoint = 6,   kBottomCenterReferencePoint = 7, kBottomRightReferencePoint = 8, kLastReferencePointPosition = kBottomRightReferencePoint, kOtherReferencePointPosition = 9,   kUninitializedReferencePointPosition = 10 }
enum	ReferenceAppearance {   kNinePoint = 0, kLine = 1, kPoint = 2, kHorizontalGuide = kPoint,   kVerticalGuide = 3, kCursor = 4, kDisabled = 5, kRow = 6,   kColumn = 7 }
enum	{ kDefaultIID = IID_IREFERENCEPOINTDATA }

Public Member Functions
virtual void	SetReferencePointData (const ReferencePointPosition &position, const PBPMPoint &point)=0
virtual ReferencePointPosition	GetPosition__ ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Friends
class	RefPointUIUtilsImpl

Detailed Description

Data interface for holding information about the reference point. Each layout view has its own a reference point. In general, you should control the reference point via IRefPointUIUtils, or even at a suite level in IReferencePointSuite, instead of calling these interfaces directly.

See Also

IRefPointUIUtils.h

IReferencePointSuite.h

Member Enumeration Documentation

enum IReferencePointData::ReferenceAppearance

What is the current appearance of the reference point proxy.

Enumerator
kNinePoint	All nine points
kLine	A line appearance with three points. Could be horizontal, vertical, or diagonal.
kPoint	A horizontal line appearance with just a center point
kHorizontalGuide	A horizontal line appearance with just a center point
kVerticalGuide	A vertical line appearance with just a center point
kCursor	Same as the nine point appearance
kDisabled	Use for a disabled look. Was previously (InDesign 2.0 era) used for no-pub state.
kRow	Use for a row only appearance
kColumn	Use for a column only appearance

enum IReferencePointData::ReferencePointPosition

Enum for describing the reference point position.

Enumerator
kTopLeftReferencePoint	Top left position
kFirstReferencePointPosition	Synonym for kTopLeft. Useful for loops over all the positions.
kTopCenterReferencePoint	Top center position
kTopRightReferencePoint	Top right position
kLeftCenterReferencePoint	Left center position
kCenterReferencePoint	Center position
kRightCenterReferencePoint	Right center position
kBottomLeftReferencePoint	Bottom left position
kBottomCenterReferencePoint	Bottom center position
kBottomRightReferencePoint	Bottom right position
kLastReferencePointPosition	Synonym for kBottomRight. Useful for loops over all the positions.
kOtherReferencePointPosition	Not one of the standard nine points, user has dragged to a custom location.
kUninitializedReferencePointPosition	No current reference position.

Member Function Documentation

virtual ReferencePointPosition IReferencePointData::GetPosition__ ( )

pure virtual

Return the value of the reference point

Returns

ReferencePointPosition

virtual void IReferencePointData::SetReferencePointData ( const ReferencePointPosition &  position, const PBPMPoint &  point  )

pure virtual

Set the position in the data interface.

Parameters

position

[IN] the reference position to set.

See Also

ReferencePointPositionSet the reference point in the data interface.

Parameters

point

[IN] the new reference point in global pasteboard coordinates.

See Also

ChangeReferencePoint