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

API reference - Class QFile

Description: Binding of QFile

Class hierarchy: QFile » QIODevice » QObject

Public constructors
Public methods
Public static methods and constants
Detailed description

Public constructors

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

Public methods

[const]	bool	atEnd		Method bool QFile::atEnd()
	void	close		Method void QFile::close()
	bool	copy	(string newName)	Method bool QFile::copy(const QString &newName)
	void	create		Ensures the C++ object is created
	void	destroy		Explicitly destroy the object
[const]	bool	destroyed?		Returns a value indicating whether the object was already destroyed
[const]	QFile_FileError	error		Method QFile::FileError QFile::error()
[const]	bool	exists		Method bool QFile::exists()
[const]	string	fileName		Method QString QFile::fileName()
	void	fileName=	(string name)	Method void QFile::setFileName(const QString &name)
	bool	flush		Method bool QFile::flush()
[const]	int	handle		Method int QFile::handle()
[const]	bool	isSequential		Method bool QFile::isSequential()
[const]	bool	isSequential?		Method bool QFile::isSequential()
[const]	bool	is_const_object?		Returns a value indicating whether the reference is a const reference
	bool	link	(string newName)	Method bool QFile::link(const QString &newName)
	bool	open	(const QIODevice_QFlags_OpenModeFlag flags)	Method bool QFile::open(QFlags<QIODevice::OpenModeFlag> flags)
[const]	QFile_QFlags_Permission	permissions		Method QFlags<QFile::Permission> QFile::permissions()
[const]	long long	pos		Method qint64 QFile::pos()
[const]	string	readLink		Method QString QFile::readLink()
	bool	remove		Method bool QFile::remove()
	bool	rename	(string newName)	Method bool QFile::rename(const QString &newName)
	bool	resize	(long long sz)	Method bool QFile::resize(qint64 sz)
	bool	seek	(long long offset)	Method bool QFile::seek(qint64 offset)
	void	setFileName	(string name)	Method void QFile::setFileName(const QString &name)
	bool	setPermissions	(const QFile_QFlags_Permission permissionSpec)	Method bool QFile::setPermissions(QFlags<QFile::Permission> permissionSpec)
[const]	long long	size		Method qint64 QFile::size()
[const]	string	symLinkTarget		Method QString QFile::symLinkTarget()
	void	unsetError		Method void QFile::unsetError()

Public static methods and constants

