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

Public constructors

new QFilenewConstructor QFile::QFile()
new QFilenew(QObject ptr parent)Constructor QFile::QFile(QObject *parent)
new QFilenew(string name)Constructor QFile::QFile(const QString &name)
new QFilenew(string name,
QObject ptr parent)
Constructor QFile::QFile(const QString &name, QObject *parent)

Public methods

[const]boolatEndMethod bool QFile::atEnd()
voidcloseMethod void QFile::close()
boolcopy(string newName)Method bool QFile::copy(const QString &newName)
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QFile_FileErrorerrorMethod QFile::FileError QFile::error()
[const]boolexistsMethod bool QFile::exists()
[const]stringfileNameMethod QString QFile::fileName()
voidfileName=(string name)Method void QFile::setFileName(const QString &name)
boolflushMethod bool QFile::flush()
[const]inthandleMethod int QFile::handle()
[const]boolisSequentialMethod bool QFile::isSequential()
[const]boolisSequential?Method bool QFile::isSequential()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
boollink(string newName)Method bool QFile::link(const QString &newName)
boolopen(int flags)Method bool QFile::open(QFlags<enum QIODevice::OpenModeFlag> flags)
[const]intpermissionsMethod QFlags<enum QFile::Permission> QFile::permissions()
boolpermissions=(int permissionSpec)Method bool QFile::setPermissions(QFlags<enum QFile::Permission> permissionSpec)
[const]long longposMethod qint64 QFile::pos()
[const]stringreadLinkMethod QString QFile::readLink()
boolremoveMethod bool QFile::remove()
boolrename(string newName)Method bool QFile::rename(const QString &newName)
boolresize(long long sz)Method bool QFile::resize(qint64 sz)
boolseek(long long offset)Method bool QFile::seek(qint64 offset)
voidsetFileName(string name)Method void QFile::setFileName(const QString &name)
boolsetPermissions(int permissionSpec)Method bool QFile::setPermissions(QFlags<enum QFile::Permission> permissionSpec)
[const]long longsizeMethod qint64 QFile::size()
[const]stringsymLinkTargetMethod QString QFile::symLinkTarget()
voidunsetErrorMethod void QFile::unsetError()

Public static methods and constants

QFile_FileErrorAbortErrorEnum constant enum QFile::AbortError
QFile_FileErrorCopyErrorEnum constant enum QFile::CopyError
QFile_PermissionExeGroupEnum constant enum QFile::ExeGroup
QFile_PermissionExeOtherEnum constant enum QFile::ExeOther
QFile_PermissionExeOwnerEnum constant enum QFile::ExeOwner
QFile_PermissionExeUserEnum constant enum QFile::ExeUser
QFile_FileErrorFatalErrorEnum constant enum QFile::FatalError
QFile_FileErrorNoErrorEnum constant enum QFile::NoError
QFile_FileErrorOpenErrorEnum constant enum QFile::OpenError
QFile_FileErrorPermissionsErrorEnum constant enum QFile::PermissionsError
QFile_FileErrorPositionErrorEnum constant enum QFile::PositionError
QFile_FileErrorReadErrorEnum constant enum QFile::ReadError
QFile_PermissionReadGroupEnum constant enum QFile::ReadGroup
QFile_PermissionReadOtherEnum constant enum QFile::ReadOther
QFile_PermissionReadOwnerEnum constant enum QFile::ReadOwner
QFile_PermissionReadUserEnum constant enum QFile::ReadUser
QFile_FileErrorRemoveErrorEnum constant enum QFile::RemoveError
QFile_FileErrorRenameErrorEnum constant enum QFile::RenameError
QFile_FileErrorResizeErrorEnum constant enum QFile::ResizeError
QFile_FileErrorResourceErrorEnum constant enum QFile::ResourceError
QFile_FileErrorTimeOutErrorEnum constant enum QFile::TimeOutError
QFile_FileErrorUnspecifiedErrorEnum constant enum QFile::UnspecifiedError
QFile_FileErrorWriteErrorEnum constant enum QFile::WriteError
QFile_PermissionWriteGroupEnum constant enum QFile::WriteGroup
QFile_PermissionWriteOtherEnum constant enum QFile::WriteOther
QFile_PermissionWriteOwnerEnum constant enum QFile::WriteOwner
QFile_PermissionWriteUserEnum constant enum QFile::WriteUser
boolcopy(string fileName,
string newName)
Static method bool QFile::copy(const QString &fileName, const QString &newName)
stringdecodeName(string localFileName)Static method QString QFile::decodeName(const char *localFileName)
stringencodeName(string fileName)Static method QByteArray QFile::encodeName(const QString &fileName)
boolexists(string fileName)Static method bool QFile::exists(const QString &fileName)
boollink(string oldname,
string newName)
Static method bool QFile::link(const QString &oldname, const QString &newName)
intpermissions(string filename)Static method QFlags<enum QFile::Permission> QFile::permissions(const QString &filename)
stringreadLink(string fileName)Static method QString QFile::readLink(const QString &fileName)
boolremove(string fileName)Static method bool QFile::remove(const QString &fileName)
boolrename(string oldName,
string newName)
Static method bool QFile::rename(const QString &oldName, const QString &newName)
boolresize(string filename,
long long sz)
Static method bool QFile::resize(const QString &filename, qint64 sz)
boolsetPermissions(string filename,
int permissionSpec)
Static method bool QFile::setPermissions(const QString &filename, QFlags<enum QFile::Permission> permissionSpec)
QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringsymLinkTarget(string fileName)Static method QString QFile::symLinkTarget(const QString &fileName)
stringtr(string s)Static method QString QFile::tr(const char *s, const char *c)
stringtr(string s,
string c)
Static method QString QFile::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QFile::tr(const char *s, const char *c, int n)
stringtrUtf8(string s)Static method QString QFile::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c)
Static method QString QFile::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QFile::trUtf8(const char *s, const char *c, int n)

