textinput/peninputcommonlayout/inc/peninputshiftcapsInfo.h
changeset 40 2cb9bae34d17
parent 31 f1bdd6b078d1
child 49 37f5d84451bd
equal deleted inserted replaced
31:f1bdd6b078d1 40:2cb9bae34d17
     1 /*
       
     2 * Copyright (c) 2002-2005 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:  shift and capslock information
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_CPENINPUTSHIFTCAPSINFO_H
       
    20 #define C_CPENINPUTSHIFTCAPSINFO_H
       
    21    
       
    22 // System includes
       
    23 #include <e32base.h>
       
    24 #include <w32std.h>
       
    25 #include <barsread.h>
       
    26 
       
    27 /**
       
    28  *  Peninput shift and capslock info definition
       
    29  *
       
    30  *  @lib peninputcommonlayout.lib
       
    31  *  @since S60 v3.2
       
    32  */
       
    33 class CPeninputShiftCapsInfo : public CBase
       
    34     {
       
    35 
       
    36 public:
       
    37 
       
    38     /**
       
    39      * shift&caps single info
       
    40      */
       
    41     struct TPeninputShiftCapsSingle
       
    42         {
       
    43         TInt iId;
       
    44         TInt iVkbLayoutId;
       
    45         TInt iCaseUsed;
       
    46         };
       
    47 
       
    48     /**
       
    49      * Two-phase constructor
       
    50      *
       
    51      * @since S60 v3.2
       
    52      * @param aReader Resource reader    
       
    53      * @return The pointer to CPeninputShiftCapsInfo object
       
    54      */
       
    55     IMPORT_C static CPeninputShiftCapsInfo* NewL( TResourceReader& aReader );
       
    56     
       
    57     /**
       
    58      * Two-phase constructor
       
    59      *
       
    60      * @since S60 v3.2
       
    61      * @param aReader Resource reader    
       
    62      * @return The pointer to CPeninputShiftCapsInfo object
       
    63      */
       
    64     IMPORT_C static CPeninputShiftCapsInfo* NewLC( TResourceReader& aReader );
       
    65 
       
    66     /**
       
    67      * Destructor
       
    68      *
       
    69      * @since S60 v3.2
       
    70      * @return None
       
    71      */
       
    72     IMPORT_C virtual ~CPeninputShiftCapsInfo();  
       
    73 
       
    74     /**
       
    75      * Get shift caps single info by id
       
    76      *
       
    77      * @since S60 v3.2
       
    78      * @param aId Shift caps id 
       
    79      * @return The pointer to TPeninputShiftCapsSingle object
       
    80      */
       
    81     IMPORT_C TPeninputShiftCapsSingle* FindShiftCapsSingleById( TInt aId );
       
    82 
       
    83     /**
       
    84      * Get shift caps single info by case
       
    85      *
       
    86      * @since S60 v3.2
       
    87      * @param aCase Range id 
       
    88      * @return The pointer to TPeninputShiftCapsSingle object
       
    89      */
       
    90     IMPORT_C TPeninputShiftCapsSingle* FindShiftCapsSingleByCase( TInt aCase );
       
    91     
       
    92     /**
       
    93      * Get range id
       
    94      *
       
    95      * @since S60 v3.2
       
    96      * @return Range id
       
    97      */
       
    98     inline TInt RangeId();
       
    99     
       
   100     /**
       
   101      * Get array of shift caps single info
       
   102      *
       
   103      * @since S60 v3.2
       
   104      * @return The reference of pointer array of shift 
       
   105      *         caps single info
       
   106      */
       
   107     inline RPointerArray<TPeninputShiftCapsSingle>& ShiftCapsSingleList();
       
   108 
       
   109 protected:
       
   110 
       
   111     /**
       
   112      * Second phase constructor
       
   113      *
       
   114      * @since S60 v3.2
       
   115      * @param aReader Resource reader
       
   116      * @return None
       
   117      */
       
   118     void ConstructL( TResourceReader& aReader );
       
   119 
       
   120     /**
       
   121      * Construct from resource 
       
   122      *
       
   123      * @since S60 v3.2
       
   124      * @param aReader Resource reader
       
   125      * @return None
       
   126      */
       
   127     void ConstructFromResourceL( TResourceReader& aReader );
       
   128 
       
   129 private: // Data
       
   130 
       
   131     /**
       
   132      * Range id
       
   133      */
       
   134     TInt iRangeId;
       
   135 
       
   136     /**
       
   137      * Array of shift caps single info
       
   138      */
       
   139     RPointerArray<TPeninputShiftCapsSingle> iShiftCapsSingleList;
       
   140 
       
   141     };
       
   142 
       
   143 #include "peninputshiftcapsinfo.inl" 
       
   144 
       
   145 #endif // C_CPENINPUTSHIFTCAPSINFO_H