KDECore
KCharsets Class Reference
#include <kcharsets.h>
Detailed Description
Charset font and encoder/decoder handling.This is needed, because Qt's encoding name matching in QTextCodec::codecForName matches only closely-related encoded names but not alternate names, e.g. found in the reality of the Internet.
Definition at line 46 of file kcharsets.h.
Public Member Functions | |
QStringList | availableEncodingNames () const |
QTextCodec * | codecForName (const QString &n, bool &ok) const |
QTextCodec * | codecForName (const QString &name) const |
QString | descriptionForEncoding (const QString &encoding) const |
QStringList | descriptiveEncodingNames () const |
QString | encodingForName (const QString &descriptiveName) const |
QList< QStringList > | encodingsByScript () const |
QString | languageForEncoding (const QString &encoding) const |
virtual | ~KCharsets () |
Static Public Member Functions | |
static QChar | fromEntity (const QString &str, int &len) |
static QChar | fromEntity (const QString &str) |
static QString | resolveEntities (const QString &text) |
static QString | toEntity (const QChar &ch) |
Protected Member Functions | |
KCharsets () | |
Friends | |
KCharsets * | charsets () |
Constructor & Destructor Documentation
KCharsets::KCharsets | ( | ) | [protected] |
Protected constructor.
If you need the kcharsets object, use KGlobal::charsets() instead.
Definition at line 511 of file kcharsets.cpp.
KCharsets::~KCharsets | ( | ) | [virtual] |
Member Function Documentation
QStringList KCharsets::availableEncodingNames | ( | ) | const |
Lists all available encodings as names.
- Returns:
- the list of all encodings
Definition at line 633 of file kcharsets.cpp.
QTextCodec * KCharsets::codecForName | ( | const QString & | n, | |
bool & | ok | |||
) | const |
Tries to find a QTextCodec to convert the given encoding from and to Unicode.
If no codec could be found, the ISO 8859-1 codec will be returned an and ok
will be set to false.
- Parameters:
-
ok true if a matching codec has been found, false if not
- Returns:
- the QTextCodec. If the desired codec could not be found, it returns a default (ISO 8859-1) codec
Definition at line 729 of file kcharsets.cpp.
QTextCodec * KCharsets::codecForName | ( | const QString & | name | ) | const |
Provided for compatibility.
- Parameters:
-
name the name of the codec
- Returns:
- the QTextCodec. If the desired codec could not be found, it returns a default (ISO 8859-1) codec
Definition at line 719 of file kcharsets.cpp.
Returns a long description for an encoding name.
- Parameters:
-
encoding the encoding for the language
- Returns:
- the long description for the encoding
Definition at line 653 of file kcharsets.cpp.
QStringList KCharsets::descriptiveEncodingNames | ( | ) | const |
Lists the available encoding names together with a more descriptive language.
- Returns:
- the list of descriptive encoding names
Definition at line 682 of file kcharsets.cpp.
Returns the encoding for a string obtained with descriptiveEncodingNames().
- Parameters:
-
descriptiveName the descriptive name for the encoding
- Returns:
- the name of the encoding
Definition at line 665 of file kcharsets.cpp.
QList< QStringList > KCharsets::encodingsByScript | ( | ) | const |
Lists the available encoding names grouped by script (or language that uses them).
- Returns:
- the list of lists consisting of description followed by encoding names (i.e. encodingsByScript().at(i).at(0) is a description for encodingsByScript().at(i).at(k), k>0)
Definition at line 695 of file kcharsets.cpp.
Overloaded member function.
Tries to find an entity in the QString str.
- Parameters:
-
str the string containing entified len is a return value, that gives the length of the decoded entity.
- Returns:
- a decoded entity if one could be found, QChar::null otherwise
Definition at line 564 of file kcharsets.cpp.
Converts an entity to a character.
The string must contain only the entity without the trailing ';'.
- Parameters:
-
str the entity
- Returns:
- QChar::Null if the entity could not be decoded.
Definition at line 521 of file kcharsets.cpp.
Returns the language the encoding is used for.
- Parameters:
-
encoding the encoding for the language
- Returns:
- the language of the encoding
- Deprecated:
- Please use descriptionForEncoding instead. This function will be removed before KDE4 is released.
Definition at line 642 of file kcharsets.cpp.
Scans the given string for entities (like &) and resolves them using fromEntity.
- Parameters:
-
text the string containing the entities
- Returns:
- the clean string
Definition at line 587 of file kcharsets.cpp.
Converts a QChar to an entity.
The returned string does already contain the leading '&' and the trailing ';'.
- Parameters:
-
ch the char to convert
- Returns:
- the entity
Definition at line 580 of file kcharsets.cpp.
Friends And Related Function Documentation
KCharsets* charsets | ( | ) | [friend] |
The global charset manager.
- Returns:
- the global charset manager
Definition at line 155 of file kglobal.cpp.
The documentation for this class was generated from the following files: