InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IMeasureToolData Class Referenceabstract

#include <IMeasureToolData.h>

Inheritance diagram for IMeasureToolData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IMEASURETOOLDATA }
 

Public Member Functions

virtual void SetStartPoint (const PMPoint &startPoint)=0
 
virtual const PMPoint & GetStartPoint ()=0
 
virtual void SetEndPoint (const PMPoint &endPoint)=0
 
virtual const PMPoint & GetEndPoint ()=0
 
virtual void SetMiddlePoint (const PMPoint &middlePoint)=0
 
virtual const PMPoint & GetMiddlePoint ()=0
 
virtual void SetProtractorFlag (const bool16 &isProtractor)=0
 
virtual bool16 GetProtractorFlag ()=0
 
virtual bool16 HasMeasureLine ()=0
 
virtual void SetVisibility (const bool16 &isVisible)=0
 
virtual bool16 GetVisibility ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This is a data interface to allow clients to access information about current measure line. There is one measure line per layout view.

Member Function Documentation

virtual const PMPoint& IMeasureToolData::GetEndPoint ()
pure virtual

Get the end point of current measure line.

Returns
PMPoint of end point.
virtual const PMPoint& IMeasureToolData::GetMiddlePoint ()
pure virtual

Get the middle point of current measure line. This is only when measure line is a protractor.

Returns
PMPoint of middle point.
virtual bool16 IMeasureToolData::GetProtractorFlag ()
pure virtual

Determine that if current measure line is protractor or not.

Returns
bool16 kTrue if it is a protractor; otherwise return kFalse.
virtual const PMPoint& IMeasureToolData::GetStartPoint ()
pure virtual

Get the start point of current measure line.

Returns
PMPoint of start point.
virtual bool16 IMeasureToolData::GetVisibility ()
pure virtual

Get the visible flag if current measure line.

Returns
bool16 kTrue if measure line is visible, otherwise return kFalse.
virtual bool16 IMeasureToolData::HasMeasureLine ()
pure virtual

Determine if there is a measure line in current workspace.

Returns
bool16 kTrue if there is a measure line; otherwise return kFalse.
virtual void IMeasureToolData::SetEndPoint (const PMPoint & endPoint)
pure virtual

Set the end point of current measure line.

Parameters
endPointThe new end point of measure line.
virtual void IMeasureToolData::SetMiddlePoint (const PMPoint & middlePoint)
pure virtual

Set the middle point of the measure line. This is only when measure line is a protractor.

Parameters
middlePointThe new middle point of the protractor.
virtual void IMeasureToolData::SetProtractorFlag (const bool16 & isProtractor)
pure virtual

Set kTrue if current measure line is protractor; otherwise set kFalse.

Parameters
bool16kTrue(is a protractor) or kFalse(not a protractor).
virtual void IMeasureToolData::SetStartPoint (const PMPoint & startPoint)
pure virtual

Set the start point of current measure line.

Parameters
startPointThe new start point of measure line.
virtual void IMeasureToolData::SetVisibility (const bool16 & isVisible)
pure virtual

Set the visible flag if current measure line is visible. Meausre line will be hidden if current active tool is not measure tool.

Parameters
bool16kTrue(if visible) or kFalse(if not visible)