QTextCodec Class

QByteArray encodedString = "...";
QTextCodec *codec = QTextCodec::codecForName("KOI8-R");
QString string = codec->toUnicode(encodedString);

QString string = "...";
QTextCodec *codec = QTextCodec::codecForName("KOI8-R");
QByteArray encodedString = codec->fromUnicode(string);

QTextCodec *codec = QTextCodec::codecForName("Shift-JIS");
QTextDecoder *decoder = codec->makeDecoder();

QString string;
while (new_data_available()) {
    QByteArray chunk = get_new_data();
    string += decoder->toUnicode(chunk);
}
delete decoder;

Member Function Documentation

[protected] QTextCodec::QTextCodec()

Constructs a QTextCodec, and gives it the highest precedence. The QTextCodec should always be constructed on the heap (i.e. with new). Qt takes ownership and will delete it when the application terminates.

[virtual noexcept protected] QTextCodec::~QTextCodec()

Destroys the QTextCodec. Note that you should not delete codecs yourself: once created they become Qt's responsibility.

Warning: This function is not reentrant.

[virtual] QList<QByteArray> QTextCodec::aliases() const

Subclasses can return a number of aliases for the codec in question.

Standard aliases for codecs can be found in the IANA character-sets encoding file.

[static] QList<QByteArray> QTextCodec::availableCodecs()

Returns the list of all available codecs, by name. Call QTextCodec::codecForName() to obtain the QTextCodec for the name.

The list may contain many mentions of the same codec if the codec has aliases.

Note: This function is thread-safe.

See also availableMibs(), name(), and aliases().

[static] QList<int> QTextCodec::availableMibs()

Returns the list of MIBs for all available codecs. Call QTextCodec::codecForMib() to obtain the QTextCodec for the MIB.

Note: This function is thread-safe.

See also availableCodecs() and mibEnum().

bool QTextCodec::canEncode(QChar ch) const

Returns true if the Unicode character ch can be fully encoded with this codec; otherwise returns false.

bool QTextCodec::canEncode(QStringView s) const

This is an overloaded function.

Returns true if the Unicode string s can be fully encoded with this codec; otherwise returns false.

bool QTextCodec::canEncode(const QString &s) const

This is an overloaded function.

s contains the string being tested for encode-ability.

[static] QTextCodec *QTextCodec::codecForHtml(const QByteArray &ba, QTextCodec *defaultCodec)

Tries to detect the encoding of the provided snippet of HTML in the given byte array, ba, by checking the BOM (Byte Order Mark) and the content-type meta header and returns a QTextCodec instance that is capable of decoding the html to unicode. If the codec cannot be detected from the content provided, defaultCodec is returned.

See also codecForUtfText().

[static] QTextCodec *QTextCodec::codecForHtml(const QByteArray &ba)

This is an overloaded function.

Tries to detect the encoding of the provided snippet of HTML in the given byte array, ba, by checking the BOM (Byte Order Mark) and the content-type meta header and returns a QTextCodec instance that is capable of decoding the html to unicode. If the codec cannot be detected, this overload returns a Latin-1 QTextCodec.

[static] QTextCodec *QTextCodec::codecForLocale()

Returns a pointer to the codec most suitable for this locale.

The codec will be retrieved from ICU where that backend is in use, otherwise it may be obtained from an OS-specific API. In the latter case, the codec's name may be "System".

Note: This function is thread-safe.

See also setCodecForLocale().

[static] QTextCodec *QTextCodec::codecForMib(int mib)

Returns the QTextCodec which matches the MIBenum mib.

Note: This function is thread-safe.

[static] QTextCodec *QTextCodec::codecForName(const QByteArray &name)

Searches all installed QTextCodec objects and returns the one which best matches name; the match is case-insensitive. Returns nullptr if no codec matching the name name could be found.

Note: This function is thread-safe.

[static] QTextCodec *QTextCodec::codecForName(const char *name)

Searches all installed QTextCodec objects and returns the one which best matches name; the match is case-insensitive. Returns nullptr if no codec matching the name name could be found.

[static] QTextCodec *QTextCodec::codecForUtfText(const QByteArray &ba, QTextCodec *defaultCodec)

