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

#include <IFormatType.h>

Inheritance diagram for IFormatType:
IPMUnknown

Public Member Functions

virtual void ReadWrite (IPMStream *iPMStream, ImplementationID id)=0
 
virtual void SetFormatType (SysOSType type, SysOSType creator, PMString &basename)=0
 
virtual SysOSType GetSysOSType ()=0
 
virtual SysOSType GetSysOSCreator ()=0
 
virtual void GetExtension (PMString &extension)=0
 
virtual void GetBaseName (PMString &basename)=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

Used to indicate the format of a given file

Member Function Documentation

virtual void IFormatType::GetBaseName (PMStringbasename)
pure virtual

Use to get the basename of this file

Parameters
basename- [OUT] The file name
virtual void IFormatType::GetExtension (PMStringextension)
pure virtual

Use to get the extension of this file

Parameters
extension- [OUT] The file extension
virtual SysOSType IFormatType::GetSysOSCreator ()
pure virtual

Use to get the creator of this file

Returns
- The creator of the object
virtual SysOSType IFormatType::GetSysOSType ()
pure virtual

Use to get the type of this file

Returns
- The type of the object
virtual void IFormatType::ReadWrite (IPMStreamiPMStream,
ImplementationID id 
)
pure virtual

Use this method to persist the data in this class to a stream or get the data out of a stream

Parameters
*iPMStream- The stream containing or receiving the data
id- Implementation ID
virtual void IFormatType::SetFormatType (SysOSType type,
SysOSType creator,
PMStringbasename 
)
pure virtual

Use this to setup the format type information for this class

Parameters
type- the filetype
creator- The creator
basename- The shortname that identifies the file