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

#include <IDataStringUtils.h>

Inheritance diagram for IDataStringUtils:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IDATASTRINGUTILS }
 

Public Member Functions

virtual int32 StringToInt32 (const WideString &source)=0
 
virtual void Int32ToString (int32 intValue, WideString *target)=0
 
virtual int16 StringToInt16 (const WideString &source)=0
 
virtual void Int16ToString (int16 intValue, WideString *target)=0
 
virtual bool16 StringToBool16 (const WideString &source)=0
 
virtual void Bool16ToString (bool16 boolValue, WideString *target)=0
 
virtual PMReal StringToPMReal (const WideString &source)=0
 
PMReal StringToPMReal (const UTF16TextChar *source)
 
virtual void PMRealToString (const PMReal &realValue, WideString *target)=0
 
virtual PMReal StringToPMReal (const WideString &source, int32 precision)=0
 
PMReal StringToPMReal (const UTF16TextChar *source, int32 precision)
 
virtual void PMRealToString (const PMReal &realValue, WideString *target, int32 precision)=0
 
virtual PMPoint StringToPMPoint (const WideString &source)=0
 
virtual void PMPointToString (const PMPoint &pointVal, WideString *target)=0
 
virtual PMPoint StringToPMPoint (const WideString &source, int32 precision)=0
 
virtual void PMPointToString (const PMPoint &pointVal, WideString *target, int32 precision)=0
 
virtual PMRect StringToPMRect (const WideString &source)=0
 
virtual void PMRectToString (const PMRect &rectVal, WideString *target)=0
 
virtual PMRect StringToPMRect (const WideString &source, int32 precision)=0
 
virtual void PMRectToString (const PMRect &rectVal, WideString *target, int32 precision)=0
 
virtual void PMRealToStringWithFixedPrecision (const PMReal &realValue, WideString *target, int32 precision)=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

A utility class for converting between WideStrings and a variety of values, used primarily by the old InCopy incd file format methods. Developers should not use these methods unless they are implementing their own incd file format extensions. All implementations currently copy to/from std::string and stream the values in and out.

Member Function Documentation

virtual void IDataStringUtils::Bool16ToString (bool16 boolValue,
WideStringtarget 
)
pure virtual

Bool16ToString converts a bool16 into a string

Parameters
boolValue- The boolean value
target- The string to convert into.
virtual void IDataStringUtils::Int16ToString (int16 intValue,
WideStringtarget 
)
pure virtual

Int16ToString converts a short integer into a string.

Parameters
intValue- The short integer to write to the string.
target- The string to hold the converted integer.
virtual void IDataStringUtils::Int32ToString (int32 intValue,
WideStringtarget 
)
pure virtual

Int32ToString converts an integer into a string

Parameters
intValue- The value to convert to a string.
target- The string containing the aforementioned integer value.
virtual void IDataStringUtils::PMPointToString (const PMPointpointVal,
WideStringtarget 
)
pure virtual

PMPointToString converts a PMPoint into an alpha numeric hexadecimal value string.

Parameters
pointVal- The PMPoint to convert
target- The string to convert into.
virtual void IDataStringUtils::PMPointToString (const PMPointpointVal,
WideStringtarget,
int32 precision 
)
pure virtual

PMPointToString converts a PMPoint into a scientific notation based string.

Parameters
pointVal- The point to convert.
target- The string to convert into.
precision- The number of digits of precision desired.
virtual void IDataStringUtils::PMRealToString (const PMRealrealValue,
WideStringtarget 
)
pure virtual

PMRealToString converts a PMReal into a alpha numeric hexadecimal string.

Parameters
realValue- The PMReal to convert.
target- The string to copy the hex into.
virtual void IDataStringUtils::PMRealToString (const PMRealrealValue,
WideStringtarget,
int32 precision 
)
pure virtual

PMRealToString converts a PMReal into a real number in scientific notation.

