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

#include <IUnitOfMeasureSettings.h>

Inheritance diagram for IUnitOfMeasureSettings:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IUNITOFMEASURESETTINGS }
 

Public Member Functions

virtual void Init (const ClassID &xBossId, const ClassID &yBossId, const ClassID &textBossId, const ClassID &textSizeBossId, const ClassID &printUnitsBossId, const ClassID &lineUnitsBossId, const PMReal customHPoints=12.0, const PMReal customVPoints=12.0, const PMReal keyNudgeIncPts=1.0, const PMReal pointsPerInch=72.0)=0
 
virtual void SetXUnitOfMeasure (const ClassID &bossId)=0
 
virtual ClassID GetXUnitOfMeasure () const =0
 
virtual int16 GetXUnitOfMeasureIndex ()=0
 
virtual void SetYUnitOfMeasure (const ClassID &bossId)=0
 
virtual ClassID GetYUnitOfMeasure () const =0
 
virtual int16 GetYUnitOfMeasureIndex ()=0
 
virtual void SetTextUnitOfMeasure (const ClassID &bossId)=0
 
virtual ClassID GetTextUnitOfMeasure () const =0
 
virtual int16 GetTextUnitOfMeasureIndex ()=0
 
virtual void SetTextSizeUnitOfMeasure (const ClassID &bossId)=0
 
virtual ClassID GetTextSizeUnitOfMeasure () const =0
 
virtual int16 GetTextSizeUnitOfMeasureIndex ()=0
 
virtual void SetPrintUnitOfMeasure (const ClassID &bossId)=0
 
virtual ClassID GetPrintUnitOfMeasure () const =0
 
virtual int16 GetPrintUnitOfMeasureIndex ()=0
 
virtual void SetLineUnitOfMeasure (const ClassID &bossId)=0
 
virtual ClassID GetLineUnitOfMeasure () const =0
 
virtual int16 GetLineUnitOfMeasureIndex ()=0
 
virtual void SetHorzCustomPoints (const PMReal customPoints)=0
 
virtual PMReal GetHorzCustomPoints () const =0
 
virtual void SetVertCustomPoints (const PMReal customPoints)=0
 
virtual PMReal GetVertCustomPoints () const =0
 
virtual void SetKeyNudgeInc (const PMReal keyNudgeIncPts)=0
 
virtual PMReal GetKeyNudgeInc () const =0
 
virtual void SetPointsPerInch (const PMReal pointsPerInch)=0
 
virtual PMReal GetPointsPerInch () const =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

Interface that holds all the unit of measure settings. Installed on kWorkspaceBoss and kDocWorkspaceBoss.

Measurement systems themselves may be installed via service providers. All of the Get methods in this class check for missing service providers and return points as a default.

Member Function Documentation

virtual PMReal IUnitOfMeasureSettings::GetHorzCustomPoints () const
pure virtual

Returns the value to use for horizontal rulers when using kRulerCustomMSBoss.

Parameters
PMReal
virtual PMReal IUnitOfMeasureSettings::GetKeyNudgeInc () const
pure virtual

Returns the amount (in points) to use for keyboard nudging for various action IDs (e.g. kNudgeUpActionID).

Returns
PMReal
virtual ClassID IUnitOfMeasureSettings::GetLineUnitOfMeasure () const
pure virtual

Gets the class id of the line weight measurement system. Typically used by stroke weight controls.

Returns
ClassID
virtual int16 IUnitOfMeasureSettings::GetLineUnitOfMeasureIndex ()
pure virtual

Gets the index of the line weight unit of measure (measurement systems are service provider based). Useful as the parameter in a call to IUnitOfMeasure->QueryUnitOfMeasure(index).

Returns
int16
virtual PMReal IUnitOfMeasureSettings::GetPointsPerInch () const
pure virtual

Returns the value in use for points per inch used for the points-based measurement systems: kPointsBoss, kPicasBoss, and kRulerCustomMSBoss. Typically defaults to 72.0.

Returns
PMReal
virtual ClassID IUnitOfMeasureSettings::GetPrintUnitOfMeasure () const
pure virtual

NOTE: This measurement system is UNUSED. Gets the class id of the print measurement system.

Returns
ClassID
virtual int16 IUnitOfMeasureSettings::GetPrintUnitOfMeasureIndex ()
pure virtual

NOTE: This measurement system is UNUSED. Gets the index of the print unit of measure (measurement systems are service provider based). Useful as the parameter in a call to IUnitOfMeasure->QueryUnitOfMeasure(index).

Returns
int16
virtual ClassID IUnitOfMeasureSettings::GetTextSizeUnitOfMeasure () const
pure virtual

Gets the class id of the text size measurement system.

Returns
ClassID
virtual int16 IUnitOfMeasureSettings::GetTextSizeUnitOfMeasureIndex ()
pure virtual

Gets the index of the text size unit of measure (measurement systems are service provider based). Useful as the parameter in a call to IUnitOfMeasure->QueryUnitOfMeasure(index).

Returns
int16
virtual ClassID IUnitOfMeasureSettings::GetTextUnitOfMeasure () const
pure virtual

NOTE: This measurement system is used in J feature set only, see GetTextSizeUnitOfMeasure. Gets the class id of the text measurement system.

Returns
ClassID
virtual int16 IUnitOfMeasureSettings::GetTextUnitOfMeasureIndex ()
pure virtual

