InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Points Class Reference
Inheritance diagram for Points:
CUnitOfMeasureIUnitOfMeasureIPMUnknown

Public Member Functions

 Points (IPMUnknown *boss)
 
virtual PMReal UnitsToPoints (const PMReal &units) const
 
virtual PMReal PointsToUnits (const PMReal &points) const
 
virtual void GetName (PMString *pName)
 
virtual void Format (const PMReal &units, PMString &str, PMString *fractionalPortionString) const
 
virtual bool16 Parse (const PMString &str, PMReal &points, const bool16 alwaysUseEnglishAbbreviations)
 
virtual RsrcSpec GetRulerSpecRsrcSpec () const
 
virtual IUnitOfMeasure::UnitFlags GetUnitFlags () const
 
virtual ScriptID GetScriptID (const ScriptInfo::RequestContext &) const
 
- Public Member Functions inherited from CUnitOfMeasure
 CUnitOfMeasure (IPMUnknown *boss)
 
virtual PMReal GetSmallIncrement () const
 
virtual PMReal GetLargeIncrement () const
 

Additional Inherited Members

- Public Types inherited from IUnitOfMeasure
enum  UnitFlags {
  kUnitIsXMeasure = 0x0001, kUnitIsYMeasure = 0x0002, kUnitIsTextMeasure = 0x0004, kUnitIsTextSizeMeasure = 0x0008,
  kUnitIsPrintMeasure = 0x0010, kUnitIsLineMeasure = 0x0020
}
 
- Protected Member Functions inherited from CUnitOfMeasure
virtual bool16 EvaluateRemoveLeadingNumber (PMString *strInOut, PMReal *numOut, bool16 *isNegOut=nil)
 
virtual void FormatFractionalPortion (PMReal units, PMString *outStr, int32 nDecimalPlaces=3, bool16 bStripTrailingZeros=kTrue) const
 

Member Function Documentation

virtual void Points::Format (const PMRealunits,
PMStringstr,
PMStringfractionalPortionString 
) const
virtual

Format a value in this unit as a string

Implements IUnitOfMeasure.

virtual void Points::GetName (PMStringpName)
virtual

Return the name of this unit

Implements IUnitOfMeasure.

virtual RsrcSpec Points::GetRulerSpecRsrcSpec () const
virtual

Get the ruler spec for this unit

Implements IUnitOfMeasure.

virtual ScriptID Points::GetScriptID (const ScriptInfo::RequestContextcontext) const
inlinevirtual

Returns the ScriptID associated with this unit of measure in the given scripting DOM

Implements IUnitOfMeasure.

virtual IUnitOfMeasure::UnitFlags Points::GetUnitFlags () const
virtual

Get the unit flags for this unit

Reimplemented from CUnitOfMeasure.

virtual bool16 Points::Parse (const PMStringstr,
PMRealpoints,
const bool16 alwaysUseEnglishAbbreviations 
)
virtual

Parse a string like "1 in" into points. str IN, the string to be parsed

Parameters
pointsOUT, the resulting points alwaysUseEnglishAbbreviations IN, whether to always use the English abbreviations for units such as "in". If false then the translation of the string in the current locale is used.
Returns
bool16, Whether the parsing succeeded.

Implements IUnitOfMeasure.

virtual PMReal Points::PointsToUnits (const PMRealpoints) const
virtual

Convert a value in points to this unit

Implements IUnitOfMeasure.

virtual PMReal Points::UnitsToPoints (const PMRealunits) const
virtual

Convert a value in this unit to points

Implements IUnitOfMeasure.