kdelibs/kdecore/sonnet/loader_p.h
2014-11-13 01:04:59 +02:00

126 lines
3.9 KiB
C++

// -*- Mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; -*-
/*
*
* Copyright (C) 2003 Zack Rusin <zack@kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
#ifndef SONNET_LOADER_P_H
#define SONNET_LOADER_P_H
#include <kdecore_export.h>
#include <ksharedptr.h>
#include <QtCore/QObject>
#include <QtCore/QStringList>
#include <QtCore/QString>
class KService;
namespace Sonnet
{
class Settings;
class SpellerPlugin;
/**
* \internal
* @short Class used to deal with dictionaries
*
* This class manages all dictionaries. It's the top level
* Sonnet class, you can think of it as the kernel or manager
* of the Sonnet architecture.
*/
class KDECORE_EXPORT Loader : public QObject
{
Q_OBJECT
public:
/**
* Constructs the loader.
*
* It's very important that you leave the return value in a Loader::Ptr.
* Loader is reference counted so if you don't want to have it deleted
* under you simply have to hold it in a Loader::Ptr for as long as
* you're using it.
*/
static Loader *openLoader();
public:
Loader();
~Loader();
/**
* Returns dictionary for the given language and preferred client.
*
* @param language specifies the language of the dictionary. If an
* empty string will be passed the default language will
* be used. Has to be one of the values returned by
* \ref languages()
* @param client specifies the preferred client. If no client is
* specified a client which supports the given
* language is picked. If a few clients supports
* the same language the one with the biggest
* reliability value is returned.
*
*/
SpellerPlugin *createSpeller(
const QString& language = QString(),
const QString& client = QString()) const;
/**
* Returns names of all supported clients (e.g. ISpell, ASpell)
*/
QStringList clients() const;
/**
* Returns a list of supported languages.
*/
QStringList languages() const;
/**
* Returns a localized list of names of supported languages.
*/
QStringList languageNames() const;
/**
* @param langCode the dictionary name/language code, e.g. en_gb
* @return the localized language name, e.g. "British English"
* @since 4.2
*/
QString languageNameForCode(const QString &langCode) const;
/**
* Returns the Settings object used by the loader.
*/
Settings *settings() const;
Q_SIGNALS:
/**
* Signal is emitted whenever the Settings object
* associated with this Loader changes.
*/
void configurationChanged();
protected:
friend class Settings;
void changed();
private:
void loadPlugins();
void loadPlugin(const KSharedPtr<KService>&);
private:
class Private;
Private *const d;
};
}
#endif // SONNET_LOADER_P_H