API reference - Class QFileDevice

AbortError

Signature: [static,const] QFileDevice_FileError AbortError

Description: Enum constant QFileDevice::AbortError

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

CopyError

Signature: [static,const] QFileDevice_FileError CopyError

Description: Enum constant QFileDevice::CopyError

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

ExeGroup

Signature: [static,const] QFileDevice_Permission ExeGroup

Description: Enum constant QFileDevice::ExeGroup

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

ExeOther

Signature: [static,const] QFileDevice_Permission ExeOther

Description: Enum constant QFileDevice::ExeOther

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

ExeOwner

Signature: [static,const] QFileDevice_Permission ExeOwner

Description: Enum constant QFileDevice::ExeOwner

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

ExeUser

Signature: [static,const] QFileDevice_Permission ExeUser

Description: Enum constant QFileDevice::ExeUser

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

FatalError

Signature: [static,const] QFileDevice_FileError FatalError

Description: Enum constant QFileDevice::FatalError

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

FileAccessTime

Signature: [static,const] QFileDevice_FileTime FileAccessTime

Description: Enum constant QFileDevice::FileAccessTime

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

FileBirthTime

Signature: [static,const] QFileDevice_FileTime FileBirthTime

Description: Enum constant QFileDevice::FileBirthTime

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

FileMetadataChangeTime

Signature: [static,const] QFileDevice_FileTime FileMetadataChangeTime

Description: Enum constant QFileDevice::FileMetadataChangeTime

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

FileModificationTime

Signature: [static,const] QFileDevice_FileTime FileModificationTime

Description: Enum constant QFileDevice::FileModificationTime

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

NoError

Signature: [static,const] QFileDevice_FileError NoError

Description: Enum constant QFileDevice::NoError

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

OpenError

Signature: [static,const] QFileDevice_FileError OpenError

Description: Enum constant QFileDevice::OpenError

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

PermissionsError

Signature: [static,const] QFileDevice_FileError PermissionsError

Description: Enum constant QFileDevice::PermissionsError

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

PositionError

Signature: [static,const] QFileDevice_FileError PositionError

Description: Enum constant QFileDevice::PositionError

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

ReadError

Signature: [static,const] QFileDevice_FileError ReadError

Description: Enum constant QFileDevice::ReadError

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

ReadGroup

Signature: [static,const] QFileDevice_Permission ReadGroup

Description: Enum constant QFileDevice::ReadGroup

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

ReadOther

Signature: [static,const] QFileDevice_Permission ReadOther

Description: Enum constant QFileDevice::ReadOther

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

ReadOwner

Signature: [static,const] QFileDevice_Permission ReadOwner

Description: Enum constant QFileDevice::ReadOwner

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

ReadUser

Signature: [static,const] QFileDevice_Permission ReadUser

Description: Enum constant QFileDevice::ReadUser

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

RemoveError

Signature: [static,const] QFileDevice_FileError RemoveError

Description: Enum constant QFileDevice::RemoveError

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

RenameError

Signature: [static,const] QFileDevice_FileError RenameError

Description: Enum constant QFileDevice::RenameError

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

ResizeError

Signature: [static,const] QFileDevice_FileError ResizeError

Description: Enum constant QFileDevice::ResizeError

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

ResourceError

Signature: [static,const] QFileDevice_FileError ResourceError

Description: Enum constant QFileDevice::ResourceError

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

TimeOutError

Signature: [static,const] QFileDevice_FileError TimeOutError

Description: Enum constant QFileDevice::TimeOutError

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

UnspecifiedError

Signature: [static,const] QFileDevice_FileError UnspecifiedError

Description: Enum constant QFileDevice::UnspecifiedError

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

WriteError

Signature: [static,const] QFileDevice_FileError WriteError

Description: Enum constant QFileDevice::WriteError

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

WriteGroup

Signature: [static,const] QFileDevice_Permission WriteGroup

Description: Enum constant QFileDevice::WriteGroup

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

WriteOther

Signature: [static,const] QFileDevice_Permission WriteOther

Description: Enum constant QFileDevice::WriteOther

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

WriteOwner

Signature: [static,const] QFileDevice_Permission WriteOwner

Description: Enum constant QFileDevice::WriteOwner

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

WriteUser

Signature: [static,const] QFileDevice_Permission WriteUser

Description: Enum constant QFileDevice::WriteUser

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

_const_cast

Signature: [const] QFileDevice 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 QFileDevice::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: Virtual method bool QFileDevice::atEnd()

This method can be reimplemented in a derived class.

bytesAvailable

Signature: [const] long long bytesAvailable

Description: Virtual method qint64 QFileDevice::bytesAvailable()

This method can be reimplemented in a derived class.

bytesToWrite

Signature: [const] long long bytesToWrite

Description: Virtual method qint64 QFileDevice::bytesToWrite()

This method can be reimplemented in a derived class.

bytesWritten

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

Description: Signal declaration for QFileDevice::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.

canReadLine

Signature: [const] bool canReadLine

Description: Virtual method bool QFileDevice::canReadLine()

This method can be reimplemented in a derived class.

channelBytesWritten

Signature: [signal] void channelBytesWritten (int channel, long long bytes)

Description: Signal declaration for QFileDevice::channelBytesWritten(int channel, qint64 bytes)

You can bind a procedure to this signal.

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

channelReadyRead

Signature: [signal] void channelReadyRead (int channel)

