/* This file is part of the KDE libraries
Copyright (C) 1999 Lars Knoll (knoll@kde.org)
$Id: kcharsets.h,v 1.53.2.1 2003/02/09 13:55:28 rnolden Exp $
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
#ifndef KCHARSETS_H
#define KCHARSETS_H
#include
#include
#include
#include
class KGlobal;
class KCharsetsPrivate;
class QTextCodec;
/**
* Charset font and encoder/decoder handling.
*
* This is needed, because Qt's font matching algorithm gives the font
* family a higher priority than the charset. For many applications
* this is not acceptable, since it can totally obscure the output,
* in languages which use non iso-8859-1 charsets.
*
* @author Lars Knoll
* @version $Id: kcharsets.h,v 1.53.2.1 2003/02/09 13:55:28 rnolden Exp $
*/
class KCharsets
{
friend class KGlobal;
protected:
/** Protected constructor. If you need the kcharsets object, use
@ref KGlobal::charsets() instead.
*/
KCharsets();
public:
/**
* Destructor.
*/
virtual ~KCharsets();
/**
* Provided for compatibility.
* @param name the name of the codec
* @return the QTextCodec. If the desired codec could not be found,
* it returns a default (Latin-1) codec
*/
QTextCodec *codecForName(const QString &name) const;
/**
* Tries to find a QTextCodec to convert the given encoding from and to
* Unicode. If no codec could be found the latin1 codec will be returned an
* @p ok will be set to false.
* @return the QTextCodec. If the desired codec could not be found,
* it returns a default (Latin-1) codec
*/
QTextCodec *codecForName(const QString &n, bool &ok) const;
/**
* Converts an entity to a character. The string must contain only the
* entity without the trailing ';'.
* @param str the entity
* @return QChar::null if the entity could not be decoded.
*/
static QChar fromEntity(const QString &str);
/**
* Overloaded member function. Tries to find an entity in the
* @ref QString str.
* @param str the string containing entified
* @param len is a return value, that gives the length of the decoded
* entity.
* @return a decoded entity if one could be found, QChar::null
* otherwise
*/
static QChar fromEntity(const QString &str, int &len);
/**
* Converts a QChar to an entity. The returned string does already
* contain the leading '&' and the trailing ';'.
* @param ch the char to convert
* @return the entity
*/
static QString toEntity(const QChar &ch);
/**
* Scans the given string for entities (like &) and resolves them
* using fromEntity.
* @param text the string containing the entities
* @return the clean string
* @since 3.1
*/
static QString resolveEntities( const QString &text );
/**
* Lists all available encodings as names.
* @return the list of all encodings
*/
QStringList availableEncodingNames();
/**
* Lists the available encoding names together with a more descriptive language.
* @return the list of descriptive encoding names
*/
QStringList descriptiveEncodingNames();
/**
* Lists all languages.
* @return a list of all languages
*/
QStringList languages();
/**
* Lists all available encodings for language name 'language'.
* @param language to language to search for
* @return the list of encodings for the language
*/
QStringList encodingsForLanguage( const QString &language );
/**
* Returns the language the encoding is used for.
* @param encoding the encoding for the language
* @return the language of the encoding
*/
QString languageForEncoding( const QString &encoding );
/**
* Returns the encoding for a string obtained with descriptiveEncodingNames().
* @param the descriptive name for the encoding
* @return the name of the encoding
*/
QString encodingForName( const QString &descriptiveName );
private:
KCharsetsPrivate *d;
};
#endif
| Generated by: root on sparc64.ports.openbsd.org on Sun Sep 14 00:02:40 2003, using kdoc 2.0a54. |