API reference - Class QBuffer

_const_cast

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

This is a reimplementation of QIODevice::atEnd

buffer

(1) Signature: bytes buffer

Description: Method QByteArray &QBuffer::buffer()

(2) Signature: [const] bytes buffer

Description: Method const QByteArray &QBuffer::buffer()

bytesWritten

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

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

This is a reimplementation of QIODevice::canReadLine

close

Signature: void close

Description: Method void QBuffer::close()

This is a reimplementation of QIODevice::close

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.

data

Signature: [const] bytes data

Description: Method const QByteArray &QBuffer::data()

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

data=

Signature: void data= (bytes data)

Description: Method void QBuffer::setData(const QByteArray &data)

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

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

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

(1) Signature: [static] new QBuffer new (QObject ptr parent = 0)

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

This method creates an object of class QBuffer.

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

(2) Signature: [static] new QBuffer new (bytes ptr buf, QObject ptr parent = 0)

Description: Constructor QBuffer::QBuffer(QByteArray *buf, QObject *parent)

This method creates an object of class QBuffer.

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

open

Signature: bool open (QIODevice_QFlags_OpenModeFlag openMode)

Description: Method bool QBuffer::open(QFlags<QIODevice::OpenModeFlag> openMode)

This is a reimplementation of QIODevice::open

pos

Signature: [const] long long pos

Description: Method qint64 QBuffer::pos()

This is a reimplementation of QIODevice::pos

readChannelFinished

Signature: [signal] void readChannelFinished

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

seek

Signature: bool seek (long long off)

Description: Method bool QBuffer::seek(qint64 off)

This is a reimplementation of QIODevice::seek

setBuffer

Signature: void setBuffer (bytes ptr a)

Description: Method void QBuffer::setBuffer(QByteArray *a)

setData

(1) Signature: void setData (bytes data)

Description: Method void QBuffer::setData(const QByteArray &data)

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

(2) Signature: void setData (string data, int len)

Description: Method void QBuffer::setData(const char *data, int len)

size

Signature: [const] long long size

Description: Method qint64 QBuffer::size()

This is a reimplementation of QIODevice::size

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

tr

(1) Signature: [static] string tr (string s, string c = 0)

Description: Static method QString QBuffer::tr(const char *s, const char *c)

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

(2) Signature: [static] string tr (string s, string c, int n)

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

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

trUtf8

(1) Signature: [static] string trUtf8 (string s, string c = 0)

Description: Static method QString QBuffer::trUtf8(const char *s, const char *c)

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

(2) Signature: [static] string trUtf8 (string s, string c, int n)

Description: Static method QString QBuffer::trUtf8(const char *s, const char *c, int n)

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