API reference - Class QFile

AbortError

Signature: [static,const] QFile_FileError AbortError

Description: Enum constant QFile::AbortError

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

CopyError

Signature: [static,const] QFile_FileError CopyError

Description: Enum constant QFile::CopyError

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

ExeGroup

Signature: [static,const] QFile_Permission ExeGroup

Description: Enum constant QFile::ExeGroup

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

ExeOther

Signature: [static,const] QFile_Permission ExeOther

Description: Enum constant QFile::ExeOther

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

ExeOwner

Signature: [static,const] QFile_Permission ExeOwner

Description: Enum constant QFile::ExeOwner

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

ExeUser

Signature: [static,const] QFile_Permission ExeUser

Description: Enum constant QFile::ExeUser

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

FatalError

Signature: [static,const] QFile_FileError FatalError

Description: Enum constant QFile::FatalError

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

NoError

Signature: [static,const] QFile_FileError NoError

Description: Enum constant QFile::NoError

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

OpenError

Signature: [static,const] QFile_FileError OpenError

Description: Enum constant QFile::OpenError

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

PermissionsError

Signature: [static,const] QFile_FileError PermissionsError

Description: Enum constant QFile::PermissionsError

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

PositionError

Signature: [static,const] QFile_FileError PositionError

Description: Enum constant QFile::PositionError

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

ReadError

Signature: [static,const] QFile_FileError ReadError

Description: Enum constant QFile::ReadError

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

ReadGroup

Signature: [static,const] QFile_Permission ReadGroup

Description: Enum constant QFile::ReadGroup

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

ReadOther

Signature: [static,const] QFile_Permission ReadOther

Description: Enum constant QFile::ReadOther

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

ReadOwner

Signature: [static,const] QFile_Permission ReadOwner

Description: Enum constant QFile::ReadOwner

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

ReadUser

Signature: [static,const] QFile_Permission ReadUser

Description: Enum constant QFile::ReadUser

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

RemoveError

Signature: [static,const] QFile_FileError RemoveError

Description: Enum constant QFile::RemoveError

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

RenameError

Signature: [static,const] QFile_FileError RenameError

Description: Enum constant QFile::RenameError

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

ResizeError

Signature: [static,const] QFile_FileError ResizeError

Description: Enum constant QFile::ResizeError

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

ResourceError

Signature: [static,const] QFile_FileError ResourceError

Description: Enum constant QFile::ResourceError

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

TimeOutError

Signature: [static,const] QFile_FileError TimeOutError

Description: Enum constant QFile::TimeOutError

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

UnspecifiedError

Signature: [static,const] QFile_FileError UnspecifiedError

Description: Enum constant QFile::UnspecifiedError

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

WriteError

Signature: [static,const] QFile_FileError WriteError

Description: Enum constant QFile::WriteError

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

WriteGroup

Signature: [static,const] QFile_Permission WriteGroup

Description: Enum constant QFile::WriteGroup

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

WriteOther

Signature: [static,const] QFile_Permission WriteOther

Description: Enum constant QFile::WriteOther

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

WriteOwner

Signature: [static,const] QFile_Permission WriteOwner

Description: Enum constant QFile::WriteOwner

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

WriteUser

Signature: [static,const] QFile_Permission WriteUser

Description: Enum constant QFile::WriteUser

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

_const_cast

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

aboutToClose

Signature: [signal] void aboutToClose

Description: Signal declaration for QFile::aboutToClose()

You can bind a procedure to this signal.

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

atEnd

Signature: [const] bool atEnd

Description: Method bool QFile::atEnd()

This is a reimplementation of QIODevice::atEnd

bytesWritten

Signature: [signal] void bytesWritten (long long bytes)

Description: Signal declaration for QFile::bytesWritten(qint64 bytes)

You can bind a procedure to this signal.

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

close

Signature: void close

Description: Method void QFile::close()

This is a reimplementation of QIODevice::close

copy

(1) Signature: bool copy (string newName)

Description: Method bool QFile::copy(const QString &newName)

Python specific notes:
This instance method is available as '_inst_copy' in Python.

(2) Signature: [static] bool copy (string fileName, string newName)

Description: Static method bool QFile::copy(const QString &fileName, const QString &newName)

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

Python specific notes:
This class method is available as '_class_copy' in Python.

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.

decodeName

Signature: [static] string decodeName (string localFileName)

Description: Static method QString QFile::decodeName(const char *localFileName)

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: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QFile::destroyed(QObject *)

You can bind a procedure to this signal.

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

encodeName

Signature: [static] bytes encodeName (string fileName)

Description: Static method QByteArray QFile::encodeName(const QString &fileName)

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

error

Signature: [const] QFile_FileError error

Description: Method QFile::FileError QFile::error()

exists

(1) Signature: [const] bool exists

Description: Method bool QFile::exists()

Python specific notes:
This instance method is available as '_inst_exists' in Python.

(2) Signature: [static] bool exists (string fileName)

Description: Static method bool QFile::exists(const QString &fileName)

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

Python specific notes:
This class method is available as '_class_exists' in Python.

fileName

Signature: [const] string fileName

Description: Method QString QFile::fileName()

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

fileName=

Signature: void fileName= (string name)

Description: Method void QFile::setFileName(const QString &name)

Python specific notes:
The object exposes a writable attribute 'fileName'. This is the setter.
The object exposes a writable attribute 'fileName'. This is the setter.

flush

Signature: bool flush

Description: Method bool QFile::flush()

handle

Signature: [const] int handle

Description: Method int QFile::handle()

isSequential?

Signature: [const] bool isSequential?

Description: Method bool QFile::isSequential()

This is a reimplementation of QIODevice::isSequential

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.

link

(1) Signature: bool link (string newName)

