KLayout Manual: Main Index » Class Index » API reference - Class QDir

API reference - Class QDir

Notation used in Ruby API documentation

Description: Binding of QDir

Sub-classes: Filter, SortFlag

• Public constructors
• Public methods
• Public static methods and constants
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

[const] bool !=(const QDir dir)

Description: Method bool QDir::operator!=(const QDir &dir)

[const] bool ==(const QDir dir)

Description: Method bool QDir::operator==(const QDir &dir)

[static,const] new QDir_Filter ptr AccessMask

Description: Enum constant QDir::AccessMask

[static,const] new QDir_Filter ptr AllDirs

Description: Enum constant QDir::AllDirs

[static,const] new QDir_Filter ptr AllEntries

Description: Enum constant QDir::AllEntries

[static,const] new QDir_Filter ptr CaseSensitive

Description: Enum constant QDir::CaseSensitive

[static,const] new QDir_Filter ptr Dirs

Description: Enum constant QDir::Dirs

[static,const] new QDir_SortFlag ptr DirsFirst

Description: Enum constant QDir::DirsFirst

[static,const] new QDir_SortFlag ptr DirsLast

Description: Enum constant QDir::DirsLast

[static,const] new QDir_Filter ptr Drives

Description: Enum constant QDir::Drives

[static,const] new QDir_Filter ptr Executable

Description: Enum constant QDir::Executable

[static,const] new QDir_Filter ptr Files

Description: Enum constant QDir::Files

[static,const] new QDir_Filter ptr Hidden

Description: Enum constant QDir::Hidden

[static,const] new QDir_SortFlag ptr IgnoreCase

Description: Enum constant QDir::IgnoreCase

[static,const] new QDir_SortFlag ptr LocaleAware

Description: Enum constant QDir::LocaleAware

[static,const] new QDir_Filter ptr Modified

Description: Enum constant QDir::Modified

[static,const] new QDir_SortFlag ptr Name

Description: Enum constant QDir::Name

[static,const] new QDir_Filter ptr NoDotAndDotDot

Description: Enum constant QDir::NoDotAndDotDot

[static,const] new QDir_Filter ptr NoFilter

Description: Enum constant QDir::NoFilter

[static,const] new QDir_SortFlag ptr NoSort

Description: Enum constant QDir::NoSort

[static,const] new QDir_Filter ptr NoSymLinks

Description: Enum constant QDir::NoSymLinks

[static,const] new QDir_Filter ptr PermissionMask

Description: Enum constant QDir::PermissionMask

[static,const] new QDir_Filter ptr Readable

Description: Enum constant QDir::Readable

[static,const] new QDir_SortFlag ptr Reversed

Description: Enum constant QDir::Reversed

[static,const] new QDir_SortFlag ptr Size

Description: Enum constant QDir::Size

[static,const] new QDir_SortFlag ptr SortByMask

Description: Enum constant QDir::SortByMask

[static,const] new QDir_Filter ptr System

Description: Enum constant QDir::System

[static,const] new QDir_SortFlag ptr Time

Description: Enum constant QDir::Time

[static,const] new QDir_SortFlag ptr Type

Description: Enum constant QDir::Type

[static,const] new QDir_Filter ptr TypeMask

Description: Enum constant QDir::TypeMask

[static,const] new QDir_SortFlag ptr Unsorted

Description: Enum constant QDir::Unsorted

[static,const] new QDir_Filter ptr Writable

Description: Enum constant QDir::Writable

[const] string [](int arg1)

Description: Method QString QDir::operator[](int)

void _assign(const QDir other)

Description: Assigns another object to self

void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

