48 \fn virtual void HbPredictionBase::setWord(const QString& word, HbPredictionCallback* callback = 0) |
48 \fn virtual void HbPredictionBase::setWord(const QString& word, HbPredictionCallback* callback = 0) |
49 Sets current word. Given word will be the active word. |
49 Sets current word. Given word will be the active word. |
50 */ |
50 */ |
51 |
51 |
52 /*! |
52 /*! |
|
53 \deprecated HbPredictionBase::updateCandidates(int&, bool&) |
|
54 is deprecated. Use bool updateCandidates(int&) instead. |
53 \fn virtual void HbPredictionBase::updateCandidates(int& bestGuessLocation, bool& noMoreCandidates) |
55 \fn virtual void HbPredictionBase::updateCandidates(int& bestGuessLocation, bool& noMoreCandidates) |
54 |
56 */ |
|
57 |
|
58 /*! |
|
59 \fn bool HbPredictionBase::updateCandidates(int& bestGuessLocation) |
|
60 Updates the candidate list to match active input sequence. Typically appendKeyPress and deleteKeyPress |
|
61 do that automatically but in same cases it may be required to update the situation explicitly. |
|
62 Paramter bestGuessLocation specifies the best match index in the candidate list. Typically it is |
|
63 the first location but with some engines it may vary. |
|
64 Returns true if active input sequence produces valid candidates. Otherwise returns false and |
|
65 doesn not update the existing candidate list (in other words HbPredictionEngine::candidates() will |
|
66 still return same set of candidates as it did before calling this method unsuccesfully). |
55 */ |
67 */ |
56 |
68 |
57 /*! |
69 /*! |
58 \fn virtual void HbPredictionBase::appendKeyPress(const int keycode, const Qt::KeyboardModifiers modifiers, const HbTextCase textCase = HbTextCaseNone, HbPredictionCallback* callback = 0) |
70 \fn virtual void HbPredictionBase::appendKeyPress(const int keycode, const Qt::KeyboardModifiers modifiers, const HbTextCase textCase = HbTextCaseNone, HbPredictionCallback* callback = 0) |
59 Handles a key press event. |
71 Handles a key press event. |
61 \sa appendCharacter |
73 \sa appendCharacter |
62 */ |
74 */ |
63 |
75 |
64 /*! |
76 /*! |
65 \fn virtual void HbPredictionBase::deleteKeyPress(HbPredictionCallback* callback = 0) |
77 \fn virtual void HbPredictionBase::deleteKeyPress(HbPredictionCallback* callback = 0) |
66 Handles delete key press. |
78 Deletes one key press from the active input sequence. |
67 */ |
79 */ |
68 |
80 |
69 /*! |
81 /*! |
70 \fn virtual void HbPredictionBase::commit(const QString &word = QString()) |
82 \fn virtual void HbPredictionBase::commit(const QString &word = QString()) |
71 Commits ongoing input operation and clears the active word. If the word is given as a parameter, |
83 Commits ongoing input operation and clears the active word. If the word is given as a parameter, |
105 /*! |
117 /*! |
106 \fn virtual bool HbPredictionBase::supportsKeyboardType(const HbInputLanguage &language, HbKeyboardType keyboard) |
118 \fn virtual bool HbPredictionBase::supportsKeyboardType(const HbInputLanguage &language, HbKeyboardType keyboard) |
107 Returns true if the engine supports given combination of language and keyboard type. |
119 Returns true if the engine supports given combination of language and keyboard type. |
108 */ |
120 */ |
109 |
121 |
110 // --------------------------------------------------------------------------- |
|
111 // HbPredictionBase::HbPredictionBase |
|
112 // |
|
113 // --------------------------------------------------------------------------- |
|
114 // |
|
115 HbPredictionBase::HbPredictionBase() |
122 HbPredictionBase::HbPredictionBase() |
116 { |
123 { |
117 } |
124 } |
118 |
125 |
119 // --------------------------------------------------------------------------- |
|
120 // HbPredictionBase::~HbPredictionBase |
|
121 // |
|
122 // --------------------------------------------------------------------------- |
|
123 // |
|
124 HbPredictionBase::~HbPredictionBase() |
126 HbPredictionBase::~HbPredictionBase() |
125 { |
127 { |
126 } |
128 } |
127 |
129 |
128 /*! |
130 /*! |
206 \deprecated HbPredictionEngine::setCandidateList(QStringList*) |
208 \deprecated HbPredictionEngine::setCandidateList(QStringList*) |
207 is deprecated. |
209 is deprecated. |
208 */ |
210 */ |
209 |
211 |
210 /*! |
212 /*! |
|
213 \deprecated HbPredictionEngine::candidateList() |
|
214 is deprecated. use QStringList candidates() instead. |
211 \fn virtual QStringList HbPredictionEngine::candidateList() |
215 \fn virtual QStringList HbPredictionEngine::candidateList() |
|
216 Returns the list of prediction candidates for current input sequence. |
|
217 */ |
|
218 |
|
219 /*! |
|
220 \fn virtual QStringList HbPredictionEngine::candidates() |
212 Returns the list of prediction candidates for current input sequence. |
221 Returns the list of prediction candidates for current input sequence. |
213 */ |
222 */ |
214 |
223 |
215 /* |
224 /* |
216 \fn virtual int HbPredictionEngine::inputLength() |
225 \fn virtual int HbPredictionEngine::inputLength() |
347 This interface extends predictiv einput abstraction layer with methods specific |
356 This interface extends predictiv einput abstraction layer with methods specific |
348 to predictive Chinese input. Those are mainly related to spelling candidates and candidate |
357 to predictive Chinese input. Those are mainly related to spelling candidates and candidate |
349 page handling. |
358 page handling. |
350 */ |
359 */ |
351 |
360 |
|
361 /*! |
|
362 \deprecated HbPredictionEngineChinese::pressKey(const int keycode, const Qt::KeyboardModifiers modifiers, const int textCase) |
|
363 is deprecated. use base class AppendkeyPress instead. |
|
364 */ |
|
365 |
|
366 /*! |
|
367 \deprecated HbPredictionEngineChinese::HbPredictionEngineChinese::getCandidates(int, int) |
|
368 is deprecated. Use base class candidates() instead. |
|
369 */ |
|
370 |
352 // End of file |
371 // End of file |