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

#include <IMeasureUnitsCmdData.h>

Inheritance diagram for IMeasureUnitsCmdData:
IPMUnknown

Public Member Functions

virtual void Set (const UIDRef &doc, const ClassID hMeasureUnits, const ClassID vMeasureUnits, const ClassID textMeasureUnits=kInvalidClass, const ClassID textSizeMeasureUnits=kInvalidClass, const ClassID printMeasureUnits=kInvalidClass, const ClassID lineMeasureUnits=kInvalidClass, const PMReal customHPoints=-1, const PMReal customVPoints=-1, const PMReal keyNudgeInc=-1, const PMReal pointsPerInch=-1)=0
 
virtual const UIDRefGetDocument () const =0
 
virtual const ClassID GetHMeasureUnits () const =0
 
virtual const ClassID GetVMeasureUnits () const =0
 
virtual const ClassID GetTextMeasureUnits () const =0
 
virtual const ClassID GetTextSizeMeasureUnits () const =0
 
virtual const ClassID GetPrintMeasureUnits () const =0
 
virtual const ClassID GetLineMeasureUnits () const =0
 
virtual const PMReal GetHorzCustomPoints () const =0
 
virtual const PMReal GetVertCustomPoints () const =0
 
virtual const PMReal GetKeyNudgeInc () const =0
 
virtual const PMReal GetPointsPerInch () const =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

IMeasureUnitsCmdData is the data interface for the measure units command.

Member Function Documentation

virtual const UIDRef& IMeasureUnitsCmdData::GetDocument () const
pure virtual

Returns the document to affect.

virtual const ClassID IMeasureUnitsCmdData::GetHMeasureUnits () const
pure virtual

Returns the horizontal units.

virtual const PMReal IMeasureUnitsCmdData::GetHorzCustomPoints () const
pure virtual

Returns the custom points for horizontal ruler.

virtual const PMReal IMeasureUnitsCmdData::GetKeyNudgeInc () const
pure virtual

Returns the keyboard nudge increment.

virtual const ClassID IMeasureUnitsCmdData::GetLineMeasureUnits () const
pure virtual

Returns the line units.

virtual const PMReal IMeasureUnitsCmdData::GetPointsPerInch () const
pure virtual

Returns the Points per inch value.

virtual const ClassID IMeasureUnitsCmdData::GetPrintMeasureUnits () const
pure virtual

Returns the printer dialog units.

virtual const ClassID IMeasureUnitsCmdData::GetTextMeasureUnits () const
pure virtual

Returns the text distance units.

virtual const ClassID IMeasureUnitsCmdData::GetTextSizeMeasureUnits () const
pure virtual

Returns the text size units.

virtual const PMReal IMeasureUnitsCmdData::GetVertCustomPoints () const
pure virtual

Returns the custom points for vertical ruler.

virtual const ClassID IMeasureUnitsCmdData::GetVMeasureUnits () const
pure virtual

Returns the vertical units.

virtual void IMeasureUnitsCmdData::Set (const UIDRefdoc,
const ClassID hMeasureUnits,
const ClassID vMeasureUnits,
const ClassID textMeasureUnits = kInvalidClass,
const ClassID textSizeMeasureUnits = kInvalidClass,
const ClassID printMeasureUnits = kInvalidClass,
const ClassID lineMeasureUnits = kInvalidClass,
const PMReal customHPoints = -1,
const PMReal customVPoints = -1,
const PMReal keyNudgeInc = -1,
const PMReal pointsPerInch = -1 
)
pure virtual

Set the measure units command, command data.

Parameters
docwhich document to affect
hMeasureUnitshorizontal units to use for measurement system. kInvalidClass to leave unchanged
vMeasureUnitsvertical units to use for measurement system. kInvalidClass to leave unchanged
textMeasureUnitstext distance units to use for measurement system. kInvalidClass to leave unchanged, UNUSED
textSizeMeasureUnitstext size units to use for measurement system. kInvalidClass to leave unchanged
printMeasureUnitsprinter dialog units to use for measurement system. kInvalidClass to leave unchanged, UNUSED
lineMeasureUnitsline units to use for measurement system. kInvalidClass to leave unchanged
customHPointscustom points for horz ruler. -1 to leave unchanged.
customVPointscustom points for vert ruler. -1 to leave unchanged.
keyNudgeInckeyboard nudge increment. -1 to leave unchanged.
pointsPerInchPoints per inch value. Typically 72.0. Use -1 to leave unchanged. Only used for points and picas measurement systems