API reference - Class QSaveFile

_const_cast

Signature: [const] QSaveFile 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 QSaveFile::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 QSaveFile::atEnd()

This method can be reimplemented in a derived class.

bytesAvailable

Signature: [const] long long bytesAvailable

Description: Virtual method qint64 QSaveFile::bytesAvailable()

This method can be reimplemented in a derived class.

bytesToWrite

Signature: [const] long long bytesToWrite

Description: Virtual method qint64 QSaveFile::bytesToWrite()

This method can be reimplemented in a derived class.

bytesWritten

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

Description: Signal declaration for QSaveFile::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 QSaveFile::canReadLine()

This method can be reimplemented in a derived class.

cancelWriting

Signature: void cancelWriting

Description: Method void QSaveFile::cancelWriting()

channelBytesWritten

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

Description: Signal declaration for QSaveFile::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 QSaveFile::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 QSaveFile::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

commit

Signature: bool commit

Description: Method bool QSaveFile::commit()

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

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

directWriteFallback

Signature: [const] bool directWriteFallback

Description: Method bool QSaveFile::directWriteFallback()

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

directWriteFallback=

Signature: void directWriteFallback= (bool enabled)

Description: Method void QSaveFile::setDirectWriteFallback(bool enabled)

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

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

This method can be reimplemented in a derived class.

emit_aboutToClose

Signature: void emit_aboutToClose

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

Call this method to emit this signal.

emit_bytesWritten

Signature: void emit_bytesWritten (long long bytes)

Description: Emitter for signal void QSaveFile::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 QSaveFile::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 QSaveFile::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 QSaveFile::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_readChannelFinished

Signature: void emit_readChannelFinished

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

Call this method to emit this signal.

emit_readyRead

Signature: void emit_readyRead

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QSaveFile::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 QSaveFile::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

fileName

Signature: [const] string fileName

Description: Virtual method QString QSaveFile::fileName()

This method can be reimplemented in a derived class.

fileName=

Signature: void fileName= (string name)

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

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

isSequential

Signature: [const] bool isSequential

Description: Virtual method bool QSaveFile::isSequential()

This method can be reimplemented in a derived class.

isSignalConnected

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

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

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

new

(1) Signature: [static] new QSaveFile new (string name)

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

This method creates an object of class QSaveFile.

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

(2) Signature: [static] new QSaveFile new (QObject ptr parent = nullptr)

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

This method creates an object of class QSaveFile.

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

(3) Signature: [static] new QSaveFile new (string name, QObject ptr parent)

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

This method creates an object of class QSaveFile.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QSaveFile::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 flags)

Description: Virtual method bool QSaveFile::open(QFlags<QIODevice::OpenModeFlag> flags)

This method can be reimplemented in a derived class.

permissions

Signature: [const] QFileDevice_QFlags_Permission permissions

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

This method can be reimplemented in a derived class.

pos

Signature: [const] long long pos

Description: Virtual method qint64 QSaveFile::pos()

This method can be reimplemented in a derived class.

readChannelFinished

Signature: [signal] void readChannelFinished

Description: Signal declaration for QSaveFile::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 QSaveFile::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 QSaveFile::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 QSaveFile::reset()

This method can be reimplemented in a derived class.

resize

Signature: bool resize (long long sz)

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

This method can be reimplemented in a derived class.

seek

Signature: bool seek (long long offset)

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

This method can be reimplemented in a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QSaveFile::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QSaveFile::senderSignalIndex()

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

setDirectWriteFallback

Signature: void setDirectWriteFallback (bool enabled)

Description: Method void QSaveFile::setDirectWriteFallback(bool enabled)

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

setErrorString

Signature: void setErrorString (string errorString)

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

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

setFileName

Signature: void setFileName (string name)

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

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

setOpenMode

Signature: void setOpenMode (QIODevice_QFlags_OpenModeFlag openMode)

Description: Method void QSaveFile::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 QSaveFile::setPermissions(QFlags<QFileDevice::Permission> permissionSpec)

This method can be reimplemented in a derived class.

size

Signature: [const] long long size

Description: Virtual method qint64 QSaveFile::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 QSaveFile::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 QSaveFile::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 QSaveFile::trUtf8(const char *s, const char *c, int n)

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

waitForBytesWritten

Signature: bool waitForBytesWritten (int msecs)

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

This method can be reimplemented in a derived class.

waitForReadyRead

Signature: bool waitForReadyRead (int msecs)

Description: Virtual method bool QSaveFile::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 QSaveFile::writeData(const char *data, qint64 len)

This method can be reimplemented in a derived class.