[const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

[const] string absoluteFilePath(string fileName)

Description: Method QString QDir::absoluteFilePath(const QString &fileName)

[const] string absolutePath

Description: Method QString QDir::absolutePath()

[static] void addResourceSearchPath(string path)

Description: Static method void QDir::addResourceSearchPath(const QString &path)

This method is static and can be called without an instance.

[static] void addSearchPath(string prefix,string path)

Description: Static method void QDir::addSearchPath(const QString &prefix, const QString &path)

This method is static and can be called without an instance.

QDir assign(const QDir arg1)

Description: Method QDir &QDir::operator=(const QDir &)

QDir assign(string path)

Description: Method QDir &QDir::operator=(const QString &path)

[const] string canonicalPath

Description: Method QString QDir::canonicalPath()

bool cd(string dirName)

Description: Method bool QDir::cd(const QString &dirName)

bool cdUp

Description: Method bool QDir::cdUp()

[static] string cleanPath(string path)

Description: Static method QString QDir::cleanPath(const QString &path)

This method is static and can be called without an instance.

[static] string convertSeparators(string pathName)

Description: Static method QString QDir::convertSeparators(const QString &pathName)

This method is static and can be called without an instance.

[const] unsigned int count

Description: Method unsigned int QDir::count()

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[static] QDir current

Description: Static method QDir QDir::current()

This method is static and can be called without an instance.

[static] string currentPath

Description: Static method QString QDir::currentPath()

This method is static and can be called without an instance.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[const] string dirName

Description: Method QString QDir::dirName()

[static] QFileInfo[] drives

Description: Static method QList<QFileInfo> QDir::drives()

This method is static and can be called without an instance.

[const] new QDir ptr dup

Description: Creates a copy of self

[const] QFileInfo[] entryInfoList(const QDir_QFlags_Filter filters = QDir::NoFilter,const QDir_QFlags_SortFlag sort = QDir::NoSort)

Description: Method QList<QFileInfo> QDir::entryInfoList(QFlags<QDir::Filter> filters, QFlags<QDir::SortFlag> sort)

[const] QFileInfo[] entryInfoList(string[] nameFilters,const QDir_QFlags_Filter filters = QDir::NoFilter,const QDir_QFlags_SortFlag sort = QDir::NoSort)

Description: Method QList<QFileInfo> QDir::entryInfoList(const QStringList &nameFilters, QFlags<QDir::Filter> filters, QFlags<QDir::SortFlag> sort)

[const] string[] entryList(const QDir_QFlags_Filter filters = QDir::NoFilter,const QDir_QFlags_SortFlag sort = QDir::NoSort)

Description: Method QStringList QDir::entryList(QFlags<QDir::Filter> filters, QFlags<QDir::SortFlag> sort)

[const] string[] entryList(string[] nameFilters,const QDir_QFlags_Filter filters = QDir::NoFilter,const QDir_QFlags_SortFlag sort = QDir::NoSort)

Description: Method QStringList QDir::entryList(const QStringList &nameFilters, QFlags<QDir::Filter> filters, QFlags<QDir::SortFlag> sort)

[const] bool exists

Description: Method bool QDir::exists()

[const] bool exists(string name)

Description: Method bool QDir::exists(const QString &name)

[const] string filePath(string fileName)

Description: Method QString QDir::filePath(const QString &fileName)

[const] QDir_QFlags_Filter filter

Description: Method QFlags<QDir::Filter> QDir::filter()

Python specific notes:

The object exposes a readable attribute 'filter'. This is the getter.

void filter=(const QDir_QFlags_Filter filter)

Description: Method void QDir::setFilter(QFlags<QDir::Filter> filter)

Python specific notes:

The object exposes a writable attribute 'filter'. This is the setter.

[static] string fromNativeSeparators(string pathName)

Description: Static method QString QDir::fromNativeSeparators(const QString &pathName)

This method is static and can be called without an instance.

[static] QDir home

Description: Static method QDir QDir::home()

This method is static and can be called without an instance.

[static] string homePath

Description: Static method QString QDir::homePath()

This method is static and can be called without an instance.

[const] bool isAbsolute?

Description: Method bool QDir::isAbsolute()

[static] bool isAbsolutePath?(string path)

Description: Static method bool QDir::isAbsolutePath(const QString &path)

This method is static and can be called without an instance.

[const] bool isReadable?

Description: Method bool QDir::isReadable()

[const] bool isRelative?

Description: Method bool QDir::isRelative()

[static] bool isRelativePath?(string path)

Description: Static method bool QDir::isRelativePath(const QString &path)

This method is static and can be called without an instance.

[const] bool isRoot?

Description: Method bool QDir::isRoot()

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

bool makeAbsolute

Description: Method bool QDir::makeAbsolute()

[static] bool match(string[] filters,string fileName)

Description: Static method bool QDir::match(const QStringList &filters, const QString &fileName)

This method is static and can be called without an instance.

[static] bool match(string filter,string fileName)

Description: Static method bool QDir::match(const QString &filter, const QString &fileName)

This method is static and can be called without an instance.

[const] bool mkdir(string dirName)

Description: Method bool QDir::mkdir(const QString &dirName)

[const] bool mkpath(string dirPath)

Description: Method bool QDir::mkpath(const QString &dirPath)

[const] string[] nameFilters

Description: Method QStringList QDir::nameFilters()

Python specific notes:

The object exposes a readable attribute 'nameFilters'. This is the getter.

void nameFilters=(string[] nameFilters)

Description: Method void QDir::setNameFilters(const QStringList &nameFilters)

Python specific notes:

The object exposes a writable attribute 'nameFilters'. This is the setter.

[static] string[] nameFiltersFromString(string nameFilter)

Description: Static method QStringList QDir::nameFiltersFromString(const QString &nameFilter)

This method is static and can be called without an instance.

[static] new QDir new(const QDir arg1)

Description: Constructor QDir::QDir(const QDir &)

This method creates an object of class QDir.

Python specific notes:

This method is the default initializer of the object

[static] new QDir new(string path = QString())

Description: Constructor QDir::QDir(const QString &path)

This method creates an object of class QDir.

Python specific notes:

This method is the default initializer of the object

[static] new QDir new(string path,string nameFilter,const QDir_QFlags_SortFlag sort = QDir::SortFlags(QDir::Name | QDir::IgnoreCase),const QDir_QFlags_Filter filter = QDir::AllEntries)

Description: Constructor QDir::QDir(const QString &path, const QString &nameFilter, QFlags<QDir::SortFlag> sort, QFlags<QDir::Filter> filter)

This method creates an object of class QDir.

Python specific notes:

This method is the default initializer of the object

[const] string path

Description: Method QString QDir::path()

Python specific notes:

The object exposes a readable attribute 'path'. This is the getter.

void path=(string path)

Description: Method void QDir::setPath(const QString &path)

Python specific notes:

The object exposes a writable attribute 'path'. This is the setter.

[const] void refresh

Description: Method void QDir::refresh()

[const] string relativeFilePath(string fileName)

Description: Method QString QDir::relativeFilePath(const QString &fileName)

bool remove(string fileName)

Description: Method bool QDir::remove(const QString &fileName)

bool rename(string oldName,string newName)

Description: Method bool QDir::rename(const QString &oldName, const QString &newName)

[const] bool rmdir(string dirName)

Description: Method bool QDir::rmdir(const QString &dirName)

[const] bool rmpath(string dirPath)

Description: Method bool QDir::rmpath(const QString &dirPath)

[static] QDir root

Description: Static method QDir QDir::root()

This method is static and can be called without an instance.

[static] string rootPath

Description: Static method QString QDir::rootPath()

This method is static and can be called without an instance.

[static] string[] searchPaths(string prefix)

Description: Static method QStringList QDir::searchPaths(const QString &prefix)

This method is static and can be called without an instance.

[static] unsigned int separator

Description: Static method QChar QDir::separator()

This method is static and can be called without an instance.

[static] bool setCurrent(string path)

Description: Static method bool QDir::setCurrent(const QString &path)

This method is static and can be called without an instance.

void setFilter(const QDir_QFlags_Filter filter)

Description: Method void QDir::setFilter(QFlags<QDir::Filter> filter)

Python specific notes:

The object exposes a writable attribute 'filter'. This is the setter.

void setNameFilters(string[] nameFilters)

Description: Method void QDir::setNameFilters(const QStringList &nameFilters)

Python specific notes:

The object exposes a writable attribute 'nameFilters'. This is the setter.

void setPath(string path)

Description: Method void QDir::setPath(const QString &path)

Python specific notes:

The object exposes a writable attribute 'path'. This is the setter.

[static] void setSearchPaths(string prefix,string[] searchPaths)

Description: Static method void QDir::setSearchPaths(const QString &prefix, const QStringList &searchPaths)

This method is static and can be called without an instance.

void setSorting(const QDir_QFlags_SortFlag sort)

Description: Method void QDir::setSorting(QFlags<QDir::SortFlag> sort)

Python specific notes:

The object exposes a writable attribute 'sorting'. This is the setter.

[const] QDir_QFlags_SortFlag sorting

Description: Method QFlags<QDir::SortFlag> QDir::sorting()

Python specific notes:

The object exposes a readable attribute 'sorting'. This is the getter.

void sorting=(const QDir_QFlags_SortFlag sort)

Description: Method void QDir::setSorting(QFlags<QDir::SortFlag> sort)

Python specific notes:

The object exposes a writable attribute 'sorting'. This is the setter.

[static] QDir temp

Description: Static method QDir QDir::temp()

This method is static and can be called without an instance.

[static] string tempPath

Description: Static method QString QDir::tempPath()

This method is static and can be called without an instance.

[static] string toNativeSeparators(string pathName)

Description: Static method QString QDir::toNativeSeparators(const QString &pathName)

This method is static and can be called without an instance.