1 /****************************************************************************

     2 **

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

     4 ** All rights reserved.

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

     6 **

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

     8 **

     9 ** GNU Lesser General Public License Usage

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

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

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

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

    14 ** Public License version 2.1 requirements will be met:

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

    16 **

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

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

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

    20 **

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

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

    23 **

    24 ****************************************************************************/

    25 

    26 #ifndef HbAutoComplete_H 

    27 #define HbAutoComplete_H 

    28 

    29 #include <QVector>

    30 #include <QStringList>

    31 

    32 #include "hbinputpredictionengine.h"

    33 

    34 class HbAutoCompletePrivate;

    35 class HbExtraUserDictionary;

    36 

    37 const QString HbAutoCompleteVendorIdString("Nokia HbAutoComplete");

    38 

    39 class HbAutoComplete : public HbPredictionEngine

    40 {

    41 public:

    42     HbAutoComplete();

    43     ~HbAutoComplete();

    44 

    45 public: // From HbPredictionBase

    46     QList<HbInputLanguage> languages() const;

    47     void deleteKeyPress(HbPredictionCallback* callback = 0);

    48     void commit(const QString &word = QString());

    49     void clear();

    50     void addUsedWord(const QString& word);

    51     void appendKeyPress(const int keycode, const Qt::KeyboardModifiers modifiers, const HbTextCase textCase = HbTextCaseNone, HbPredictionCallback* callback = 0);

    52     void setWord(const QString& word, HbPredictionCallback* callback = 0);

    53     void updateCandidates(int& bestGuessLocation, bool& noMoreCandidates); 

    54     HbInputPredictionFeature features() const;

    55     QString vendorIdString() const;

    56     QString engineVersion() const;

    57     bool supportsKeyboardType(const HbInputLanguage &language, HbKeyboardType keyboard) const;

    58     void setExtraUserDictionary(int aId);

    59     void setExtraUserDictionaries(const QList<int>& idList);

    60 

    61 public: // From HbPredictionEngine

    62     int inputLength();

    63     void setCandidateList(QStringList* candidateList);

    64     QStringList candidateList();

    65     void setKeyboard(HbKeyboardType aKeyboardType);

    66     void appendCharacter(const QChar aChar, const HbTextCase textCase = HbTextCaseNone, HbPredictionCallback* callback = 0);

    67  

    68 protected:

    69     HbAutoCompletePrivate *const d_ptr;

    70 

    71 private:

    72     Q_DECLARE_PRIVATE_D(d_ptr, HbAutoComplete)

    73     Q_DISABLE_COPY(HbAutoComplete)

    74 };

    75 

    76 #endif // HbAutoComplete_H

    77 

    78 // End of file 

    79