Detailed description

[static] QFile_FileError AbortError

Description: Enum constant enum QFile::AbortError

[static] QFile_FileError CopyError

Description: Enum constant enum QFile::CopyError

[static] QFile_Permission ExeGroup

Description: Enum constant enum QFile::ExeGroup

[static] QFile_Permission ExeOther

Description: Enum constant enum QFile::ExeOther

[static] QFile_Permission ExeOwner

Description: Enum constant enum QFile::ExeOwner

[static] QFile_Permission ExeUser

Description: Enum constant enum QFile::ExeUser

[static] QFile_FileError FatalError

Description: Enum constant enum QFile::FatalError

[static] QFile_FileError NoError

Description: Enum constant enum QFile::NoError

[static] QFile_FileError OpenError

Description: Enum constant enum QFile::OpenError

[static] QFile_FileError PermissionsError

Description: Enum constant enum QFile::PermissionsError

[static] QFile_FileError PositionError

Description: Enum constant enum QFile::PositionError

[static] QFile_FileError ReadError

Description: Enum constant enum QFile::ReadError

[static] QFile_Permission ReadGroup

Description: Enum constant enum QFile::ReadGroup

[static] QFile_Permission ReadOther

Description: Enum constant enum QFile::ReadOther

[static] QFile_Permission ReadOwner

Description: Enum constant enum QFile::ReadOwner

[static] QFile_Permission ReadUser

Description: Enum constant enum QFile::ReadUser

[static] QFile_FileError RemoveError

Description: Enum constant enum QFile::RemoveError

[static] QFile_FileError RenameError

Description: Enum constant enum QFile::RenameError

[static] QFile_FileError ResizeError

Description: Enum constant enum QFile::ResizeError

[static] QFile_FileError ResourceError

Description: Enum constant enum QFile::ResourceError

[static] QFile_FileError TimeOutError

Description: Enum constant enum QFile::TimeOutError

[static] QFile_FileError UnspecifiedError

Description: Enum constant enum QFile::UnspecifiedError

[static] QFile_FileError WriteError

Description: Enum constant enum QFile::WriteError

[static] QFile_Permission WriteGroup

Description: Enum constant enum QFile::WriteGroup

[static] QFile_Permission WriteOther

Description: Enum constant enum QFile::WriteOther

[static] QFile_Permission WriteOwner

Description: Enum constant enum QFile::WriteOwner

[static] QFile_Permission WriteUser

Description: Enum constant enum QFile::WriteUser

[const] bool atEnd

Description: Method bool QFile::atEnd()

This is a reimplementation of QIODevice::atEnd

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)

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

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.

[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 destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, 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.

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

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

[const] string fileName

Description: Method QString QFile::fileName()

void fileName=(string name)

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

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

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

bool link(string newName)

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

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

[static] new QFile new

Description: Constructor QFile::QFile()

This method creates an object of class QFile.

[static] new QFile new(QObject ptr parent)

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

This method creates an object of class QFile.

[static] new QFile new(string name)

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

This method creates an object of class QFile.

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

bool open(int flags)

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

This is a reimplementation of QIODevice::open

[const] int permissions

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

[static] int permissions(string filename)

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

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

bool permissions=(int permissionSpec)

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

[const] long long pos

Description: Method qint64 QFile::pos()

This is a reimplementation of QIODevice::pos

[const] string readLink

Description: Method QString QFile::readLink()

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

bool remove

Description: Method bool QFile::remove()

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

bool rename(string newName)

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

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

bool resize(long long sz)

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

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

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)

bool setPermissions(int permissionSpec)

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

[static] bool setPermissions(string filename,int permissionSpec)

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

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

[const] long long size

Description: Method qint64 QFile::size()

This is a reimplementation of QIODevice::size

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[const] string symLinkTarget

Description: Method QString QFile::symLinkTarget()

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

[static] string tr(string s)

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)

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)

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)

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()