QFile_FileError	AbortError		Enum constant QFile::AbortError
QFile_FileError	CopyError		Enum constant QFile::CopyError
QFile_Permission	ExeGroup		Enum constant QFile::ExeGroup
QFile_Permission	ExeOther		Enum constant QFile::ExeOther
QFile_Permission	ExeOwner		Enum constant QFile::ExeOwner
QFile_Permission	ExeUser		Enum constant QFile::ExeUser
QFile_FileError	FatalError		Enum constant QFile::FatalError
QFile_FileError	NoError		Enum constant QFile::NoError
QFile_FileError	OpenError		Enum constant QFile::OpenError
QFile_FileError	PermissionsError		Enum constant QFile::PermissionsError
QFile_FileError	PositionError		Enum constant QFile::PositionError
QFile_FileError	ReadError		Enum constant QFile::ReadError
QFile_Permission	ReadGroup		Enum constant QFile::ReadGroup
QFile_Permission	ReadOther		Enum constant QFile::ReadOther
QFile_Permission	ReadOwner		Enum constant QFile::ReadOwner
QFile_Permission	ReadUser		Enum constant QFile::ReadUser
QFile_FileError	RemoveError		Enum constant QFile::RemoveError
QFile_FileError	RenameError		Enum constant QFile::RenameError
QFile_FileError	ResizeError		Enum constant QFile::ResizeError
QFile_FileError	ResourceError		Enum constant QFile::ResourceError
QFile_FileError	TimeOutError		Enum constant QFile::TimeOutError
QFile_FileError	UnspecifiedError		Enum constant QFile::UnspecifiedError
QFile_FileError	WriteError		Enum constant QFile::WriteError
QFile_Permission	WriteGroup		Enum constant QFile::WriteGroup
QFile_Permission	WriteOther		Enum constant QFile::WriteOther
QFile_Permission	WriteOwner		Enum constant QFile::WriteOwner
QFile_Permission	WriteUser		Enum constant QFile::WriteUser
bool	copy	(string fileName, string newName)	Static method bool QFile::copy(const QString &fileName, const QString &newName)
string	decodeName	(string localFileName)	Static method QString QFile::decodeName(const char *localFileName)
string	encodeName	(string fileName)	Static method QByteArray QFile::encodeName(const QString &fileName)
bool	exists	(string fileName)	Static method bool QFile::exists(const QString &fileName)
bool	link	(string oldname, string newName)	Static method bool QFile::link(const QString &oldname, const QString &newName)
QFile_QFlags_Permission	permissions	(string filename)	Static method QFlags<QFile::Permission> QFile::permissions(const QString &filename)
string	readLink	(string fileName)	Static method QString QFile::readLink(const QString &fileName)
bool	remove	(string fileName)	Static method bool QFile::remove(const QString &fileName)
bool	rename	(string oldName, string newName)	Static method bool QFile::rename(const QString &oldName, const QString &newName)
bool	resize	(string filename, long long sz)	Static method bool QFile::resize(const QString &filename, qint64 sz)
bool	setPermissions	(string filename, const QFile_QFlags_Permission permissionSpec)	Static method bool QFile::setPermissions(const QString &filename, QFlags<QFile::Permission> permissionSpec)
QMetaObject	staticMetaObject		Obtains the static MetaObject for this class.
string	symLinkTarget	(string fileName)	Static method QString QFile::symLinkTarget(const QString &fileName)
string	tr	(string s, string c = 0)	Static method QString QFile::tr(const char s, const char c)
string	tr	(string s, string c, int n)	Static method QString QFile::tr(const char s, const char c, int n)
string	trUtf8	(string s, string c = 0)	Static method QString QFile::trUtf8(const char s, const char c)
string	trUtf8	(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 QFile::AbortError

[static] QFile_FileError CopyError

Description: Enum constant QFile::CopyError

[static] QFile_Permission ExeGroup

Description: Enum constant QFile::ExeGroup

[static] QFile_Permission ExeOther

Description: Enum constant QFile::ExeOther

[static] QFile_Permission ExeOwner

Description: Enum constant QFile::ExeOwner

[static] QFile_Permission ExeUser

Description: Enum constant QFile::ExeUser

[static] QFile_FileError FatalError

Description: Enum constant QFile::FatalError

[static] QFile_FileError NoError

Description: Enum constant QFile::NoError

[static] QFile_FileError OpenError

Description: Enum constant QFile::OpenError

[static] QFile_FileError PermissionsError

Description: Enum constant QFile::PermissionsError

[static] QFile_FileError PositionError

Description: Enum constant QFile::PositionError

[static] QFile_FileError ReadError

Description: Enum constant QFile::ReadError

[static] QFile_Permission ReadGroup

Description: Enum constant QFile::ReadGroup

[static] QFile_Permission ReadOther

Description: Enum constant QFile::ReadOther

[static] QFile_Permission ReadOwner

Description: Enum constant QFile::ReadOwner

[static] QFile_Permission ReadUser

Description: Enum constant QFile::ReadUser

[static] QFile_FileError RemoveError

Description: Enum constant QFile::RemoveError

[static] QFile_FileError RenameError

Description: Enum constant QFile::RenameError

[static] QFile_FileError ResizeError

Description: Enum constant QFile::ResizeError

[static] QFile_FileError ResourceError

Description: Enum constant QFile::ResourceError

[static] QFile_FileError TimeOutError

Description: Enum constant QFile::TimeOutError

[static] QFile_FileError UnspecifiedError

Description: Enum constant QFile::UnspecifiedError

[static] QFile_FileError WriteError

Description: Enum constant QFile::WriteError

[static] QFile_Permission WriteGroup

Description: Enum constant QFile::WriteGroup

[static] QFile_Permission WriteOther

Description: Enum constant QFile::WriteOther

[static] QFile_Permission WriteOwner

Description: Enum constant QFile::WriteOwner

[static] QFile_Permission WriteUser

Description: Enum constant 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(string name)

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

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,QObject ptr parent)

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

This method creates an object of class QFile.

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

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

[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(const QFile_QFlags_Permission permissionSpec)

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

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

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