Description: Signal declaration for QFileDevice::channelReadyRead(int channel)

You can bind a procedure to this signal.

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QFileDevice::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

close

Signature: void close

Description: Virtual method void QFileDevice::close()

This method can be reimplemented in a derived class.

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.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QFileDevice::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QFileDevice::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_aboutToClose

Signature: void emit_aboutToClose

Description: Emitter for signal void QFileDevice::aboutToClose()

Call this method to emit this signal.

emit_bytesWritten

Signature: void emit_bytesWritten (long long bytes)

Description: Emitter for signal void QFileDevice::bytesWritten(qint64 bytes)

Call this method to emit this signal.

emit_channelBytesWritten

Signature: void emit_channelBytesWritten (int channel, long long bytes)

Description: Emitter for signal void QFileDevice::channelBytesWritten(int channel, qint64 bytes)

Call this method to emit this signal.

emit_channelReadyRead

Signature: void emit_channelReadyRead (int channel)

Description: Emitter for signal void QFileDevice::channelReadyRead(int channel)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QFileDevice::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QFileDevice::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_readChannelFinished

Signature: void emit_readChannelFinished

Description: Emitter for signal void QFileDevice::readChannelFinished()

Call this method to emit this signal.

emit_readyRead

Signature: void emit_readyRead

Description: Emitter for signal void QFileDevice::readyRead()

Call this method to emit this signal.

error

Signature: [const] QFileDevice_FileError error

Description: Method QFileDevice::FileError QFileDevice::error()

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QFileDevice::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QFileDevice::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

fileName

Signature: [const] string fileName

Description: Virtual method QString QFileDevice::fileName()

This method can be reimplemented in a derived class.

fileTime

Signature: [const] QDateTime fileTime (const QFileDevice_FileTime time)

Description: Method QDateTime QFileDevice::fileTime(QFileDevice::FileTime time)

flush

Signature: bool flush

Description: Method bool QFileDevice::flush()

handle

Signature: [const] int handle

Description: Method int QFileDevice::handle()

isSequential

Signature: [const] bool isSequential

Description: Virtual method bool QFileDevice::isSequential()

This method can be reimplemented in a derived class.

isSequential?

Signature: [const] bool isSequential?

Description: Method bool QFileDevice::isSequential()

This is a reimplementation of QIODevice::isSequential

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QFileDevice::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

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.

new

Signature: [static] new QFileDevice ptr new

Description: Creates a new object of this class

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QFileDevice::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

open

Signature: bool open (QIODevice_QFlags_OpenModeFlag mode)

Description: Virtual method bool QFileDevice::open(QFlags<QIODevice::OpenModeFlag> mode)

This method can be reimplemented in a derived class.

permissions

Signature: [const] QFileDevice_QFlags_Permission permissions

Description: Virtual method QFlags<QFileDevice::Permission> QFileDevice::permissions()

This method can be reimplemented in a derived class.

pos

Signature: [const] long long pos

Description: Virtual method qint64 QFileDevice::pos()

This method can be reimplemented in a derived class.

readChannelFinished

Signature: [signal] void readChannelFinished

Description: Signal declaration for QFileDevice::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.

readyRead

Signature: [signal] void readyRead

Description: Signal declaration for QFileDevice::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.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QFileDevice::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

reset

Signature: bool reset

Description: Virtual method bool QFileDevice::reset()

This method can be reimplemented in a derived class.

resize

Signature: bool resize (long long sz)

Description: Virtual method bool QFileDevice::resize(qint64 sz)

This method can be reimplemented in a derived class.

seek

Signature: bool seek (long long offset)

Description: Virtual method bool QFileDevice::seek(qint64 offset)

This method can be reimplemented in a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QFileDevice::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QFileDevice::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setErrorString

Signature: void setErrorString (string errorString)

Description: Method void QFileDevice::setErrorString(const QString &errorString)

This method is protected and can only be called from inside a derived class.

setFileTime

Signature: bool setFileTime (const QDateTime newDate, const QFileDevice_FileTime fileTime)

Description: Method bool QFileDevice::setFileTime(const QDateTime &newDate, QFileDevice::FileTime fileTime)

setOpenMode

Signature: void setOpenMode (QIODevice_QFlags_OpenModeFlag openMode)

Description: Method void QFileDevice::setOpenMode(QFlags<QIODevice::OpenModeFlag> openMode)

This method is protected and can only be called from inside a derived class.

setPermissions

Signature: bool setPermissions (QFileDevice_QFlags_Permission permissionSpec)

Description: Virtual method bool QFileDevice::setPermissions(QFlags<QFileDevice::Permission> permissionSpec)

This method can be reimplemented in a derived class.

size

Signature: [const] long long size

Description: Virtual method qint64 QFileDevice::size()

This method can be reimplemented in a derived class.

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QFileDevice::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

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

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

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QFileDevice::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 QFileDevice::unsetError()

waitForBytesWritten

Signature: bool waitForBytesWritten (int msecs)

Description: Virtual method bool QFileDevice::waitForBytesWritten(int msecs)

This method can be reimplemented in a derived class.

waitForReadyRead

Signature: bool waitForReadyRead (int msecs)

Description: Virtual method bool QFileDevice::waitForReadyRead(int msecs)

This method can be reimplemented in a derived class.

writeData

Signature: long long writeData (string data, long long len)

Description: Virtual method qint64 QFileDevice::writeData(const char *data, qint64 len)

This method can be reimplemented in a derived class.