Facade::IRecentFileListFacade Class Reference

Inheritance diagram for Facade::IRecentFileListFacade:

Public Types
enum	{ kDefaultIID = IID_IRECENTFILELISTFACADE }
enum	{ kInvalidResult = -1 }

Public Member Functions
virtual int32	GetFileMax () const =0
virtual ErrorCode	SetFileMax (int32 newDocCount) const =0
virtual int32	GetFileCount () const =0
virtual const IDFile *	GetNthFile (int32 n) const =0
virtual const PMString *	GetNthPathName (int32 n) const =0
virtual ErrorCode	AddFile (const IDFile *addThis) const =0
virtual ErrorCode	RemoveFile (const IDFile *removeThis) const =0
virtual bool16	SystemPolicyProhibitsList () const =0
virtual void	GetNthFileInfo (int32 n, IRecentFileInfo::FileInfo &fileInfo) const =0
virtual ErrorCode	SetNthFileThumbnailInfo (int32 n, const std::string &encodedThumbnail, const std::string &format, int32 thumbnailWidth, int32 thumbnailHeight) 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

Public Attributes
enum Facade::IRecentFileListFacade:: { ... }	FileListError

Member Function Documentation

virtual ErrorCode Facade::IRecentFileListFacade::AddFile ( const IDFile *  addThis ) const

pure virtual

Adds a document file to the list.

Parameters

addThis

IN Document file to add to the list.

Returns

ErrorCode

virtual int32 Facade::IRecentFileListFacade::GetFileCount ( ) const

pure virtual

Returns the number of document files in the list.

Returns

Number of document files in the list.

virtual int32 Facade::IRecentFileListFacade::GetFileMax ( ) const

pure virtual

Returns the maximum number of document files the list can hold.

Returns

Maximum number of document files the list can hold.

virtual const IDFile* Facade::IRecentFileListFacade::GetNthFile ( int32  n ) const

pure virtual

Returns the n'th document file in the list.

Parameters

n	IN Index of the document file to return from the list.

Returns

Pointer to the n'th document file in the list.

virtual void Facade::IRecentFileListFacade::GetNthFileInfo ( int32  n, IRecentFileInfo::FileInfo &  fileInfo  ) const

pure virtual

Returns the info of the n'th document file in the list.

Parameters

n	IN Index of the document file to return from the list.
fileInfo	OUT Document file info.

virtual const PMString* Facade::IRecentFileListFacade::GetNthPathName ( int32  n ) const

pure virtual

Returns the n'th document file in the list as a path string.

Parameters

n	IN Index of the document file whose path to return from the list.

Returns

Pointer to the n'th document file's path string.\ On the Mac, the returned path is an HFS/POSIX path.

virtual ErrorCode Facade::IRecentFileListFacade::RemoveFile ( const IDFile *  removeThis ) const

pure virtual

Removes the document file matching the given file from the list.

Parameters

removeThis

IN Matching document file to remove from the list.

Returns

ErrorCode

virtual ErrorCode Facade::IRecentFileListFacade::SetFileMax ( int32  newDocCount ) const

pure virtual

Sets the number of document files to keep track of.

Parameters

newDocCount

IN Number of document files to keep track of.

Returns

ErrorCode

virtual ErrorCode Facade::IRecentFileListFacade::SetNthFileThumbnailInfo ( int32  n, const std::string &  encodedThumbnail, const std::string &  format, int32  thumbnailWidth, int32  thumbnailHeight  ) const

pure virtual

Sets the thumbnail info of the n'th document file in the list.

Parameters

n	IN Index of the document file to return from the list.
encodedThumbnail	IN Document file thumbnail.
format	IN Document file thumbnail format.
thumbnailWidth	IN Document file thumbnail width.
thumbnailHeight	IN Document file thumbnail height.

virtual bool16 Facade::IRecentFileListFacade::SystemPolicyProhibitsList ( ) const

pure virtual

Does the system policy prohibit a MRU list.

Returns

true or false