fepstub/UiPlugins/AknFepUiInterface/inc/AknFepUICtrlInputPane.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 CAknFepUICtrlInputPane 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_INPUT_PANE_H__
hgs
parents:
diff changeset
    31
#define __AKN_FEP_INPUT_PANE_H__
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
#include <e32std.h>
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
/**
hgs
parents:
diff changeset
    36
 * pane in which the user's input is shown
hgs
parents:
diff changeset
    37
 */
hgs
parents:
diff changeset
    38
class MAknFepUICtrlInputPane
hgs
parents:
diff changeset
    39
    {
hgs
parents:
diff changeset
    40
public:
hgs
parents:
diff changeset
    41
    /**
hgs
parents:
diff changeset
    42
     * Different layouts, can be used depending on whether used as the input pane, or as 
hgs
parents:
diff changeset
    43
     * an entry in the popup pinyin window
hgs
parents:
diff changeset
    44
     */
hgs
parents:
diff changeset
    45
    enum TInputPaneLayout
hgs
parents:
diff changeset
    46
        {
hgs
parents:
diff changeset
    47
		ELayoutPhraseInputPane = 3,
hgs
parents:
diff changeset
    48
		ELayoutPhrasePinyinPopupPane,
hgs
parents:
diff changeset
    49
		ELayoutPhraseMiniQwertyZhuyin
hgs
parents:
diff changeset
    50
        };
hgs
parents:
diff changeset
    51
hgs
parents:
diff changeset
    52
    /**
hgs
parents:
diff changeset
    53
     * The number of characters that can be displayed in the input pane.
hgs
parents:
diff changeset
    54
     * This does not include the tone mark, which is counted separately.
hgs
parents:
diff changeset
    55
     */
hgs
parents:
diff changeset
    56
    enum
hgs
parents:
diff changeset
    57
        {
hgs
parents:
diff changeset
    58
        EMaxToneMarkLength = 1,
hgs
parents:
diff changeset
    59
        EMaxInputCharsInputPaneNotIncludingToneMark = 30, // need 30 in the case of stroke
hgs
parents:
diff changeset
    60
        EMaxInputCharsPinyinPopupNotIncludingToneMark = 21,
hgs
parents:
diff changeset
    61
        EMaxInputCharsZhuyinPopup = 16,
hgs
parents:
diff changeset
    62
        EMaxInputCharsInputPane = EMaxInputCharsInputPaneNotIncludingToneMark + EMaxToneMarkLength,
hgs
parents:
diff changeset
    63
        EMaxInputCharsPinyinPopup = EMaxInputCharsPinyinPopupNotIncludingToneMark + EMaxToneMarkLength,
hgs
parents:
diff changeset
    64
        EMaxInputChars = EMaxInputCharsInputPane + EMaxInputCharsPinyinPopup // guaranteed big enough for either
hgs
parents:
diff changeset
    65
        };
hgs
parents:
diff changeset
    66
    
hgs
parents:
diff changeset
    67
    enum 
hgs
parents:
diff changeset
    68
        {
hgs
parents:
diff changeset
    69
        EPhoneticChanged  = 0x0001
hgs
parents:
diff changeset
    70
        };
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
public:
hgs
parents:
diff changeset
    73
    virtual void SetText(const TDesC& aDes) = 0;
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
    /**
hgs
parents:
diff changeset
    76
     * Get the text buffer of the pane
hgs
parents:
diff changeset
    77
     *
hgs
parents:
diff changeset
    78
     * @output aText the buffer is filled with the contents of the candidate
hgs
parents:
diff changeset
    79
     *              of the pane, up to the size of the buffer
hgs
parents:
diff changeset
    80
     */
hgs
parents:
diff changeset
    81
    virtual void GetText(TDes& aText) const = 0;
hgs
parents:
diff changeset
    82
hgs
parents:
diff changeset
    83
    /**
hgs
parents:
diff changeset
    84
     * This function sets the Tone Mark for the Pane.
hgs
parents:
diff changeset
    85
     *
hgs
parents:
diff changeset
    86
     * @param aToneMark descriptor containing the tone mark character
hgs
parents:
diff changeset
    87
     */
hgs
parents:
diff changeset
    88
    virtual void SetToneMark(const TDesC& aToneMark) = 0;
hgs
parents:
diff changeset
    89
hgs
parents:
diff changeset
    90
    /**
hgs
parents:
diff changeset
    91
     * This function sets the validity of the tonemark
hgs
parents:
diff changeset
    92
     *
hgs
parents:
diff changeset
    93
     * @param aValid if ETrue, tonemark will be displayed as valid
hgs
parents:
diff changeset
    94
     *                          if EFalse, tonemark will be displayed as not valid
hgs
parents:
diff changeset
    95
     */
hgs
parents:
diff changeset
    96
    virtual void SetToneMarkValidity(TBool aValid) = 0;
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
    /**
hgs
parents:
diff changeset
    99
     * sets the font to be used, which will override the font from LAF
hgs
parents:
diff changeset
   100
     *
hgs
parents:
diff changeset
   101
     * @param aFontId the new font id, pass in 0 to use the one from LAF
hgs
parents:
diff changeset
   102
     *
hgs
parents:
diff changeset
   103
     */
hgs
parents:
diff changeset
   104
    virtual void SetOverrideFontId(TInt aFontId) = 0;
hgs
parents:
diff changeset
   105
    virtual void SetFlag(TInt aFlag) = 0;
hgs
parents:
diff changeset
   106
    virtual void ClearFlag(TInt aFlag) = 0;
hgs
parents:
diff changeset
   107
    virtual TBool IsFlagSet(TInt aFlag) const = 0;
hgs
parents:
diff changeset
   108
    };
hgs
parents:
diff changeset
   109
hgs
parents:
diff changeset
   110
#endif //__AKN_FEP_INPUT_PANE_H__
hgs
parents:
diff changeset
   111
hgs
parents:
diff changeset
   112
// End of file