Description: Method bool QFile::link(const QString &newName)

Python specific notes:
This instance method is available as '_inst_link' in Python.

(2) Signature: [static] bool link (string oldname, string newName)

Description: Static method bool QFile::link(const QString &oldname, const QString &newName)

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

Python specific notes:
This class method is available as '_class_link' in Python.

new

(1) Signature: [static] new QFile new

Description: Constructor QFile::QFile()

This method creates an object of class QFile.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QFile new (string name)

Description: Constructor QFile::QFile(const QString &name)

This method creates an object of class QFile.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QFile new (QObject ptr parent)

Description: Constructor QFile::QFile(QObject *parent)

This method creates an object of class QFile.

Python specific notes:
This method is the default initializer of the object.

(4) Signature: [static] new QFile new (string name, QObject ptr parent)

Description: Constructor QFile::QFile(const QString &name, QObject *parent)

This method creates an object of class QFile.

Python specific notes:
This method is the default initializer of the object.

open

Signature: bool open (QIODevice_QFlags_OpenModeFlag flags)

Description: Method bool QFile::open(QFlags<QIODevice::OpenModeFlag> flags)

This is a reimplementation of QIODevice::open

permissions

(1) Signature: [const] QFile_QFlags_Permission permissions

Description: Method QFlags<QFile::Permission> QFile::permissions()

Python specific notes:
This instance method is available as '_inst_permissions' in Python.

(2) Signature: [static] QFile_QFlags_Permission permissions (string filename)

Description: Static method QFlags<QFile::Permission> QFile::permissions(const QString &filename)

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

Python specific notes:
This class method is available as '_class_permissions' in Python.

pos

Signature: [const] long long pos

Description: Method qint64 QFile::pos()

This is a reimplementation of QIODevice::pos

readChannelFinished

Signature: [signal] void readChannelFinished

Description: Signal declaration for QFile::readChannelFinished()

You can bind a procedure to this signal.

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

readLink

(1) Signature: [const] string readLink

Description: Method QString QFile::readLink()

Python specific notes:
This instance method is available as '_inst_readLink' in Python.

(2) Signature: [static] string readLink (string fileName)

Description: Static method QString QFile::readLink(const QString &fileName)

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

Python specific notes:
This class method is available as '_class_readLink' in Python.

readyRead

Signature: [signal] void readyRead

Description: Signal declaration for QFile::readyRead()

You can bind a procedure to this signal.

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

remove

(1) Signature: bool remove

Description: Method bool QFile::remove()

Python specific notes:
This instance method is available as '_inst_remove' in Python.

(2) Signature: [static] bool remove (string fileName)

Description: Static method bool QFile::remove(const QString &fileName)

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

Python specific notes:
This class method is available as '_class_remove' in Python.

rename

(1) Signature: bool rename (string newName)

Description: Method bool QFile::rename(const QString &newName)

Python specific notes:
This instance method is available as '_inst_rename' in Python.

(2) Signature: [static] bool rename (string oldName, string newName)

Description: Static method bool QFile::rename(const QString &oldName, const QString &newName)

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

Python specific notes:
This class method is available as '_class_rename' in Python.

resize

(1) Signature: bool resize (long long sz)

Description: Method bool QFile::resize(qint64 sz)

Python specific notes:
This instance method is available as '_inst_resize' in Python.

(2) Signature: [static] bool resize (string filename, long long sz)

Description: Static method bool QFile::resize(const QString &filename, qint64 sz)

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

Python specific notes:
This class method is available as '_class_resize' in Python.

seek

Signature: bool seek (long long offset)

Description: Method bool QFile::seek(qint64 offset)

This is a reimplementation of QIODevice::seek

setFileName

Signature: void setFileName (string name)

Description: Method void QFile::setFileName(const QString &name)

Python specific notes:
The object exposes a writable attribute 'fileName'. This is the setter.
The object exposes a writable attribute 'fileName'. This is the setter.

setPermissions

(1) Signature: bool setPermissions (QFile_QFlags_Permission permissionSpec)

Description: Method bool QFile::setPermissions(QFlags<QFile::Permission> permissionSpec)

Python specific notes:
This instance method is available as '_inst_setPermissions' in Python.

(2) Signature: [static] bool setPermissions (string filename, QFile_QFlags_Permission permissionSpec)

Description: Static method bool QFile::setPermissions(const QString &filename, QFlags<QFile::Permission> permissionSpec)

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

Python specific notes:
This class method is available as '_class_setPermissions' in Python.

size

Signature: [const] long long size

Description: Method qint64 QFile::size()

This is a reimplementation of QIODevice::size

Python specific notes:
This method is also available as 'len(object)'.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

symLinkTarget

(1) Signature: [const] string symLinkTarget

Description: Method QString QFile::symLinkTarget()

Python specific notes:
This instance method is available as '_inst_symLinkTarget' in Python.

(2) Signature: [static] string symLinkTarget (string fileName)

Description: Static method QString QFile::symLinkTarget(const QString &fileName)

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

Python specific notes:
This class method is available as '_class_symLinkTarget' in Python.

tr

(1) Signature: [static] string tr (string s, string c = 0)

Description: Static method QString QFile::tr(const char *s, const char *c)

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

(2) Signature: [static] string tr (string s, string c, int n)

Description: Static method QString QFile::tr(const char *s, const char *c, int n)

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

trUtf8

(1) Signature: [static] string trUtf8 (string s, string c = 0)

Description: Static method QString QFile::trUtf8(const char *s, const char *c)

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

(2) Signature: [static] string trUtf8 (string s, string c, int n)

Description: Static method QString QFile::trUtf8(const char *s, const char *c, int n)

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

unsetError

Signature: void unsetError

Description: Method void QFile::unsetError()