1 /*

     2 * Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0""

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Predictive Candidate list view

    15 *

    16 */

    17 

    18 

    19 #ifndef CPENINPUTJAPANESEPREDICTIVELISTBOXVIEW_H

    20 #define CPENINPUTJAPANESEPREDICTIVELISTBOXVIEW_H

    21 

    22 // INCLUDES

    23 #include <eiklbv.h>  // CListBoxView

    24 

    25 // CONSTANTS

    26 

    27 // FORWARD DECLARATIONS

    28 

    29 // CLASS DECLARATION

    30 

    31 /**

    32 *  CPeninputJapanesePredictiveListBoxView draws all the list items and manages

    33 *  the area of the screen allocated for list itself. In particular,

    34 *  this class does not handle margins of the whole list.

    35 *

    36 *  @lib peninputcommonctrlsjp.lib

    37 *  @since 2.6

    38 */

    39 class CPeninputJapanesePredictiveListBoxView : public CListBoxView

    40     {

    41     public: // New functions

    42         /**

    43         * Return the selected candidate number currently

    44         * @since 2.6

    45         * @return candidate number

    46         */

    47         TInt CurrentCandidateNo() const;

    48 

    49         /**

    50         * Set current candidate number

    51         * @since 2.6

    52         * @param    aCandidateNo    candidate number

    53         * @return   item index including candidate number

    54         */

    55         TInt SetCurrentCandidateNo(TInt aCandidateNo);

    56 

    57         /**

    58         * This function searches a CandidateNo from linenumber and Position

    59         * @since 2.6

    60         * @param aLineNo        line number

    61         * @param aPoint         position

    62         * @return   item index including candidate number

    63         */

    64         TInt SetCurrentCandidateNo(TInt aLineNo, const TPoint& aPoint);

    65 

    66         /**

    67         * Return previous candidate number

    68         * @since 2.6

    69         * @return candidate number

    70         */

    71         TInt PreviousItem();

    72 

    73         /**

    74         * Return next candidate number

    75         * @since 2.6

    76         * @return candidate number

    77         */

    78         TInt NextItem();

    79 

    80         /**

    81         * Return candidate number of previous line

    82         * @since 2.6

    83         * @return candidate number

    84         */

    85         TInt PreviousLineItem();

    86 

    87         /**

    88         * Return candidate number of next line

    89         * @since 2.6

    90         * @return candidate number

    91         */

    92         TInt NextLineItem();

    93 

    94         /**

    95         * Return the selected candidate number currently

    96         * @since 3.2

    97         * @return candidate number

    98         */

    99         TInt OldCandidateNo() const;

   100 

   101     public: // from CListBoxView

   102         virtual void DrawItem(TInt aItemIndex) const;

   103 

   104     private:    // Data

   105         TInt iCurrentCandidateNo;

   106         TInt iOldCandidateNo;

   107     };

   108 

   109 #endif  // CPENINPUTJAPANESEPREDICTIVELISTBOXVIEW_H

   110 

   111 // End of File