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

#include <ISysFileListData.h>

Inheritance diagram for ISysFileListData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISYSFILELISTDATA }
 

Public Member Functions

virtual void Append (const IDFile &theFile)=0
 
virtual IDFile GetSysFileItem (int32 i) const =0
 
virtual int32 Length ()=0
 
virtual void Clear ()=0
 
virtual void SortListByFilename ()=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

Container interface used to hold a list of file objects.

See Also
IDFile

Member Function Documentation

virtual void ISysFileListData::Append (const IDFiletheFile)
pure virtual

Appends a file to the list.

Parameters
theFileIN File to append to the list.
virtual void ISysFileListData::Clear ()
pure virtual

Removes all the files from the list.

virtual IDFile ISysFileListData::GetSysFileItem (int32 i) const
pure virtual

Returns the n'th file in the list.

Parameters
iIN Index of the file to return from the list.
Returns
The n'th file in the list.
virtual int32 ISysFileListData::Length ()
pure virtual

Returns the number of files in the list.

Returns
Number of files in the list.
virtual void ISysFileListData::SortListByFilename ()
pure virtual

Sorts the list alphabetically by filename(case insensitive)