1 /*

     2 * Copyright (c) 2005-2006 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:  header file of virtual keyboard control

    15 *

    16 */

    17 

    18 #ifndef M_PENINPUTVKBPREVIEWBUBBLERENDERER_H

    19 #define M_PENINPUTVKBPREVIEWBUBBLERENDERER_H

    20 

    21 // System includes

    22 #include <e32def.h>

    23 #include <fbs.h>

    24 

    25 // User includes

    26 #include "peninputlayoutvkb.h"

    27 

    28 // CLASS DECLARATION

    29 

    30 /**

    31  * MPeninputVkbPreviewBubbleRenderer

    32  * Interface for preview bubble extension.

    33  *  

    34  */

    35 class MPeninputVkbPreviewBubbleRenderer

    36 {

    37 public:

    38     /**

    39      * Attach this extension to a virtual keyboard object.

    40      * 

    41      * @since S60 S60 v5.0

    42      * @return None.

    43      */

    44     virtual void Attach() = 0;

    45     

    46     /**

    47      * Detach this extension from a virtual keyboard object.

    48      * 

    49      * @since S60 S60 v5.0

    50      * @return None.

    51      */    

    52     virtual void Detach() = 0;

    53     

    54     /**

    55      * Enable preview bubble 

    56      * 

    57      * @since S60 S60 v5.0

    58      * @param aFlag ETrue to enable preview bubble.

    59      * @return None.

    60      */    

    61     virtual void ShowBubble( TBool aFlag ) = 0;

    62     

    63     /**

    64      * Draw preview bubble.

    65      * 

    66      * @since S60 S60 v5.0

    67      * @param aKey Virtual key.

    68      * @param aVkbPos Position of virtual keyboard.

    69      * @param aLayoutPos Position of layout, in screen coord-sys.

    70      * @param aSize Size of bubble.

    71      * @return None.

    72      */    

    73     virtual void DrawBubble( CVirtualKey* aKey, const TPoint& aVkbPos, 

    74                              const TPoint& aLayoutPos, const TSize& aSize  ) = 0;

    75     

    76     /**

    77      * Clear preview bubble.

    78      * 

    79      * @since S60 S60 v5.0

    80      * @return None.

    81      */    

    82     virtual void ClearBubble() = 0;

    83 

    84     /**

    85      * Set icon and background of bubble.

    86      * 

    87      * @since S60 S60 v5.0

    88      * @param aBmpId Bitmap of icon.

    89      * @param aMaskBmpId Bitmap of mask.

    90      * @param aBgSkinId Skin id of background.

    91      * @return None.

    92      */

    93     virtual void SetBubbleBitmapParam( CFbsBitmap* aBmpId, CFbsBitmap* aMaskBmpId, 

    94                                        TAknsItemID aBgSkinId )=0;

    95     

    96     /**

    97      * Set text format

    98      * 

    99      * @since S60 S60 v5.0

   100      * @param aTextFormat Text format.

   101      * @return None.

   102      */    

   103     virtual void SetTextFormat( TAknTextLineLayout aTextFormat ) = 0;

   104     

   105     /**

   106      * Set margin of bubble

   107      * 

   108      * @since S60 S60 v5.0

   109      * @param aLeftDiff Left margin.

   110      * @param aTopDiff Top margin.

   111      * @param aRightDiff Right margin.

   112      * @param aBottomDiff Bottom margin.

   113      * @return None.

   114      */

   115     virtual void SetFrameDiff( TInt aLeftDiff, TInt aTopDiff, TInt aRightDiff,

   116                                TInt aBottomDiff )=0;

   117 };

   118 

   119 #endif //M_PENINPUTVKBPREVIEWBUBBLERENDERER_H