KCharsets

#include <KCharsets>

Public Member Functions

virtual ~KCharsets ()
 
QStringList availableEncodingNames () const
 
QTextCodeccodecForName (const QString &name) const
 
QTextCodeccodecForName (const QString &n, bool &ok) const
 
QString descriptionForEncoding (const QString &encoding) const
 
QStringList descriptiveEncodingNames () const
 
QString encodingForName (const QString &descriptiveName) const
 
QList< QStringListencodingsByScript () const
 

Static Public Member Functions

static KCharsetscharsets ()
 
static QChar fromEntity (const QString &str)
 
static QChar fromEntity (const QString &str, int &len)
 
static QString resolveEntities (const QString &text)
 
static QString toEntity (const QChar &ch)
 

Protected Member Functions

 KCharsets ()
 

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 32 of file kcharsets.h.

Constructor & Destructor Documentation

KCharsets::KCharsets ( )
protected

Protected constructor.

If you need the kcharsets object, use KCharsets::charsets() instead.

Definition at line 514 of file kcharsets.cpp.

KCharsets::~KCharsets ( )
virtual

Destructor.

Definition at line 519 of file kcharsets.cpp.

Member Function Documentation

QStringList KCharsets::availableEncodingNames ( ) const

Lists all available encodings as names.

Returns
the list of all encodings

Definition at line 640 of file kcharsets.cpp.

KCharsets * KCharsets::charsets ( )
static

The global charset manager.

Returns
the global charset manager

Definition at line 835 of file kcharsets.cpp.

QTextCodec * KCharsets::codecForName ( const QString name) const

Provided for compatibility.

Parameters
namethe 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.

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
nthe name of the codec
oktrue 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 733 of file kcharsets.cpp.

QString KCharsets::descriptionForEncoding ( const QString encoding) const

Returns a long description for an encoding name.

Parameters
encodingthe encoding for the language
Returns
the long description for the encoding

Definition at line 650 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.

QString KCharsets::encodingForName ( const QString descriptiveName) const

Returns the encoding for a string obtained with descriptiveEncodingNames().

Parameters
descriptiveNamethe descriptive name for the encoding
Returns
the name of the encoding

Definition at line 663 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 694 of file kcharsets.cpp.

QChar KCharsets::fromEntity ( const QString str)
static

Converts an entity to a character.

The string must contain only the entity without the trailing ';'.

Parameters
strthe entity
Returns
QChar::Null if the entity could not be decoded.

Definition at line 524 of file kcharsets.cpp.

QChar KCharsets::fromEntity ( const QString str,
int &  len 
)
static

Overloaded member function.

Tries to find an entity in the QString str.

Parameters
strthe string containing entified
lenis 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 570 of file kcharsets.cpp.

QString KCharsets::resolveEntities ( const QString text)
static

Scans the given string for entities (like &amp;) and resolves them using fromEntity.

Parameters
textthe string containing the entities
Returns
the clean string

Definition at line 591 of file kcharsets.cpp.

QString KCharsets::toEntity ( const QChar ch)
static

Converts a QChar to an entity.

The returned string does already contain the leading '&' and the trailing ';'.

Parameters
chthe char to convert
Returns
the entity

Definition at line 586 of file kcharsets.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed Jul 8 2020 22:42:18 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.