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

API reference - Class QFile

Notation used in Ruby API documentation

Description: Binding of QFile

Class hierarchy: QFile » QIODevice » QObject

Sub-classes: FileError, Permission

• 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

[static,const] new QFile_FileError ptr AbortError

Description: Enum constant QFile::AbortError

[static,const] new QFile_FileError ptr CopyError

Description: Enum constant QFile::CopyError

[static,const] new QFile_Permission ptr ExeGroup

Description: Enum constant QFile::ExeGroup

[static,const] new QFile_Permission ptr ExeOther

Description: Enum constant QFile::ExeOther

[static,const] new QFile_Permission ptr ExeOwner

Description: Enum constant QFile::ExeOwner

[static,const] new QFile_Permission ptr ExeUser

Description: Enum constant QFile::ExeUser

[static,const] new QFile_FileError ptr FatalError

Description: Enum constant QFile::FatalError

[static,const] new QFile_FileError ptr NoError

Description: Enum constant QFile::NoError

[static,const] new QFile_FileError ptr OpenError

Description: Enum constant QFile::OpenError

[static,const] new QFile_FileError ptr PermissionsError

Description: Enum constant QFile::PermissionsError

[static,const] new QFile_FileError ptr PositionError

Description: Enum constant QFile::PositionError

[static,const] new QFile_FileError ptr ReadError

Description: Enum constant QFile::ReadError

[static,const] new QFile_Permission ptr ReadGroup

Description: Enum constant QFile::ReadGroup

[static,const] new QFile_Permission ptr ReadOther

Description: Enum constant QFile::ReadOther

[static,const] new QFile_Permission ptr ReadOwner

Description: Enum constant QFile::ReadOwner

[static,const] new QFile_Permission ptr ReadUser

Description: Enum constant QFile::ReadUser

[static,const] new QFile_FileError ptr RemoveError

Description: Enum constant QFile::RemoveError

[static,const] new QFile_FileError ptr RenameError

Description: Enum constant QFile::RenameError

[static,const] new QFile_FileError ptr ResizeError

Description: Enum constant QFile::ResizeError

[static,const] new QFile_FileError ptr ResourceError

Description: Enum constant QFile::ResourceError

[static,const] new QFile_FileError ptr TimeOutError

Description: Enum constant QFile::TimeOutError

[static,const] new QFile_FileError ptr UnspecifiedError

Description: Enum constant QFile::UnspecifiedError

[static,const] new QFile_FileError ptr WriteError

Description: Enum constant QFile::WriteError

[static,const] new QFile_Permission ptr WriteGroup

Description: Enum constant QFile::WriteGroup

[static,const] new QFile_Permission ptr WriteOther

Description: Enum constant QFile::WriteOther

[static,const] new QFile_Permission ptr WriteOwner

Description: Enum constant QFile::WriteOwner

[static,const] new QFile_Permission ptr WriteUser

Description: Enum constant QFile::WriteUser

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.

[event] void aboutToClose

Description: Signal declaration for QFile::aboutToClose()

You can bind a procedure to this signal.

[const] bool atEnd

Description: Method bool QFile::atEnd()

This is a reimplementation of QIODevice::atEnd

[event] void bytesWritten(long long bytes)

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

You can bind a procedure to this signal.

void close

Description: Method void QFile::close()

This is a reimplementation of QIODevice::close

bool copy(string newName)

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

Python specific notes:

This method is available as method '_inst_copy' in Python

[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 method is available as method '_class_copy' in Python

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[static] string encodeName(string fileName)

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

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

[const] QFile_FileError error

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

[const] bool exists

Description: Method bool QFile::exists()

Python specific notes:

This method is available as method '_inst_exists' in Python

[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 method is available as method '_class_exists' in Python

[const] string fileName

Description: Method QString QFile::fileName()

Python specific notes:

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

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.

bool flush

Description: Method bool QFile::flush()

[const] int handle

Description: Method int QFile::handle()

[const] bool isSequential?

Description: Method bool QFile::isSequential()

This is a reimplementation of QIODevice::isSequential

[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 link(string newName)

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

Python specific notes:

This method is available as method '_inst_link' in Python

[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 method is available as method '_class_link' in Python

[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

[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

[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

[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

bool open(const QIODevice_QFlags_OpenModeFlag flags)

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

This is a reimplementation of QIODevice::open

[const] QFile_QFlags_Permission permissions

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

Python specific notes:

This method is available as method '_inst_permissions' in Python

[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 method is available as method '_class_permissions' in Python

[const] long long pos

Description: Method qint64 QFile::pos()

This is a reimplementation of QIODevice::pos

[event] void readChannelFinished

Description: Signal declaration for QFile::readChannelFinished()

You can bind a procedure to this signal.

[const] string readLink

Description: Method QString QFile::readLink()

Python specific notes:

This method is available as method '_inst_readLink' in Python

[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 method is available as method '_class_readLink' in Python

[event] void readyRead

Description: Signal declaration for QFile::readyRead()

You can bind a procedure to this signal.

bool remove

Description: Method bool QFile::remove()

Python specific notes:

This method is available as method '_inst_remove' in Python

[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 method is available as method '_class_remove' in Python

bool rename(string newName)

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

Python specific notes:

This method is available as method '_inst_rename' in Python

[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 method is available as method '_class_rename' in Python

bool resize(long long sz)

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

Python specific notes:

This method is available as method '_inst_resize' in Python

[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 method is available as method '_class_resize' in Python

bool seek(long long offset)

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

This is a reimplementation of QIODevice::seek

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.

bool setPermissions(const QFile_QFlags_Permission permissionSpec)

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

Python specific notes:

This method is available as method '_inst_setPermissions' in Python

[static] bool setPermissions(string filename,const 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 method is available as method '_class_setPermissions' in Python

[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)'

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[const] string symLinkTarget

Description: Method QString QFile::symLinkTarget()

Python specific notes:

This method is available as method '_inst_symLinkTarget' in Python

[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 method is available as method '_class_symLinkTarget' in Python

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

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

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

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

void unsetError

Description: Method void QFile::unsetError()