API reference - Class QDir

!=

Signature: [const] bool != (const QDir dir)

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

==

Signature: [const] bool == (const QDir dir)

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

AccessMask

Signature: [static,const] QDir_Filter AccessMask

Description: Enum constant QDir::AccessMask

Python specific notes:
The object exposes a readable attribute 'AccessMask'. This is the getter.

AllDirs

Signature: [static,const] QDir_Filter AllDirs

Description: Enum constant QDir::AllDirs

Python specific notes:
The object exposes a readable attribute 'AllDirs'. This is the getter.

AllEntries

Signature: [static,const] QDir_Filter AllEntries

Description: Enum constant QDir::AllEntries

Python specific notes:
The object exposes a readable attribute 'AllEntries'. This is the getter.

CaseSensitive

Signature: [static,const] QDir_Filter CaseSensitive

Description: Enum constant QDir::CaseSensitive

Python specific notes:
The object exposes a readable attribute 'CaseSensitive'. This is the getter.

Dirs

Signature: [static,const] QDir_Filter Dirs

Description: Enum constant QDir::Dirs

Python specific notes:
The object exposes a readable attribute 'Dirs'. This is the getter.

DirsFirst

Signature: [static,const] QDir_SortFlag DirsFirst

Description: Enum constant QDir::DirsFirst

Python specific notes:
The object exposes a readable attribute 'DirsFirst'. This is the getter.

DirsLast

Signature: [static,const] QDir_SortFlag DirsLast

Description: Enum constant QDir::DirsLast

Python specific notes:
The object exposes a readable attribute 'DirsLast'. This is the getter.

Drives

Signature: [static,const] QDir_Filter Drives

Description: Enum constant QDir::Drives

Python specific notes:
The object exposes a readable attribute 'Drives'. This is the getter.

Executable

Signature: [static,const] QDir_Filter Executable

Description: Enum constant QDir::Executable

Python specific notes:
The object exposes a readable attribute 'Executable'. This is the getter.

Files

Signature: [static,const] QDir_Filter Files

Description: Enum constant QDir::Files

Python specific notes:
The object exposes a readable attribute 'Files'. This is the getter.

Hidden

Signature: [static,const] QDir_Filter Hidden

Description: Enum constant QDir::Hidden

Python specific notes:
The object exposes a readable attribute 'Hidden'. This is the getter.

IgnoreCase

Signature: [static,const] QDir_SortFlag IgnoreCase

Description: Enum constant QDir::IgnoreCase

Python specific notes:
The object exposes a readable attribute 'IgnoreCase'. This is the getter.

LocaleAware

Signature: [static,const] QDir_SortFlag LocaleAware

Description: Enum constant QDir::LocaleAware

Python specific notes:
The object exposes a readable attribute 'LocaleAware'. This is the getter.

Modified

Signature: [static,const] QDir_Filter Modified

Description: Enum constant QDir::Modified

Python specific notes:
The object exposes a readable attribute 'Modified'. This is the getter.

Name

Signature: [static,const] QDir_SortFlag Name

Description: Enum constant QDir::Name

Python specific notes:
The object exposes a readable attribute 'Name'. This is the getter.

NoDotAndDotDot

Signature: [static,const] QDir_Filter NoDotAndDotDot

Description: Enum constant QDir::NoDotAndDotDot

Python specific notes:
The object exposes a readable attribute 'NoDotAndDotDot'. This is the getter.

NoFilter

Signature: [static,const] QDir_Filter NoFilter

Description: Enum constant QDir::NoFilter

Python specific notes:
The object exposes a readable attribute 'NoFilter'. This is the getter.

NoSort

Signature: [static,const] QDir_SortFlag NoSort

Description: Enum constant QDir::NoSort

Python specific notes:
The object exposes a readable attribute 'NoSort'. This is the getter.

NoSymLinks

Signature: [static,const] QDir_Filter NoSymLinks

Description: Enum constant QDir::NoSymLinks

Python specific notes:
The object exposes a readable attribute 'NoSymLinks'. This is the getter.

PermissionMask

Signature: [static,const] QDir_Filter PermissionMask

Description: Enum constant QDir::PermissionMask

Python specific notes:
The object exposes a readable attribute 'PermissionMask'. This is the getter.

Readable

Signature: [static,const] QDir_Filter Readable

Description: Enum constant QDir::Readable

Python specific notes:
The object exposes a readable attribute 'Readable'. This is the getter.

Reversed

Signature: [static,const] QDir_SortFlag Reversed

Description: Enum constant QDir::Reversed

Python specific notes:
The object exposes a readable attribute 'Reversed'. This is the getter.

Size

Signature: [static,const] QDir_SortFlag Size

Description: Enum constant QDir::Size

Python specific notes:
The object exposes a readable attribute 'Size'. This is the getter.

SortByMask

Signature: [static,const] QDir_SortFlag SortByMask

Description: Enum constant QDir::SortByMask

Python specific notes:
The object exposes a readable attribute 'SortByMask'. This is the getter.

System

Signature: [static,const] QDir_Filter System

Description: Enum constant QDir::System

Python specific notes:
The object exposes a readable attribute 'System'. This is the getter.

Time

Signature: [static,const] QDir_SortFlag Time

Description: Enum constant QDir::Time

Python specific notes:
The object exposes a readable attribute 'Time'. This is the getter.

Type

Signature: [static,const] QDir_SortFlag Type

Description: Enum constant QDir::Type

Python specific notes:
The object exposes a readable attribute 'Type'. This is the getter.

