fepstub/UiPlugins/AknFepUiInterface/inc/AknFepUICtrlCandidatePaneInterface.h
author hgs
Wed, 23 Jun 2010 04:57:58 +0800
changeset 24 fc42a86c98e3
permissions -rw-r--r--
201025
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
24
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2004 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0""
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:           
hgs
parents:
diff changeset
    15
*       Provides the MAknFepUICtrlCandidatePaneInterface definition.
hgs
parents:
diff changeset
    16
*
hgs
parents:
diff changeset
    17
*/
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
#ifndef __AKN_FEP_UI_CTRL_CANDIDATEPANE_INTERFACE_H__
hgs
parents:
diff changeset
    31
#define __AKN_FEP_UI_CTRL_CANDIDATEPANE_INTERFACE_H__
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
#include <e32std.h>
hgs
parents:
diff changeset
    34
#include <badesca.h> //CDesCArrayFlat
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
enum TAknFepUICtrlScroll
hgs
parents:
diff changeset
    37
    {
hgs
parents:
diff changeset
    38
    EScrollNone,
hgs
parents:
diff changeset
    39
    EScrollLeft,
hgs
parents:
diff changeset
    40
    EScrollRight,
hgs
parents:
diff changeset
    41
    EScrollUp,
hgs
parents:
diff changeset
    42
    EScrollDown
hgs
parents:
diff changeset
    43
    };
hgs
parents:
diff changeset
    44
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
class MAknFepUICtrlCandidatePaneInterface
hgs
parents:
diff changeset
    47
    {
hgs
parents:
diff changeset
    48
public:
hgs
parents:
diff changeset
    49
    /**
hgs
parents:
diff changeset
    50
     * Destructor.
hgs
parents:
diff changeset
    51
     */
hgs
parents:
diff changeset
    52
    virtual ~MAknFepUICtrlCandidatePaneInterface() {};
hgs
parents:
diff changeset
    53
    /**
hgs
parents:
diff changeset
    54
     * Show Candidate List
hgs
parents:
diff changeset
    55
     *
hgs
parents:
diff changeset
    56
     * @param   aItems      The disposition of an item
hgs
parents:
diff changeset
    57
     * @param   aIndex      The index of the cursor position when an initial display
hgs
parents:
diff changeset
    58
     * @param   aLeftSideOfBaseLine
hgs
parents:
diff changeset
    59
     * @param   aHeight     
hgs
parents:
diff changeset
    60
     * @param   aAscent
hgs
parents:
diff changeset
    61
     */
hgs
parents:
diff changeset
    62
    virtual void ShowCandidateListL(CDesCArrayFlat* aItems,
hgs
parents:
diff changeset
    63
                                    TInt aIndex, TInt aResourceID) = 0;
hgs
parents:
diff changeset
    64
    /**
hgs
parents:
diff changeset
    65
     * Close Candidate List
hgs
parents:
diff changeset
    66
     */
hgs
parents:
diff changeset
    67
    virtual void HideWindow() = 0;
hgs
parents:
diff changeset
    68
    /**
hgs
parents:
diff changeset
    69
     * 
hgs
parents:
diff changeset
    70
     */
hgs
parents:
diff changeset
    71
    virtual TInt CurrentItemIndexOfCandidate() = 0;
hgs
parents:
diff changeset
    72
    /**
hgs
parents:
diff changeset
    73
     * 
hgs
parents:
diff changeset
    74
     */
hgs
parents:
diff changeset
    75
    virtual TInt MoveItem(TAknFepUICtrlScroll aDirection) = 0;
hgs
parents:
diff changeset
    76
    /**
hgs
parents:
diff changeset
    77
     * 
hgs
parents:
diff changeset
    78
     */
hgs
parents:
diff changeset
    79
    virtual void SetWindowPosition(const TPoint& aLeftSideOfBaseLine, TInt aHeight, TInt aAscent) = 0;
hgs
parents:
diff changeset
    80
    };
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
#endif
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
// End of file