API reference - Class QTextCodec

ConvertInvalidToNull

Signature: [static,const] QTextCodec_ConversionFlag ConvertInvalidToNull

Description: Enum constant QTextCodec::ConvertInvalidToNull

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

DefaultConversion

Signature: [static,const] QTextCodec_ConversionFlag DefaultConversion

Description: Enum constant QTextCodec::DefaultConversion

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

FreeFunction

Signature: [static,const] QTextCodec_ConversionFlag FreeFunction

Description: Enum constant QTextCodec::FreeFunction

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

IgnoreHeader

Signature: [static,const] QTextCodec_ConversionFlag IgnoreHeader

Description: Enum constant QTextCodec::IgnoreHeader

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

_const_cast

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

aliases

Signature: [const] bytes[] aliases

Description: Virtual method QList<QByteArray> QTextCodec::aliases()

This method can be reimplemented in a derived class.

availableCodecs

Signature: [static] bytes[] availableCodecs

Description: Static method QList<QByteArray> QTextCodec::availableCodecs()

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

availableMibs

Signature: [static] int[] availableMibs

Description: Static method QList<int> QTextCodec::availableMibs()

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

canEncode

(1) Signature: [const] bool canEncode (unsigned int arg1)

Description: Method bool QTextCodec::canEncode(QChar)

(2) Signature: [const] bool canEncode (string arg1)

Description: Method bool QTextCodec::canEncode(const QString &)

codecForHtml

(1) Signature: [static] QTextCodec ptr codecForHtml (bytes ba)

Description: Static method QTextCodec *QTextCodec::codecForHtml(const QByteArray &ba)

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

(2) Signature: [static] QTextCodec ptr codecForHtml (bytes ba, QTextCodec ptr defaultCodec)

Description: Static method QTextCodec *QTextCodec::codecForHtml(const QByteArray &ba, QTextCodec *defaultCodec)

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

codecForLocale

Signature: [static] QTextCodec ptr codecForLocale

Description: Static method QTextCodec *QTextCodec::codecForLocale()

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

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

codecForLocale=

Signature: [static] void codecForLocale= (QTextCodec ptr c)

Description: Static method void QTextCodec::setCodecForLocale(QTextCodec *c)

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

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

codecForMib

Signature: [static] QTextCodec ptr codecForMib (int mib)

Description: Static method QTextCodec *QTextCodec::codecForMib(int mib)

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

codecForName

Signature: [static] QTextCodec ptr codecForName (string name)

Description: Static method QTextCodec *QTextCodec::codecForName(const char *name)

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

codecForUtfText

(1) Signature: [static] QTextCodec ptr codecForUtfText (bytes ba)

Description: Static method QTextCodec *QTextCodec::codecForUtfText(const QByteArray &ba)

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

(2) Signature: [static] QTextCodec ptr codecForUtfText (bytes ba, QTextCodec ptr defaultCodec)

Description: Static method QTextCodec *QTextCodec::codecForUtfText(const QByteArray &ba, QTextCodec *defaultCodec)

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

convertFromUnicode

Signature: [const] bytes convertFromUnicode (unsigned int ptr in, int length, QTextCodec_ConverterState ptr state)

Description: Virtual method QByteArray QTextCodec::convertFromUnicode(const QChar *in, int length, QTextCodec::ConverterState *state)

This method can be reimplemented in a derived class.

convertToUnicode

Signature: [const] string convertToUnicode (string in, int length, QTextCodec_ConverterState ptr state)

Description: Virtual method QString QTextCodec::convertToUnicode(const char *in, int length, QTextCodec::ConverterState *state)

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.

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.

fromUnicode

Signature: [const] bytes fromUnicode (string uc)

Description: Method QByteArray QTextCodec::fromUnicode(const QString &uc)

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.

makeDecoder

Signature: [const] QTextDecoder ptr makeDecoder (QTextCodec_QFlags_ConversionFlag flags = QTextCodec::DefaultConversion)

Description: Method QTextDecoder *QTextCodec::makeDecoder(QFlags<QTextCodec::ConversionFlag> flags)

makeEncoder

Signature: [const] QTextEncoder ptr makeEncoder (QTextCodec_QFlags_ConversionFlag flags = QTextCodec::DefaultConversion)

Description: Method QTextEncoder *QTextCodec::makeEncoder(QFlags<QTextCodec::ConversionFlag> flags)

mibEnum

Signature: [const] int mibEnum

Description: Virtual method int QTextCodec::mibEnum()

This method can be reimplemented in a derived class.

name

Signature: [const] bytes name

Description: Virtual method QByteArray QTextCodec::name()

This method can be reimplemented in a derived class.

new

Signature: [static] new QTextCodec new

Description: Constructor QTextCodec::QTextCodec()

This method creates an object of class QTextCodec.

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

setCodecForLocale

Signature: [static] void setCodecForLocale (QTextCodec ptr c)

Description: Static method void QTextCodec::setCodecForLocale(QTextCodec *c)

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

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

toUnicode

(1) Signature: [const] string toUnicode (string chars)

Description: Method QString QTextCodec::toUnicode(const char *chars)

(2) Signature: [const] string toUnicode (string in, int length, QTextCodec_ConverterState ptr state = nullptr)

Description: Method QString QTextCodec::toUnicode(const char *in, int length, QTextCodec::ConverterState *state)