NOTE: This measurement system is used in J feature set only, see GetTextUnitOfMeasureIndex. Gets the index of the text unit of measure (measurement systems are service provider based). Useful as the parameter in a call to IUnitOfMeasure->QueryUnitOfMeasure(index).

Returns
int16
virtual PMReal IUnitOfMeasureSettings::GetVertCustomPoints () const
pure virtual

Returns the value to use for vertical rulers when using kRulerCustomMSBoss.

Parameters
PMReal
virtual ClassID IUnitOfMeasureSettings::GetXUnitOfMeasure () const
pure virtual

Gets the class id of the x measurement system.

Returns
ClassID
virtual int16 IUnitOfMeasureSettings::GetXUnitOfMeasureIndex ()
pure virtual

Gets the index of the x unit of measure (measurement systems are service provider based). Useful as the parameter in a call to IUnitOfMeasure->QueryUnitOfMeasure(index).

Returns
int16
virtual ClassID IUnitOfMeasureSettings::GetYUnitOfMeasure () const
pure virtual

Gets the class id of the y measurement system.

Returns
ClassID
virtual int16 IUnitOfMeasureSettings::GetYUnitOfMeasureIndex ()
pure virtual

Gets the index of the y unit of measure (measurement systems are service provider based). Useful as the parameter in a call to IUnitOfMeasure->QueryUnitOfMeasure(index).

Returns
int16
virtual void IUnitOfMeasureSettings::Init (const ClassID & xBossId,
const ClassID & yBossId,
const ClassID & textBossId,
const ClassID & textSizeBossId,
const ClassID & printUnitsBossId,
const ClassID & lineUnitsBossId,
const PMReal customHPoints = 12.0,
const PMReal customVPoints = 12.0,
const PMReal keyNudgeIncPts = 1.0,
const PMReal pointsPerInch = 72.0 
)
pure virtual

Sets the class id of all the measurement systems. Used at new document time.

Parameters
bossId- the classID of the measurement system. e.g. kPointsBoss, kMillimetersBoss, etc.
virtual void IUnitOfMeasureSettings::SetHorzCustomPoints (const PMReal customPoints)
pure virtual

Sets the value to use for horizontal rulers when using kRulerCustomMSBoss. Typically user would set to value of leading grid on the page. Determines where major tickmarks are drawn.

Parameters
PMReal- Value in points to use for kRulerCustomMSBoss.
virtual void IUnitOfMeasureSettings::SetKeyNudgeInc (const PMReal keyNudgeIncPts)
pure virtual

Sets the amount for keyboard nudging for various action IDs (e.g. kNudgeUpActionID).

Parameters
PMReal- Value in points to use when nudging objects.
virtual void IUnitOfMeasureSettings::SetLineUnitOfMeasure (const ClassID & bossId)
pure virtual

Sets the class id of the line weight measurement system. Used by stroke weight menus and edit boxes (LineWtMeasureEditBoxWidget)

Parameters
bossId- the classID of the measurement system. e.g. kPointsBoss
virtual void IUnitOfMeasureSettings::SetPointsPerInch (const PMReal pointsPerInch)
pure virtual

Sets the value to use for points-based custom points per inch. Typically this is 72.0, but may vary between kMinPointsPerInch and kMaxPointsPerInch.

Parameters
PMReal- Value in points to use for kPointsBoss, kPicasBoss, and kRulerCustomMSBoss.
virtual void IUnitOfMeasureSettings::SetPrintUnitOfMeasure (const ClassID & bossId)
pure virtual

NOTE: This measurement system is UNUSED. Sets the class id of the print measurement system. Used by bleed setting for Print dialog?

Parameters
bossId- the classID of the measurement system. e.g. kPointsBoss, kMillimetersBoss
virtual void IUnitOfMeasureSettings::SetTextSizeUnitOfMeasure (const ClassID & bossId)
pure virtual

Sets the class id of the text size measurement system. Used by text size measurement menus (TextSizeMeasureEditBoxWidget).

Parameters
bossId- the classID of the measurement system. e.g. kPointsBoss, kQBoss
virtual void IUnitOfMeasureSettings::SetTextUnitOfMeasure (const ClassID & bossId)
pure virtual

NOTE: This measurement system is used in J feature set only, see SetTextSizeUnitOfMeasure. Sets the class id of the text measurement system. Used by text measurement editboxes (TextMeasureEditBoxWidget).

Parameters
bossId- the classID of the measurement system. e.g. kPointsBoss
virtual void IUnitOfMeasureSettings::SetVertCustomPoints (const PMReal customPoints)
pure virtual

Sets the value to use for vertical rulers when using kRulerCustomMSBoss. Typically user would set to value of leading grid on the page. Determines where major tickmarks are drawn.

Parameters
PMReal- Value in points to use for kRulerCustomMSBoss.
virtual void IUnitOfMeasureSettings::SetXUnitOfMeasure (const ClassID & bossId)
pure virtual

Sets the class id of the x measurement system. Used by horizontal rulers and horizontal measurement editboxes (XMeasureEditBoxWidget).

Parameters
bossId- the classID of the measurement system. e.g. kPointsBoss, kMillimetersBoss
virtual void IUnitOfMeasureSettings::SetYUnitOfMeasure (const ClassID & bossId)
pure virtual

Returns the class id of the y measurement system. Used by vertical rulers and vertical measurement editboxes (YMeasureEditBoxWidget).

Parameters
bossId- the classID of the measurement system. e.g. kPointsBoss, kMillimetersBoss