IFileList Class Reference

#include <IFileList.h>

Inheritance diagram for IFileList:

Public Member Functions
virtual int32	GetFileMax () const =0
virtual void	SetFileMax (int32 newDocCount)=0
virtual int32	GetFileCount () const =0
virtual const IDFile *	GetNthFile (int32 n)=0
virtual const PMString *	GetNthPathName (int32 n)=0
virtual void	AddFile (const IDFile *addThis)=0
virtual void	RemoveFile (const IDFile *removeThis)=0
virtual bool16	SystemPolicyProhibitsList (void)=0
virtual void	CleanList ()=0
virtual const IDFile *	GetNthFileIntConst (int32 n) const =0
virtual bool	IsFileCloudFile (int32 n) 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

Deprecated:

This Interface is deprecated. Please use IRecentFileListFacade instead.

See Also

IRecentFileListFacade Interface used to maintain a list of the most recently used document files.

IDFile

Member Function Documentation

virtual void IFileList::AddFile ( const IDFile *  addThis )

pure virtual

Adds a document file to the list.

Parameters

addThis

IN Document file to add to the list.

virtual int32 IFileList::GetFileCount ( ) const

pure virtual

Returns the number of document files in the list.

Returns

Number of document files in the list.

virtual int32 IFileList::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* IFileList::GetNthFile ( int32  n )

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 const PMString* IFileList::GetNthPathName ( int32  n )

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 bool IFileList::IsFileCloudFile ( int32  n ) const

pure virtual

Checks if the index n is a cloud file or not

Parameters

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

Returns

kTrue if the nth file is a cloud file.

virtual void IFileList::RemoveFile ( const IDFile *  removeThis )

pure virtual

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

Parameters

removeThis

IN Matching document file to remove from the list.

virtual void IFileList::SetFileMax ( int32  newDocCount )

pure virtual

Sets the number of document files to keep track of.

Parameters

newDocCount

IN Number of document files to keep track of.

virtual bool16 IFileList::SystemPolicyProhibitsList ( void  )

pure virtual

Does the system policy prohibit a MRU list.

Returns

true or false