Script
Public Slots | Public Member Functions | Properties | Private Attributes | List of all members
Dir Class Reference

Interface to operating system Dir operations, ie, mkdir, rmdir, rename, etc. More...

#include <qsUtil.h>

Inheritance diagram for Dir:
Inheritance graph
[legend]
Collaboration diagram for Dir:
Collaboration graph
[legend]

Public Slots

String filePath (String &file=String::null)
 Get file path form current directory from filename give in parameter. More...
 
String absFilePath (String &file=String::null)
 Get absolute file path form filename give in parameter. More...
 
void cd (String &dirName)
 change directory to the given direcotry name More...
 
void cdUp ()
 Go up in directory hierarchy. More...
 
StringList entryList (String &filter, int filterSpec=-1, int sortSpec=-1)
 Returns a list of the names of all the files and directories in the directory, ordered according to the name and attribute filters. More...
 
void mkdir (String &dirName=String::null)
 Create a directory with given name. More...
 
void rmdir (String &dirName=String::null)
 Remove a directory with given name. More...
 
void mkdirs (String &dirName=String::null)
 Create directory recursively if a path of directory not created is given. More...
 
void rmdirs (String &dirName=String::null)
 Remove directory recursively if a path of directory is given. More...
 
void remove (String &fileName)
 Remove a file with the given name. More...
 
void rename (String &oldName, String &newName)
 Rename a file/folder with the name given to the new name. More...
 
bool fileExists (String &fileName)
 Check if the file/folder exist. More...
 
void setCurrent ()
 Sets the application's current working directory to path. More...
 

Public Member Functions

 Dir (String &path)
 
String name ()
 
String path ()
 
void setPath (String &newPath)
 
String absPath ()
 
String canonicalPath ()
 
bool isReadable ()
 
bool exists ()
 

Properties

String name
 Name of the directory. More...
 
String path
 Path of the directory. More...
 
String absPath
 Absolute path of the directory. More...
 
String canonicalPath
 Canonical path of the directory. More...
 
bool readable
 Say if the directory is readable. More...
 
bool exists
 Say if the directory exist. More...
 

Private Attributes

QDir * dir
 

Detailed Description

Interface to operating system Dir operations, ie, mkdir, rmdir, rename, etc.

You can use it in Script Editor only.

var dir = new Dir;
dir.path = this._exportDir;
dir.mkdirs();

Constructor & Destructor Documentation

Dir::Dir ( String &  path)
inline

Member Function Documentation

String Dir::absFilePath ( String &  file = String::null)
slot

Get absolute file path form filename give in parameter.

String Dir::absPath ( )
inline
String Dir::canonicalPath ( )
inline
void Dir::cd ( String &  dirName)
slot

change directory to the given direcotry name

void Dir::cdUp ( )
slot

Go up in directory hierarchy.

StringList Dir::entryList ( String &  filter,
int  filterSpec = -1,
int  sortSpec = -1 
)
slot

Returns a list of the names of all the files and directories in the directory, ordered according to the name and attribute filters.

bool Dir::exists ( )
inline
bool Dir::fileExists ( String &  fileName)
inlineslot

Check if the file/folder exist.

String Dir::filePath ( String &  file = String::null)
slot

Get file path form current directory from filename give in parameter.

bool Dir::isReadable ( )
inline
void Dir::mkdir ( String &  dirName = String::null)
slot

Create a directory with given name.

void Dir::mkdirs ( String &  dirName = String::null)
slot

Create directory recursively if a path of directory not created is given.

String Dir::name ( )
inline
String Dir::path ( )
inline
void Dir::remove ( String &  fileName)
slot

Remove a file with the given name.

void Dir::rename ( String &  oldName,
String &  newName 
)
slot

Rename a file/folder with the name given to the new name.

void Dir::rmdir ( String &  dirName = String::null)
slot

Remove a directory with given name.

void Dir::rmdirs ( String &  dirName = String::null)
slot

Remove directory recursively if a path of directory is given.

void Dir::setCurrent ( )
slot

Sets the application's current working directory to path.

void Dir::setPath ( String &  newPath)
inline

Member Data Documentation

QDir* Dir::dir
private

Property Documentation

String Dir::absPath
readprivate

Absolute path of the directory.

String Dir::canonicalPath
readprivate

Canonical path of the directory.

bool Dir::exists
readprivate

Say if the directory exist.

String Dir::name
readprivate

Name of the directory.

String Dir::path
readwriteprivate

Path of the directory.

bool Dir::readable
readprivate

Say if the directory is readable.


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