IInCopyFileInfo Class Reference

#include <IInCopyFileInfo.h>

Inheritance diagram for IInCopyFileInfo:

Public Types
enum	{ kDefaultIID = IID_IINCOPYFILEINFO }
enum	eInCopyFileType {   kTypeInvalid = 0, kTypeInCopyStory, kTypeXML, kTypeInCopyInterchangeTextStory,   kTypeInCopyInterchangeGraphicStory }

Public Member Functions
virtual void	Encoding (IXMLOutStream::eEncodingType encoding)=0
virtual IXMLOutStream::eEncodingType	Encoding () const =0
virtual void	FileType (eInCopyFileType type)=0
virtual eInCopyFileType	FileType () const =0
virtual void	PageRect (const PMPageSize &rect)=0
virtual PMPageSize	PageRect () const =0
virtual void	FileVersion (const PMReal &vers)=0
virtual PMReal	FileVersion () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Represents the information known about the InCopy import file. This interface should be present on any story boss.

Member Enumeration Documentation

enum IInCopyFileInfo::eInCopyFileType

Enumerator
kTypeInCopyInterchangeTextStory	InCopy Interchange text story type
kTypeInCopyInterchangeGraphicStory	InCopy Interchange graphic story type

Member Function Documentation

virtual void IInCopyFileInfo::Encoding ( IXMLOutStream::eEncodingType  encoding )

pure virtual

Specify the encoding used in this file.

Parameters

encoding

The encoding type enumeration.

virtual IXMLOutStream::eEncodingType IInCopyFileInfo::Encoding ( ) const

pure virtual

Return the encoding used in the story's file.

Returns

The encoding type enumeration.

virtual void IInCopyFileInfo::FileType ( eInCopyFileType  type )

pure virtual

Specify the type of the file.

Parameters

type	The file type enumeration.

virtual eInCopyFileType IInCopyFileInfo::FileType ( ) const

pure virtual

Return the type of the story's file.

Returns

The file type enumeration

virtual void IInCopyFileInfo::FileVersion ( const PMReal &  vers )

pure virtual

Specify the version of the InCopy file for importing.

Parameters

vers	The version, 2.0 or 3.0 typically.

virtual PMReal IInCopyFileInfo::FileVersion ( ) const

pure virtual

Return the InCopy file's version number.

Returns

The version. If 0.0, then it was never set.

virtual void IInCopyFileInfo::PageRect ( const PMPageSize &  rect )

pure virtual

Set the page size of the import file.

Parameters

rect	The rectangle of page, initially {0,0,0,0}

virtual PMPageSize IInCopyFileInfo::PageRect ( ) const

pure virtual

Get the page size.

Returns

The page size rectangle.