HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
FS_IconInfoHelper Class Reference

#include <FS_IconHelper.h>

+ Inheritance diagram for FS_IconInfoHelper:

Public Member Functions

 FS_IconInfoHelper ()
 
 ~FS_IconInfoHelper () override
 
bool canHandle (const char *source) override
 Determine whether this helper can process the filename. More...
 
bool hasAccess (const char *source, int mode) override
 
bool getIsDirectory (const char *source) override
 Return whether the filename is a directory. More...
 
int getModTime (const char *source) override
 Get the modification timestamp (returns time_t) More...
 
int64 getSize (const char *source) override
 Get the file size in bytes. More...
 
bool getContents (const char *source, UT_StringArray &contents, UT_StringArray *dirs) override
 
char getNextSepChar (const char *source) override
 Next separator character. More...
 
char getPrevSepChar (const char *source) override
 Previous separator character. More...
 
- Public Member Functions inherited from FS_InfoHelper
 FS_InfoHelper ()
 
virtual ~FS_InfoHelper ()
 
virtual UT_String getExtension (const char *source)
 
virtual bool customNavigatePath (UT_String &path, const char *file)
 
virtual bool getPathOnDisk (UT_String &path, const char *file)
 

Detailed Description

Definition at line 29 of file FS_IconHelper.h.

Constructor & Destructor Documentation

FS_IconInfoHelper::FS_IconInfoHelper ( )
FS_IconInfoHelper::~FS_IconInfoHelper ( )
override

Member Function Documentation

bool FS_IconInfoHelper::canHandle ( const char *  source)
overridevirtual

Determine whether this helper can process the filename.

Implements FS_InfoHelper.

bool FS_IconInfoHelper::getContents ( const char *  source,
UT_StringArray contents,
UT_StringArray dirs 
)
overridevirtual

Read the contents of a directory

Parameters
source- The directory to read
contents- The list of files in the directory
dirs- The list of directories in the directory If dirs is NULL, then all directories should be included in the contents.

Implements FS_InfoHelper.

bool FS_IconInfoHelper::getIsDirectory ( const char *  source)
overridevirtual

Return whether the filename is a directory.

Implements FS_InfoHelper.

int FS_IconInfoHelper::getModTime ( const char *  source)
overridevirtual

Get the modification timestamp (returns time_t)

Implements FS_InfoHelper.

char FS_IconInfoHelper::getNextSepChar ( const char *  )
overridevirtual

Next separator character.

Reimplemented from FS_InfoHelper.

char FS_IconInfoHelper::getPrevSepChar ( const char *  )
overridevirtual

Previous separator character.

Reimplemented from FS_InfoHelper.

int64 FS_IconInfoHelper::getSize ( const char *  source)
overridevirtual

Get the file size in bytes.

Implements FS_InfoHelper.

bool FS_IconInfoHelper::hasAccess ( const char *  source,
int  mode 
)
overridevirtual
Parameters
sourceFilename for access check
modeThe read/write/execute status
See Also
FS_FileAccessMode

Implements FS_InfoHelper.


The documentation for this class was generated from the following file: