API reference - Class QTextStream

AlignAccountingStyle

Signature: [static,const] QTextStream_FieldAlignment AlignAccountingStyle

Description: Enum constant QTextStream::AlignAccountingStyle

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

AlignCenter

Signature: [static,const] QTextStream_FieldAlignment AlignCenter

Description: Enum constant QTextStream::AlignCenter

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

AlignLeft

Signature: [static,const] QTextStream_FieldAlignment AlignLeft

Description: Enum constant QTextStream::AlignLeft

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

AlignRight

Signature: [static,const] QTextStream_FieldAlignment AlignRight

Description: Enum constant QTextStream::AlignRight

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

FixedNotation

Signature: [static,const] QTextStream_RealNumberNotation FixedNotation

Description: Enum constant QTextStream::FixedNotation

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

ForcePoint

Signature: [static,const] QTextStream_NumberFlag ForcePoint

Description: Enum constant QTextStream::ForcePoint

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

ForceSign

Signature: [static,const] QTextStream_NumberFlag ForceSign

Description: Enum constant QTextStream::ForceSign

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

Ok

Signature: [static,const] QTextStream_Status Ok

Description: Enum constant QTextStream::Ok

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

ReadCorruptData

Signature: [static,const] QTextStream_Status ReadCorruptData

Description: Enum constant QTextStream::ReadCorruptData

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

ReadPastEnd

Signature: [static,const] QTextStream_Status ReadPastEnd

Description: Enum constant QTextStream::ReadPastEnd

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

ScientificNotation

Signature: [static,const] QTextStream_RealNumberNotation ScientificNotation

Description: Enum constant QTextStream::ScientificNotation

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

ShowBase

Signature: [static,const] QTextStream_NumberFlag ShowBase

Description: Enum constant QTextStream::ShowBase

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

SmartNotation

Signature: [static,const] QTextStream_RealNumberNotation SmartNotation

Description: Enum constant QTextStream::SmartNotation

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

UppercaseBase

Signature: [static,const] QTextStream_NumberFlag UppercaseBase

Description: Enum constant QTextStream::UppercaseBase

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

UppercaseDigits

Signature: [static,const] QTextStream_NumberFlag UppercaseDigits

Description: Enum constant QTextStream::UppercaseDigits

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

WriteFailed

Signature: [static,const] QTextStream_Status WriteFailed

Description: Enum constant QTextStream::WriteFailed

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

_const_cast

Signature: [const] QTextStream 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.

atEnd

Signature: [const] bool atEnd

Description: Method bool QTextStream::atEnd()

autoDetectUnicode

Signature: [const] bool autoDetectUnicode

Description: Method bool QTextStream::autoDetectUnicode()

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

autoDetectUnicode=

Signature: void autoDetectUnicode= (bool enabled)

Description: Method void QTextStream::setAutoDetectUnicode(bool enabled)

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

codec

Signature: [const] QTextCodec ptr codec

Description: Method QTextCodec *QTextStream::codec()

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

codec=

(1) Signature: void codec= (QTextCodec ptr codec)

Description: Method void QTextStream::setCodec(QTextCodec *codec)

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

(2) Signature: void codec= (string codecName)

Description: Method void QTextStream::setCodec(const char *codecName)

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

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.

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: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

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.

device

Signature: [const] QIODevice ptr device

Description: Method QIODevice *QTextStream::device()

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

device=

Signature: void device= (QIODevice ptr device)

Description: Method void QTextStream::setDevice(QIODevice *device)

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

fieldAlignment

Signature: [const] QTextStream_FieldAlignment fieldAlignment

Description: Method QTextStream::FieldAlignment QTextStream::fieldAlignment()

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

fieldAlignment=

Signature: void fieldAlignment= (const QTextStream_FieldAlignment alignment)

Description: Method void QTextStream::setFieldAlignment(QTextStream::FieldAlignment alignment)

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

fieldWidth

Signature: [const] int fieldWidth

Description: Method int QTextStream::fieldWidth()

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

fieldWidth=

Signature: void fieldWidth= (int width)

Description: Method void QTextStream::setFieldWidth(int width)

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

flush

Signature: void flush

Description: Method void QTextStream::flush()

generateByteOrderMark

Signature: [const] bool generateByteOrderMark

Description: Method bool QTextStream::generateByteOrderMark()

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

generateByteOrderMark=

Signature: void generateByteOrderMark= (bool generate)

Description: Method void QTextStream::setGenerateByteOrderMark(bool generate)

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

integerBase

Signature: [const] int integerBase

Description: Method int QTextStream::integerBase()

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

integerBase=

Signature: void integerBase= (int base)

Description: Method void QTextStream::setIntegerBase(int base)

Python specific notes:
The object exposes a writable attribute 'integerBase'. 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.

locale

Signature: [const] QLocale locale

Description: Method QLocale QTextStream::locale()

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

locale=

Signature: void locale= (const QLocale locale)

Description: Method void QTextStream::setLocale(const QLocale &locale)

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

new

(1) Signature: [static] new QTextStream new

Description: Constructor QTextStream::QTextStream()

This method creates an object of class QTextStream.

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

(2) Signature: [static] new QTextStream new (QIODevice ptr device)

Description: Constructor QTextStream::QTextStream(QIODevice *device)

This method creates an object of class QTextStream.

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

(3) Signature: [static] new QTextStream new (string ptr string, QIODevice_QFlags_OpenModeFlag openMode = QIODevice::ReadWrite)

Description: Constructor QTextStream::QTextStream(QString *string, QFlags<QIODevice::OpenModeFlag> openMode)

This method creates an object of class QTextStream.

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

numberFlags

Signature: [const] QTextStream_QFlags_NumberFlag numberFlags

Description: Method QFlags<QTextStream::NumberFlag> QTextStream::numberFlags()

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

numberFlags=

Signature: void numberFlags= (QTextStream_QFlags_NumberFlag flags)

Description: Method void QTextStream::setNumberFlags(QFlags<QTextStream::NumberFlag> flags)

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

padChar

Signature: [const] unsigned int padChar

Description: Method QChar QTextStream::padChar()

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

padChar=

Signature: void padChar= (unsigned int ch)

Description: Method void QTextStream::setPadChar(QChar ch)

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

pos

Signature: [const] long long pos

Description: Method qint64 QTextStream::pos()

put_ba

Signature: QTextStream ptr put_ba (bytes arg1)

Description: Non-ambiguous adaptation of the corresponding operator<<

put_d

Signature: QTextStream ptr put_d (double arg1)

Description: Non-ambiguous adaptation of the corresponding operator<<

put_f

Signature: QTextStream ptr put_f (float arg1)

Description: Non-ambiguous adaptation of the corresponding operator<<

put_i

Signature: QTextStream ptr put_i (int arg1)

Description: Non-ambiguous adaptation of the corresponding operator<<

put_ll

Signature: QTextStream ptr put_ll (long long arg1)

Description: Non-ambiguous adaptation of the corresponding operator<<

put_qc

Signature: QTextStream ptr put_qc (unsigned int arg1)

Description: Non-ambiguous adaptation of the corresponding operator<<

put_s

(1) Signature: QTextStream ptr put_s (short arg1)

Description: Non-ambiguous adaptation of the corresponding operator<<

(2) Signature: QTextStream ptr put_s (string arg1)

Description: Non-ambiguous adaptation of the corresponding operator<<

put_ui

Signature: QTextStream ptr put_ui (unsigned int arg1)

Description: Non-ambiguous adaptation of the corresponding operator<<

put_ull

Signature: QTextStream ptr put_ull (unsigned long long arg1)

Description: Non-ambiguous adaptation of the corresponding operator<<

put_us

Signature: QTextStream ptr put_us (unsigned short arg1)

Description: Non-ambiguous adaptation of the corresponding operator<<

read

Signature: string read (long long maxlen)

Description: Method QString QTextStream::read(qint64 maxlen)

readAll

Signature: string readAll

Description: Method QString QTextStream::readAll()

readLine

Signature: string readLine (long long maxlen = 0)

Description: Method QString QTextStream::readLine(qint64 maxlen)

readLineInto

Signature: bool readLineInto (string ptr line, long long maxlen = 0)

Description: Method bool QTextStream::readLineInto(QString *line, qint64 maxlen)

read_ba

Signature: bytes read_ba

Description: Non-ambiguous adaptation of the corresponding operator>>

read_d

Signature: double read_d

Description: Non-ambiguous adaptation of the corresponding operator>>

read_f

Signature: float read_f

Description: Non-ambiguous adaptation of the corresponding operator>>

read_i

Signature: int read_i

Description: Non-ambiguous adaptation of the corresponding operator>>

read_ll

Signature: long long read_ll

Description: Non-ambiguous adaptation of the corresponding operator>>

read_qc

Signature: unsigned int read_qc

Description: Non-ambiguous adaptation of the corresponding operator>>

read_s

(1) Signature: short read_s

Description: Non-ambiguous adaptation of the corresponding operator>>

(2) Signature: string read_s

Description: Non-ambiguous adaptation of the corresponding operator>>

read_ui

Signature: unsigned int read_ui

Description: Non-ambiguous adaptation of the corresponding operator>>

read_ull

Signature: unsigned long long read_ull

Description: Non-ambiguous adaptation of the corresponding operator>>

read_us

Signature: unsigned short read_us

Description: Non-ambiguous adaptation of the corresponding operator>>

realNumberNotation

Signature: [const] QTextStream_RealNumberNotation realNumberNotation

Description: Method QTextStream::RealNumberNotation QTextStream::realNumberNotation()

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

realNumberNotation=

Signature: void realNumberNotation= (const QTextStream_RealNumberNotation notation)

Description: Method void QTextStream::setRealNumberNotation(QTextStream::RealNumberNotation notation)

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

realNumberPrecision

Signature: [const] int realNumberPrecision

Description: Method int QTextStream::realNumberPrecision()

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

realNumberPrecision=

Signature: void realNumberPrecision= (int precision)

Description: Method void QTextStream::setRealNumberPrecision(int precision)

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

reset

Signature: void reset

Description: Method void QTextStream::reset()

resetStatus

Signature: void resetStatus

Description: Method void QTextStream::resetStatus()

seek

Signature: bool seek (long long pos)

Description: Method bool QTextStream::seek(qint64 pos)

setAutoDetectUnicode

Signature: void setAutoDetectUnicode (bool enabled)

Description: Method void QTextStream::setAutoDetectUnicode(bool enabled)

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

setCodec

(1) Signature: void setCodec (QTextCodec ptr codec)

Description: Method void QTextStream::setCodec(QTextCodec *codec)

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

(2) Signature: void setCodec (string codecName)

Description: Method void QTextStream::setCodec(const char *codecName)

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

setDevice

Signature: void setDevice (QIODevice ptr device)

Description: Method void QTextStream::setDevice(QIODevice *device)

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

setFieldAlignment

Signature: void setFieldAlignment (const QTextStream_FieldAlignment alignment)

Description: Method void QTextStream::setFieldAlignment(QTextStream::FieldAlignment alignment)

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

setFieldWidth

Signature: void setFieldWidth (int width)

Description: Method void QTextStream::setFieldWidth(int width)

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

setGenerateByteOrderMark

Signature: void setGenerateByteOrderMark (bool generate)

Description: Method void QTextStream::setGenerateByteOrderMark(bool generate)

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

setIntegerBase

Signature: void setIntegerBase (int base)

Description: Method void QTextStream::setIntegerBase(int base)

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

setLocale

Signature: void setLocale (const QLocale locale)

Description: Method void QTextStream::setLocale(const QLocale &locale)

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

setNumberFlags

Signature: void setNumberFlags (QTextStream_QFlags_NumberFlag flags)

Description: Method void QTextStream::setNumberFlags(QFlags<QTextStream::NumberFlag> flags)

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

setPadChar

Signature: void setPadChar (unsigned int ch)

Description: Method void QTextStream::setPadChar(QChar ch)

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

setRealNumberNotation

Signature: void setRealNumberNotation (const QTextStream_RealNumberNotation notation)

Description: Method void QTextStream::setRealNumberNotation(QTextStream::RealNumberNotation notation)

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

setRealNumberPrecision

Signature: void setRealNumberPrecision (int precision)

Description: Method void QTextStream::setRealNumberPrecision(int precision)

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

setStatus

Signature: void setStatus (const QTextStream_Status status)

Description: Method void QTextStream::setStatus(QTextStream::Status status)

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

setString

Signature: void setString (string ptr string, QIODevice_QFlags_OpenModeFlag openMode = QIODevice::ReadWrite)

Description: Method void QTextStream::setString(QString *string, QFlags<QIODevice::OpenModeFlag> openMode)

skipWhiteSpace

Signature: void skipWhiteSpace

Description: Method void QTextStream::skipWhiteSpace()

status

Signature: [const] QTextStream_Status status

Description: Method QTextStream::Status QTextStream::status()

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

status=

Signature: void status= (const QTextStream_Status status)

Description: Method void QTextStream::setStatus(QTextStream::Status status)

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

string

Signature: [const] string ptr string

Description: Method QString *QTextStream::string()

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