1 /*

     2 * Copyright (c) 2002-2004 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:           

    15 *       Provides the MAknFepUICtrlCandidatePaneInterface definition.

    16 *

    17 */

    18 

    19 

    20 

    21 

    22 

    23 

    24 

    25 

    26 

    27 

    28 

    29 

    30 #ifndef __AKN_FEP_UI_CTRL_CANDIDATEPANE_INTERFACE_H__

    31 #define __AKN_FEP_UI_CTRL_CANDIDATEPANE_INTERFACE_H__

    32 

    33 #include <e32std.h>

    34 #include <badesca.h> //CDesCArrayFlat

    35 

    36 enum TAknFepUICtrlScroll

    37     {

    38     EScrollNone,

    39     EScrollLeft,

    40     EScrollRight,

    41     EScrollUp,

    42     EScrollDown

    43     };

    44 

    45 

    46 class MAknFepUICtrlCandidatePaneInterface

    47     {

    48 public:

    49     /**

    50      * Destructor.

    51      */

    52     virtual ~MAknFepUICtrlCandidatePaneInterface() {};

    53     /**

    54      * Show Candidate List

    55      *

    56      * @param   aItems      The disposition of an item

    57      * @param   aIndex      The index of the cursor position when an initial display

    58      * @param   aLeftSideOfBaseLine

    59      * @param   aHeight     

    60      * @param   aAscent

    61      */

    62     virtual void ShowCandidateListL(CDesCArrayFlat* aItems,

    63                                     TInt aIndex, TInt aResourceID) = 0;

    64     /**

    65      * Close Candidate List

    66      */

    67     virtual void HideWindow() = 0;

    68     /**

    69      * 

    70      */

    71     virtual TInt CurrentItemIndexOfCandidate() = 0;

    72     /**

    73      * 

    74      */

    75     virtual TInt MoveItem(TAknFepUICtrlScroll aDirection) = 0;

    76     /**

    77      * 

    78      */

    79     virtual void SetWindowPosition(const TPoint& aLeftSideOfBaseLine, TInt aHeight, TInt aAscent) = 0;

    80     };

    81 

    82 #endif

    83 

    84 // End of file