Tries to detect the encoding of the provided snippet ba by using the BOM (Byte Order Mark) and returns a QTextCodec instance that is capable of decoding the text to unicode. This function can detect one of the following codecs:

• UTF-32 Little Endian
• UTF-32 Big Endian
• UTF-16 Little Endian
• UTF-16 Big Endian
• UTF-8

If the codec cannot be detected from the content provided, defaultCodec is returned.

See also codecForHtml().

[static] QTextCodec *QTextCodec::codecForUtfText(const QByteArray &ba)

This is an overloaded function.

Tries to detect the encoding of the provided snippet ba by using the BOM (Byte Order Mark) and returns a QTextCodec instance that is capable of decoding the text to unicode. This function can detect one of the following codecs:

• UTF-32 Little Endian
• UTF-32 Big Endian
• UTF-16 Little Endian
• UTF-16 Big Endian
• UTF-8

If the codec cannot be detected from the content provided, this overload returns a Latin-1 QTextCodec.

See also codecForHtml().

[pure virtual protected] QByteArray QTextCodec::convertFromUnicode(const QChar *input, int number, QTextCodec::ConverterState *state) const

QTextCodec subclasses must reimplement this function.

Converts the first number of characters from the input array from Unicode to the encoding of the subclass, and returns the result in a QByteArray.

state can be nullptr in which case the conversion is stateless and default conversion rules should be used. If state is not nullptr, the codec should save the state after the conversion in state, and adjust the remainingChars and invalidChars members of the struct.

[pure virtual protected] QString QTextCodec::convertToUnicode(const char *chars, int len, QTextCodec::ConverterState *state) const

QTextCodec subclasses must reimplement this function.

Converts the first len characters of chars from the encoding of the subclass to Unicode, and returns the result in a QString.

state can be nullptr, in which case the conversion is stateless and default conversion rules should be used. If state is not nullptr, the codec should save the state after the conversion in state, and adjust the remainingChars and invalidChars members of the struct.

QByteArray QTextCodec::fromUnicode(const QString &str) const

Converts str from Unicode to the encoding of this codec, and returns the result in a QByteArray.

QByteArray QTextCodec::fromUnicode(const QChar *input, int number, QTextCodec::ConverterState *state = nullptr) const

Converts the first number of characters from the input array from Unicode to the encoding of this codec, and returns the result in a QByteArray.

The state of the convertor used is updated.

QByteArray QTextCodec::fromUnicode(QStringView str) const

This is an overloaded function.

Converts str from Unicode to the encoding of this codec, and returns the result in a QByteArray.

QTextDecoder *QTextCodec::makeDecoder(QTextCodec::ConversionFlags flags = DefaultConversion) const

Creates a QTextDecoder with a specified flags to decode chunks of char * data to create chunks of Unicode data.

The caller is responsible for deleting the returned object.

QTextEncoder *QTextCodec::makeEncoder(QTextCodec::ConversionFlags flags = DefaultConversion) const

Creates a QTextEncoder with a specified flags to encode chunks of Unicode data as char * data.

The caller is responsible for deleting the returned object.

[pure virtual] int QTextCodec::mibEnum() const

Subclasses of QTextCodec must reimplement this function. It returns the MIBenum (see IANA character-sets encoding file for more information). It is important that each QTextCodec subclass returns the correct unique value for this function.

[pure virtual] QByteArray QTextCodec::name() const

QTextCodec subclasses must reimplement this function. It returns the name of the encoding supported by the subclass.

If the codec is registered as a character set in the IANA character-sets encoding file this method should return the preferred mime name for the codec if defined, otherwise its name.

[static] void QTextCodec::setCodecForLocale(QTextCodec *c)

Set the codec to c; this will be returned by codecForLocale(). If c is nullptr, the codec is reset to the default.

This might be needed for some applications that want to use their own mechanism for setting the locale.

Warning: This function is not reentrant.

See also codecForLocale().

QString QTextCodec::toUnicode(const QByteArray &a) const

Converts a from the encoding of this codec to Unicode, and returns the result in a QString.

QString QTextCodec::toUnicode(const char *input, int size, QTextCodec::ConverterState *state = nullptr) const

Converts the first size characters from the input from the encoding of this codec to Unicode, and returns the result in a QString.

The state of the convertor used is updated.

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

This is an overloaded function.

chars contains the source characters.