1 /*

     2 * Copyright (c) 2009 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:  Implementation of mutli-page virtual keyboard control.

    15 *

    16 */

    17 

    18 #ifndef C_MULTIPAGEVIRTUALKEYBOARD_H

    19 #define C_MULTIPAGEVIRTUALKEYBOARD_H

    20 

    21 // INCLUDES

    22 #include <e32std.h>

    23 #include <e32base.h>

    24 #include <peninputlayoutvkb.h>

    25 

    26 // FORWARD DECLARATIONS

    27 

    28 // CLASS DECLARATION

    29 

    30 /**

    31  *  class CMultiPageVirtualKeyboard.

    32  * 

    33  *  multi-page virtual keybord.

    34  * 

    35  *  @lib peninputfingerhwr.lib

    36  *  @since S60 v5.0

    37  */

    38 

    39 class CMultiPageVirtualKeyboard : public CVirtualKeyboard

    40     {

    41 public:

    42 

    43     /** 

    44      * Symbian constructor.

    45      *

    46      * @since S60 V5.0     

    47      * @param aRect The keyboard position relative to layout

    48      * @param aUiLayout The layout contains the keyboard. Owner ship not transferred.

    49      * @param aControlId Id for this keyboard control.

    50      * @param aFontSpec The font used for key drawing.

    51      * @return Pointer of created object.

    52      */    

    53 

    54     static CMultiPageVirtualKeyboard* NewL( const TRect& aRect, 

    55             CFepUiLayout* aUiLayout, TInt aControlId, 

    56             const TFontSpec& aFontSpec, TBool aIrregular = EFalse );

    57     /**

    58      * Symbian constructor.

    59      *

    60      * @since S60 V5.0     

    61      * @param aRect The keyboard position relative to layout

    62      * @param aUiLayout The layout contains the keyboard. Owner ship not transferred.

    63      * @param aControlId Id for this keyboard control

    64      * @param aFont The font used for key drawing.

    65      * @return Pointer of created object.

    66      */    

    67     static CMultiPageVirtualKeyboard* NewL( const TRect& aRect, 

    68             CFepUiLayout* aUiLayout,TInt aControlId,

    69             CFont* aFont, TBool aIrregular = EFalse );

    70     

    71 

    72     /**

    73      * standard c++ destructor.

    74      *

    75      * @since S60 v5.0

    76      */    

    77     ~CMultiPageVirtualKeyboard();

    78     

    79     

    80     /**

    81      * get current page index.

    82      * 

    83      * @since S60 v5.0

    84      * @return page index.

    85      */

    86     TInt CurPageIndex();

    87     

    88     /**

    89      * get page count.

    90      * 

    91      * @since S60 v5.0

    92      * @return page count.

    93      */    

    94     TInt PageCount();

    95     

    96     /**

    97      * 

    98      * 

    99      */

   100     TInt PageSize();

   101     

   102     /**

   103      * move to specified page.

   104      * 

   105      * @since S60 v5.0

   106      * @param aPageIndex page index.

   107      * @return none.

   108      */ 

   109     void NavToPage( TInt aPageIndex );

   110 

   111     /**

   112      * update paging.

   113      * 

   114      * @since S60 v5.0

   115      * @param aRows Specifies row count.

   116      * @param aCols Specifies column count.

   117      * @return none.

   118      */     

   119     void UpdatePaging( TInt aRows, TInt aCols );

   120     

   121 private:

   122 

   123     /**

   124      * Stand C++ Constructor

   125      * 

   126      * @since S60 V5.0     

   127      * @param aRect The keyboard position relative to layout

   128      * @param aUiLayout The layout contains the keyboard. Owner ship not transferred.

   129      * @param aControlId Id for this keyboard control

   130      * @param aFontSpect The font used for key drawing

   131      */

   132     CMultiPageVirtualKeyboard(const TRect& aRect,CFepUiLayout* aUiLayout,

   133             TInt aControlId, const TFontSpec& aFontSpec, 

   134             TBool aIrregular = EFalse);

   135 

   136     /**

   137      * Symbian 2nd phase constructor

   138      * 

   139      * @since S60 V5.0 

   140      */

   141     void ConstructL();

   142     

   143 private: //datas

   144     TInt iCurPageIndex;

   145     TInt iPageSize;

   146     TInt iPageCount;

   147     

   148     };

   149 

   150 #endif // C_MULTIPAGEVIRTUALKEYBOARD_H

   151 

   152 //  End Of File