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

#include <INumberConverter.h>

Inheritance diagram for INumberConverter:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_INUMBERCONVERTER }
 

Public Member Functions

void GetStyleName (PMString &styleName) const
 
void GetStyleNameBase (PMString &styleName) const
 
virtual bool16 IncludeStyleChoiceInUI () const =0
 
void Convert (const int32 &number, PMString &numString) const
 
virtual void GetNumberingStyleName (PMString &styleName) const =0
 
virtual void NumberToString (int32 number, PMString &numString) 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

IServiceConverter for type int32 (number converter)

Member Function Documentation

void INumberConverter::Convert (const int32 & number,
PMStringnumString 
) const
inline
virtual void INumberConverter::GetNumberingStyleName (PMStringstyleName) const
pure virtual

Returns the name of the style to be used in the UI (e.g. "1, 2, 3, 4...", "a, b, c, d..." etc.)

Parameters
OUTstyleName stores the returned name of the style.
void INumberConverter::GetStyleName (PMStringstyleName) const
inline
void INumberConverter::GetStyleNameBase (PMStringstyleName) const
inline
See Also
GetStyleName
virtual bool16 INumberConverter::IncludeStyleChoiceInUI () const
pure virtual

Returns whether this style can be included in the UI or not. This can be used to exclude locale-specific string styles from the UI, but to still have the conversion service available to draw if the user opens a document that was created in a different locale.

Returns
kTrue if the style can be included in the UI, kFalse otherwise.
virtual void INumberConverter::NumberToString (int32 number,
PMStringnumString 
) const
pure virtual

Returns the string representation of the input number in the style implemented by this number converter.

Parameters
INnumber specifies the number to be converted
OUTpNumString stores the string representation of the number.