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

#include <IDateConverter.h>

Inheritance diagram for IDateConverter:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IDATECONVERTER }
 

Public Member Functions

virtual void GetStyleName (PMString &styleName) const =0
 
void GetStyleNameBase (PMString &styleName) const
 
virtual bool16 IncludeStyleChoiceInUI () const =0
 
virtual void Convert (const GlobalTime &datetime, 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 type GlobalTime (dates & times)

Member Function Documentation

virtual void IDateConverter::Convert (const GlobalTimedatetime,
PMStringoutput 
) const
pure virtual

Converts the input time into an output string.

Parameters
INdatetime specifies the datetime to be converted
INOUTon input it's the specification for the date (e.g. m/d/y), on output stores the string representation of the date (e.g. 4/21/77).
virtual void IDateConverter::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 IDateConverter::GetStyleNameBase (PMStringstyleName) const
inline
See Also
GetStyleName
virtual bool16 IDateConverter::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.