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

#include <IStringConverter.h>

Inheritance diagram for IStringConverter:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISTRINGCONVERTER }
 

Public Member Functions

virtual void GetStyleName (PMString &styleName) const =0
 
void GetStyleNameBase (PMString &styleName) const
 
virtual bool16 IncludeStyleChoiceInUI () const =0
 
virtual void Convert (const PMString &Object, PMString &output) 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 converting/manipulating strings.

Member Function Documentation

virtual void IStringConverter::Convert (const PMStringObject,
PMStringoutput 
) const
pure virtual

Manipulates the input string returning the output string.

Parameters
INstring specifies the string to be converted
OUTstring stores the string representation of the string.
virtual void IStringConverter::GetStyleName (PMStringstyleName) const
pure virtual

Returns the name of the style to be used in the UI

Parameters
OUTstyleName stores the returned name of the style.
void IStringConverter::GetStyleNameBase (PMStringstyleName) const
inline
See Also
GetStyleName
virtual bool16 IStringConverter::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.