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

Public Member Functions

 CstUni (IPMUnknown *boss)
 
virtual ~CstUni ()
 
virtual PMReal UnitsToPoints (const PMReal &units) const
 
virtual PMReal PointsToUnits (const PMReal &points) const
 
virtual PMReal GetSmallIncrement () const
 
virtual PMReal GetLargeIncrement () 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)
 

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
 

Detailed Description

CstUni Methods provide for the conversion between the points and the custom units, formatting and tokenization, the ruler resource for the custom units.

Implements IUnitOfMeasure based on the partial implementation of CUnitOfMeasure.

Constructor & Destructor Documentation

CstUni::CstUni (IPMUnknownboss)
inline

Constructor.

Parameters
bossinterface ptr from boss object on which this interface is aggregated.
virtual CstUni::~CstUni ()
inlinevirtual

Destructor.

Member Function Documentation

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

Get the format for the custom units.

Implements IUnitOfMeasure.

PMReal CstUni::GetLargeIncrement () const
virtual

Get the large increment for the ruler of this custom units.

Reimplemented from CUnitOfMeasure.

void CstUni::GetName (PMStringpName)
virtual

Get the name of the custom units.

Implements IUnitOfMeasure.

RsrcSpec CstUni::GetRulerSpecRsrcSpec () const
virtual

Get the ruler resource spec for the custom units.

Implements IUnitOfMeasure.

virtual ScriptID CstUni::GetScriptID (const ScriptInfo::RequestContext) const
inlinevirtual

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

Implements IUnitOfMeasure.

PMReal CstUni::GetSmallIncrement () const
virtual

Get the small increment for the ruler of this custom units.

Reimplemented from CUnitOfMeasure.

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

Get the unit flag which this unit will be used in UI.

See Also
IUnitOfMeasure for definition of each flag.

Reimplemented from CUnitOfMeasure.

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

Parse the string and convert it to the points.

Implements IUnitOfMeasure.

PMReal CstUni::PointsToUnits (const PMRealpoints) const
virtual

Convert from points to custom units. For the purpose of this example, assuming that one custom unit is equal to 20 points.

Parameters
pointsthe points.
Returns
the custom units.

Implements IUnitOfMeasure.

Binds the C implementation class onto its ImplementationID making the C code callable by the application *PMReal CstUni::UnitsToPoints (const PMRealunits) const
virtual

Convert from custom units to points. For the purpose of this example, assuming that one custom unit is equal to 20 points.

Parameters
unitsthe custom units.
Returns
the points.

Implements IUnitOfMeasure.