1 /*

     2 * Copyright (c) 2003 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

    15 *

    16 */

    17 

    18 

    19 

    20 

    21 

    22 

    23 

    24 

    25 

    26 

    27 

    28 

    29 #ifndef CAKNFEPUICTRLJAPANESEPREDICTIVELISTBOX_H

    30 #define CAKNFEPUICTRLJAPANESEPREDICTIVELISTBOX_H

    31 

    32 // INCLUDES

    33 

    34 // CONSTANTS

    35 

    36 // FORWARD DECLARATIONS

    37 

    38 // CLASS DECLARATION

    39 

    40 /**

    41 *  CAknFepUICtrlJapanesePredictiveListbox class.

    42 *

    43 *  @lib AknFep.lib

    44 *  @since 2.6

    45 */

    46 NONSHARABLE_CLASS(CAknFepUICtrlJapanesePredictiveListbox)

    47         : public CAknSinglePopupMenuStyleListBox

    48     {

    49     public:  // Constructors and destructor

    50         void ConstructL(const CCoeControl* aParent, TInt aFlags);

    51 

    52     public: // New functions

    53         /**

    54         * Selecting the index as argument

    55         * @since 2.6

    56         * @param aCandidateNo  The index of the cursor position

    57         * @param aDraw  ETrue is redraw.

    58         */

    59         void SetCurrentCandidateNo(TInt aCandidateNo, TBool aDraw);

    60 

    61         /**

    62         * Return the candidate number selected currently

    63         * @since 2.6

    64         * @return the candidate number selected currently

    65         */

    66         TInt CurrentCandidateNo();

    67 

    68         /**

    69         * selecting a previous candidate

    70         * @since 2.6

    71         * @return the candidate number selected currently

    72         */

    73         TInt MovePreviousItem();

    74 

    75         /**

    76         * selecting a next candidate

    77         * @since 2.6

    78         * @return the candidate number selected currently

    79         */

    80         TInt MoveNextItem();

    81 

    82         /**

    83         * selecting a previous line candidate

    84         * @since 2.6

    85         * @return the candidate number selected currently

    86         */

    87         TInt MovePreviousLineItem();

    88 

    89         /**

    90         * selecting a next line candidate

    91         * @since 2.6

    92         * @return the candidate number selected currently

    93         */

    94         TInt MoveNextLineItem();

    95 

    96         /**

    97          * Handling of pointer event within the @c CEikListBox.

    98          * Used for e.g. selecting an item from the list box.

    99          *

   100          * @since 3.2

   101          * @param aPointerEvent Details of the pointer event that is being handled.

   102          */

   103         void HandlePointerEventL(const TPointerEvent& aPointerEvent);

   104 

   105     public: // Functions from CAknSinglePopupMenuStyleListBox

   106         virtual void SizeChanged();

   107 

   108     public: // Functions from CEikFormattedCellListBox

   109         virtual CListBoxView* MakeViewClassInstanceL();

   110 

   111     protected: // Functions from CAknSinglePopupMenuStyleListBox

   112         virtual void CreateItemDrawerL();

   113 

   114     protected: // Functions from CEikListBox

   115         /**

   116          * Sets an item as the current item, even if it is not currently

   117          * visible. Redraws the list box to reflect the change. This

   118          * should not be called from within another Draw function.

   119          *

   120          * @param aItemIndex The index of the list box item to update.

   121          */

   122         virtual void UpdateCurrentItem(TInt aItemIndex) const;

   123 

   124         /**

   125          * from CEikListBox

   126          * Used for scrolling through the items in the list box.

   127          *

   128          * @param aScrollBar Scroll bar for the list box.

   129          * @param aEventType Type of the event that occured.

   130          */

   131         virtual void HandleScrollEventL(CEikScrollBar* aScrollBar,

   132                                                  TEikScrollEvent aEventType);

   133     };

   134 

   135 #endif  // CAKNFEPUICTRLJAPANESEPREDICTIVELISTBOX_H

   136 

   137 // End of File