StDir Class Reference

Allow operations on local files. More...

#include <stdir.h>

Inheritance diagram for StDir:

StTemp List of all members.

Public Member Functions

 StDir ()
 StDir (const StString &path)
 StDir (const char *path)
void setPath (const StString &path)
StString getPath () const
StPermission getPermissions () const
bool exists () const
bool isDirectory () const
bool create (const StString &str="", bool resursively=false)
StValueList< StFileread () const
void operator= (const StString &path)
void operator= (const char *path)
 operator StString () const

Protected Attributes

StString path

Detailed Description

Allow operations on local files.

Enable the creation of directories, get their permissions, and check if the path exists, and whether or not it is a directory.


Constructor & Destructor Documentation

StDir::StDir (  )  [inline]

StDir::StDir ( const StString path  )  [inline]

StDir::StDir ( const char *  path  )  [inline]


Member Function Documentation

bool StDir::create ( const StString str = "",
bool  resursively = false 
)

Create the directory

Parameters:
str - directory to create
resursively - if directory should by created recursively
Returns:
True if the directory has created.

bool StDir::exists (  )  const

Check if the current path exist

StString StDir::getPath (  )  const [inline]

Get the current path

StPermission StDir::getPermissions (  )  const [inline]

Get the current file permissions.

Returns:
StPermission class represents file permission.

bool StDir::isDirectory (  )  const

Check if the current path is a directory

StDir::operator StString (  )  const [inline]

Converting StDir class to StString class

void StDir::operator= ( const char *  path  )  [inline]

Set the current path to this which is passed in argument

void StDir::operator= ( const StString path  )  [inline]

Set the current path to this which is passed in argument

StValueList< StFile > StDir::read (  )  const

Get the list of files in current directory

Returns:
StValueList containing files in current directory

void StDir::setPath ( const StString path  )  [inline]

Set the current path


Member Data Documentation

StString StDir::path [protected]


The documentation for this class was generated from the following files:
Generated on Tue Nov 14 21:15:09 2006 for Smart Tools Library by  doxygen 1.4.7