TypeMask

Signature: [static,const] QDir_Filter TypeMask

Description: Enum constant QDir::TypeMask

Python specific notes:
The object exposes a readable attribute 'TypeMask'. This is the getter.

Unsorted

Signature: [static,const] QDir_SortFlag Unsorted

Description: Enum constant QDir::Unsorted

Python specific notes:
The object exposes a readable attribute 'Unsorted'. This is the getter.

Writable

Signature: [static,const] QDir_Filter Writable

Description: Enum constant QDir::Writable

Python specific notes:
The object exposes a readable attribute 'Writable'. This is the getter.

[]

Signature: [const] string [] (int arg1)

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

_assign

Signature: void _assign (const QDir other)

Description: Assigns another object to self

_const_cast

Signature: [const] QDir ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: 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.

_destroy

Signature: 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.

_destroyed?

Signature: [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.

_is_const_object?

Signature: [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.

_manage

Signature: 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.

_unmanage

Signature: 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.

absoluteFilePath

Signature: [const] string absoluteFilePath (string fileName)

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

absolutePath

Signature: [const] string absolutePath

Description: Method QString QDir::absolutePath()

addResourceSearchPath

Signature: [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.

addSearchPath

Signature: [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.

assign

(1) Signature: QDir assign (const QDir arg1)

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

(2) Signature: QDir assign (string path)

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

canonicalPath

Signature: [const] string canonicalPath

Description: Method QString QDir::canonicalPath()

cd

Signature: bool cd (string dirName)

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

cdUp

Signature: bool cdUp

Description: Method bool QDir::cdUp()

cleanPath

Signature: [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.

convertSeparators

Signature: [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.

count

Signature: [const] unsigned int count

Description: Method unsigned int QDir::count()

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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.

current

Signature: [static] QDir current

Description: Static method QDir QDir::current()

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

currentPath

Signature: [static] string currentPath

Description: Static method QString QDir::currentPath()

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

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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.

destroyed?

Signature: [const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

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.

dirName

Signature: [const] string dirName

Description: Method QString QDir::dirName()

drives

Signature: [static] QFileInfo[] drives

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

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

dup

Signature: [const] new QDir ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

entryInfoList

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

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

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

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

entryList

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

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

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

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

exists

(1) Signature: [const] bool exists

Description: Method bool QDir::exists()

(2) Signature: [const] bool exists (string name)

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

filePath

Signature: [const] string filePath (string fileName)

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

filter

Signature: [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.

filter=

Signature: void filter= (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.

fromNativeSeparators

Signature: [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.

home

Signature: [static] QDir home

Description: Static method QDir QDir::home()

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

homePath

Signature: [static] string homePath

Description: Static method QString QDir::homePath()

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

isAbsolute?

Signature: [const] bool isAbsolute?

Description: Method bool QDir::isAbsolute()

isAbsolutePath?

Signature: [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.

isReadable?

Signature: [const] bool isReadable?

Description: Method bool QDir::isReadable()

isRelative?

Signature: [const] bool isRelative?

Description: Method bool QDir::isRelative()

isRelativePath?

Signature: [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.

isRoot?

Signature: [const] bool isRoot?

Description: Method bool QDir::isRoot()

is_const_object?

Signature: [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

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

makeAbsolute

Signature: bool makeAbsolute

Description: Method bool QDir::makeAbsolute()

match

(1) Signature: [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.

(2) Signature: [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.

mkdir

Signature: [const] bool mkdir (string dirName)

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

mkpath

Signature: [const] bool mkpath (string dirPath)

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

nameFilters

Signature: [const] string[] nameFilters

Description: Method QStringList QDir::nameFilters()

Python specific notes:
The object exposes a readable attribute 'nameFilters'. This is the getter.

nameFilters=

Signature: 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.

nameFiltersFromString

Signature: [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.

new

(1) Signature: [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.

(2) Signature: [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.

(3) Signature: [static] new QDir new (string path, string nameFilter, QDir_QFlags_SortFlag sort = QDir::SortFlags(QDir::Name | QDir::IgnoreCase), 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.

path

Signature: [const] string path

Description: Method QString QDir::path()

Python specific notes:
The object exposes a readable attribute 'path'. This is the getter.

path=

Signature: 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.

refresh

Signature: [const] void refresh

Description: Method void QDir::refresh()

relativeFilePath

Signature: [const] string relativeFilePath (string fileName)

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

remove

Signature: bool remove (string fileName)

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

rename

Signature: bool rename (string oldName, string newName)

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

rmdir

Signature: [const] bool rmdir (string dirName)

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

rmpath

Signature: [const] bool rmpath (string dirPath)

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

root

Signature: [static] QDir root

Description: Static method QDir QDir::root()

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

rootPath

Signature: [static] string rootPath

Description: Static method QString QDir::rootPath()

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

searchPaths

Signature: [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.

separator

Signature: [static] unsigned int separator

Description: Static method QChar QDir::separator()

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

setCurrent

Signature: [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.

setFilter

Signature: void setFilter (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.

setNameFilters

Signature: 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.

setPath

Signature: 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.

setSearchPaths

Signature: [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.

setSorting

Signature: void setSorting (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.

sorting

Signature: [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.

sorting=

Signature: void sorting= (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.

temp

Signature: [static] QDir temp

Description: Static method QDir QDir::temp()

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

tempPath

Signature: [static] string tempPath

Description: Static method QString QDir::tempPath()

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

toNativeSeparators

Signature: [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.