Parameters
realValue- The PMReal to convert to a string.
target- The WideString to copy into.
precision- The number of digits of precision desired.
virtual void IDataStringUtils::PMRealToStringWithFixedPrecision (const PMRealrealValue,
WideStringtarget,
int32 precision 
)
pure virtual

PMRealToString converts a PMReal into a real number in scientific notation.

Parameters
realValue- The PMReal to convert to a string.
target- The WideString to copy into.
precision- The number of digits of precision desired.
virtual void IDataStringUtils::PMRectToString (const PMRectrectVal,
WideStringtarget 
)
pure virtual

PMRectToString converts a PMRect into a hexidecimal string.

Parameters
rectVal- The rectangle to convert.
target- The string to convert into.
virtual void IDataStringUtils::PMRectToString (const PMRectrectVal,
WideStringtarget,
int32 precision 
)
pure virtual

PMRectToString converts a PMRect into a hexidecimal based string.

Parameters
rectVal- The rectangle to convert.
target- The string to convert into.
precision- The number of digits of precision desired.
virtual bool16 IDataStringUtils::StringToBool16 (const WideStringsource)
pure virtual

StringToBool16 converts a string into a bool16.

Parameters
source- The string to convert.
Returns
- The bool16 result.
virtual int16 IDataStringUtils::StringToInt16 (const WideStringsource)
pure virtual

StringToInt16 converts a string to a short integer.

Parameters
source- The string containing an integer value.
Returns
- The int16 of the same value.
virtual int32 IDataStringUtils::StringToInt32 (const WideStringsource)
pure virtual

StringToInt32 converts a string to an integer.

Parameters
source- The string containing an integer value.
Returns
- The int32 of the same value.
virtual PMPoint IDataStringUtils::StringToPMPoint (const WideStringsource)
pure virtual

StringToPMPoint converts an alpha numeric hexadecimal value string to a PMPoint .

Parameters
source- The WideString to convert.
Returns
- The PMPoint from the string.
virtual PMPoint IDataStringUtils::StringToPMPoint (const WideStringsource,
int32 precision 
)
pure virtual

StringToPMPoint converts a scientific notation format string into a PMPoint.

Parameters
source- The WideString to convert.
precision- The number of digits of precision desired.
Returns
- The PMPoint structure.
virtual PMReal IDataStringUtils::StringToPMReal (const WideStringsource)
pure virtual

StringToPMReal converts a hex string to a PMReal.

Parameters
source- The string as a WideString.
Returns
- The PMReal from the string.
PMReal IDataStringUtils::StringToPMReal (const UTF16TextChar * source)
inline

StringToPMReal converts a hex UTF16 string pointer into a PMReal.

Parameters
source- The UTF16 string pointer
Returns
- The PMReal from the string.
virtual PMReal IDataStringUtils::StringToPMReal (const WideStringsource,
int32 precision 
)
pure virtual

StringToPMReal converts a scientific notation string to a PMReal.

Parameters
source- The WideString to convert.
precision- The number of digits of precision desired.
Returns
- The PMReal from the string.
PMReal IDataStringUtils::StringToPMReal (const UTF16TextChar * source,
int32 precision 
)
inline

StringToPMReal converts a scientific notation string pointer to a PMReal.

Parameters
source- The UTF16 string pointer contains a scientific notation real number string.
precision- The number of digits of precision desired.
Returns
- The PMReal from the string.
virtual PMRect IDataStringUtils::StringToPMRect (const WideStringsource)
pure virtual

StringToPMRect converts a hexidecimal based string into a PMRect.

Parameters
source- The string to convert.
Returns
- The resulting PMRect structure.
virtual PMRect IDataStringUtils::StringToPMRect (const WideStringsource,
int32 precision 
)
pure virtual

StringToPMRect converts a scientific notation based string into a PMRect.

Parameters
source- The string to convert.
precision- The number of digits of precision involved.
Returns
- The resulting PMRect structure.