HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
HDK_Sample::FS_HomeInfoHelper Class Reference

Class to stat a file. The class tests for a "home:" prefix and replaces it with $HOME. More...

#include <FS_HomeHelper.h>

+ Inheritance diagram for HDK_Sample::FS_HomeInfoHelper:

Public Member Functions

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

Detailed Description

Class to stat a file. The class tests for a "home:" prefix and replaces it with $HOME.

Examples:
FS/FS_HomeHelper.C.

Definition at line 93 of file FS_HomeHelper.h.

Constructor & Destructor Documentation

FS_HomeInfoHelper::FS_HomeInfoHelper ( )
Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 465 of file FS_HomeHelper.C.

FS_HomeInfoHelper::~FS_HomeInfoHelper ( )
virtual
Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 470 of file FS_HomeHelper.C.

Member Function Documentation

bool FS_HomeInfoHelper::canHandle ( const char *  source)
virtual

Determine whether this helper can process the filename.

Implements FS_InfoHelper.

Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 475 of file FS_HomeHelper.C.

bool FS_HomeInfoHelper::getContents ( const char *  source,
UT_StringArray contents,
UT_StringArray dirs 
)
virtual

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.

Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 569 of file FS_HomeHelper.C.

UT_String FS_HomeInfoHelper::getExtension ( const char *  source)
virtual

Reimplemented from FS_InfoHelper.

Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 541 of file FS_HomeHelper.C.

bool FS_HomeInfoHelper::getIsDirectory ( const char *  source)
virtual

Return whether the filename is a directory.

Implements FS_InfoHelper.

Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 496 of file FS_HomeHelper.C.

int FS_HomeInfoHelper::getModTime ( const char *  source)
virtual

Get the modification timestamp (returns time_t)

Implements FS_InfoHelper.

Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 511 of file FS_HomeHelper.C.

int64 FS_HomeInfoHelper::getSize ( const char *  source)
virtual

Get the file size in bytes.

Implements FS_InfoHelper.

Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 526 of file FS_HomeHelper.C.

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

Implements FS_InfoHelper.

Examples:
FS/FS_HomeHelper.C, and FS/FS_HomeHelper.h.

Definition at line 481 of file FS_HomeHelper.C.


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