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 HbCore 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 HB_INPUT_PREDICTION_CALLBACK_H

    27 #define HB_INPUT_PREDICTION_CALLBACK_H

    28 

    29 #include <hbinputdef.h>

    30 

    31 /*!

    32 @proto

    33 @hbcore

    34 \class HbPredictionCallback

    35 \brief A callback method for prediction engine API.  

    36 

    37 This callback class can be delivered as a parameter for various prediction engine API methods.

    38 When it is given, the prediction engine can use it for querying editor buffer contents and

    39 cursor position. This information is needed for example in case of context sensitive prediction.

    40 

    41 \sa HbPredictionEngine

    42 */

    43 class HbPredictionCallback

    44 {

    45 public:

    46     virtual ~HbPredictionCallback() {}    

    47 

    48     virtual QString surroundingText() = 0;

    49     virtual int cursorPosition() = 0;

    50     virtual QList<HbKeyPressProbability> probableKeypresses()

    51     {

    52     return QList<HbKeyPressProbability>();

    53     }

    54 };

    55 

    56 #endif // HB_INPUT_PREDICTION_CALLBACK_H

    57 

    58 // End of file