/****************************************************************************

**

** Copyright (C) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (developer.feedback@nokia.com)

**

** This file is part of the HbCore module of the UI Extensions for Mobile.

**

** GNU Lesser General Public License Usage

** This file may be used under the terms of the GNU Lesser General Public

** License version 2.1 as published by the Free Software Foundation and

** appearing in the file LICENSE.LGPL included in the packaging of this file.

** Please review the following information to ensure the GNU Lesser General

** Public License version 2.1 requirements will be met:

** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at developer.feedback@nokia.com.

**

****************************************************************************/

#ifndef HB_INPUT_EXTRA_DICTIONARY_COLLECTION_H

#define HB_INPUT_EXTRA_DICTIONARY_COLLECTION_H

#include <QList>

#include <hbglobal.h>

#include <Qt>

class HbExtraDictionaryCollectionPrivate;

class HbExtraUserDictionary;

class QStringList;

const int HbMaxDictionariesInCollection = 16;

class HB_CORE_EXPORT HbExtraDictionaryCollection

{

public:

    HbExtraDictionaryCollection();

    HbExtraDictionaryCollection(QList<int> dictionaries);

    ~HbExtraDictionaryCollection();

    bool addDictionary(int id);

    bool addDictionary(HbExtraUserDictionary *dictionary);

    void removeDictionary(int id);

    void removeDictionary(HbExtraUserDictionary *dictionary);

    QList<int> dictionaries() const;

    void disableDictionary(int id);

    void enableDictionary(int id);

    bool isDisabled(int id) const;

    int numberOfWords() const;

    int totalNumberOfWords() const;

    QString wordAt(int index) const;

    QStringList findMatches(const QString &searchString, Qt::CaseSensitivity caseSensitivity = Qt::CaseSensitive);

    bool hasWord(const QString &word) const;

    void incrementUseCount(const QString &word);

protected:

    HbExtraDictionaryCollectionPrivate *const d_ptr;

private:

    Q_DECLARE_PRIVATE_D(d_ptr, HbExtraDictionaryCollection)

    Q_DISABLE_COPY(HbExtraDictionaryCollection)

};

#endif // HB_INPUT_EXTRA_DICTIONARY_COLLECTION_H

// End of file