textinput/peninputvkbcn/inc/peninputvkbuistatemgr.h
changeset 0 eb1f2e154e89
equal deleted inserted replaced
-1:000000000000 0:eb1f2e154e89
       
     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:  Interface of vkb ui state manager
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_AKNFEPVKBUISTATEMGR_H
       
    20 #define C_AKNFEPVKBUISTATEMGR_H
       
    21 
       
    22 // system includes
       
    23 #include <e32base.h>
       
    24 #include <w32std.h>
       
    25 
       
    26 // forward declarations
       
    27 class MAknFepVkbUiState;
       
    28 class MAknFepVkbLayoutContext;
       
    29 class CAknFepVkbUiState;
       
    30 class CAknFepVkbUiStateStandby;
       
    31 class CAknFepVkbUiStateStandbycn;
       
    32 class CAknFepVkbUiStateStandbycnWithChars;
       
    33 class CAknFepVkbUiStateCompositionNoChars;
       
    34 class CAknFepVkbUiStateCompositionWithChars;
       
    35 
       
    36 /**
       
    37  *  The interface definition of vkb ui state manager
       
    38  *  It provides get method of all vkb ui state and current ui state
       
    39  *
       
    40  *  @lib peninputvkbcn.lib
       
    41  *  @since S60 v3.2
       
    42  */
       
    43 class MAknFepVkbUiStateMgr
       
    44     {
       
    45 public:
       
    46 
       
    47     /**
       
    48      * Get current vkb ui state
       
    49      *
       
    50      * @since S60 v3.2
       
    51      * @return The pointer points to Current vkb ui state
       
    52      */
       
    53     virtual MAknFepVkbUiState* CurrentUiState() = 0;
       
    54     
       
    55     /**
       
    56      * Set current vkb ui state
       
    57      *
       
    58      * @since S60 v3.2
       
    59      * @param aUiState The state to be set as current ui state
       
    60      * @return None
       
    61      */
       
    62     virtual void SetCurrentUiState(MAknFepVkbUiState* aUiState) = 0;
       
    63     
       
    64     /**
       
    65      * Get initial ui state
       
    66      *
       
    67      * @since S60 v3.2
       
    68      * @return The pointer points to initial ui state
       
    69      */
       
    70     virtual MAknFepVkbUiState* UiStateInitial() = 0;
       
    71     
       
    72     /**
       
    73      * Get standby ui state
       
    74      *
       
    75      * @since S60 v3.2
       
    76      * @return The pointer points to standby ui state
       
    77      */
       
    78     virtual MAknFepVkbUiState* UiStateStandby() = 0;
       
    79     
       
    80     /**
       
    81      * Get standby cn ui state
       
    82      *
       
    83      * @since S60 v3.2
       
    84      * @return The pointer points to standby cn ui state
       
    85      */
       
    86     virtual MAknFepVkbUiState* UiStateStandbycn() = 0;
       
    87     
       
    88     /**
       
    89      * Get standby cn with chars ui state
       
    90      *
       
    91      * @since S60 v3.2
       
    92      * @return The pointer points to standby cn with chars ui state
       
    93      */
       
    94     virtual MAknFepVkbUiState* UiStateStandbycnWithChars() = 0;
       
    95     
       
    96     /**
       
    97      * Get composition no chars ui state
       
    98      *
       
    99      * @since S60 v3.2
       
   100      * @return The pointer points to composition no chars ui state
       
   101      */
       
   102     virtual MAknFepVkbUiState* UiStateCompositionNoChars() = 0;
       
   103     
       
   104     /**
       
   105      * Get composition with chars ui state
       
   106      *
       
   107      * @since S60 v3.2
       
   108      * @return The pointer points to composition with chars ui state
       
   109      */
       
   110     virtual MAknFepVkbUiState* UiStateCompositionWithChars() = 0;
       
   111     };
       
   112 
       
   113 /**
       
   114  *  The vkb ui state manager
       
   115  *  It provides get method of all vkb ui state and current ui state
       
   116  *
       
   117  *  @lib peninputvkbcn.lib
       
   118  *  @since S60 v3.2
       
   119  */
       
   120 class CAknFepVkbUiStateMgr: public CBase, MAknFepVkbUiStateMgr
       
   121     {
       
   122 public:
       
   123 
       
   124     /**
       
   125      * Two-phased constructor.
       
   126      *
       
   127      * @since S60 v3.2
       
   128      * @param aContext The vkb layout context
       
   129      * @return The pointer points to CAknFepVkbUiStateMgr type object
       
   130      */
       
   131     static CAknFepVkbUiStateMgr* NewL(MAknFepVkbLayoutContext* aContext);
       
   132     
       
   133     static CAknFepVkbUiStateMgr* NewLC(MAknFepVkbLayoutContext* aContext);
       
   134 
       
   135     /**
       
   136      * Destructor.
       
   137      *
       
   138      * @since S60 v3.2
       
   139      */
       
   140     virtual ~CAknFepVkbUiStateMgr();
       
   141     
       
   142     // from class MAknFepVkbUiStateMgr
       
   143     /**
       
   144      * Get current vkb ui state
       
   145      *
       
   146      * @since S60 v3.2
       
   147      * @return The pointer points to Current vkb ui state
       
   148      */
       
   149     MAknFepVkbUiState* CurrentUiState();
       
   150     
       
   151     /**
       
   152      * Set current vkb ui state
       
   153      *
       
   154      * @since S60 v3.2
       
   155      * @param aUiState The state to be set as current ui state
       
   156      * @return None
       
   157      */
       
   158     void SetCurrentUiState(MAknFepVkbUiState* aUiState);
       
   159     
       
   160     /**
       
   161      * Get initial ui state
       
   162      *
       
   163      * @since S60 v3.2
       
   164      * @return The pointer points to initial ui state
       
   165      */
       
   166     virtual MAknFepVkbUiState* UiStateInitial();
       
   167     
       
   168     /**
       
   169      * Get standby ui state
       
   170      *
       
   171      * @since S60 v3.2
       
   172      * @return The pointer points to standby ui state
       
   173      */
       
   174     virtual MAknFepVkbUiState* UiStateStandby();
       
   175     
       
   176     /**
       
   177      * Get standby cn ui state
       
   178      *
       
   179      * @since S60 v3.2
       
   180      * @return The pointer points to standby cn ui state
       
   181      */
       
   182     virtual MAknFepVkbUiState* UiStateStandbycn();
       
   183     
       
   184     /**
       
   185      * Get standby cn with chars ui state
       
   186      *
       
   187      * @since S60 v3.2
       
   188      * @return The pointer points to standby cn with chars ui state
       
   189      */
       
   190     virtual MAknFepVkbUiState* UiStateStandbycnWithChars();
       
   191     
       
   192     /**
       
   193      * Get composition no chars ui state
       
   194      *
       
   195      * @since S60 v3.2
       
   196      * @return The pointer points to composition no chars ui state
       
   197      */
       
   198     virtual MAknFepVkbUiState* UiStateCompositionNoChars();
       
   199     
       
   200     /**
       
   201      * Get composition with chars ui state
       
   202      *
       
   203      * @since S60 v3.2
       
   204      * @return The pointer points to composition with chars ui state
       
   205      */
       
   206     virtual MAknFepVkbUiState* UiStateCompositionWithChars();
       
   207                                         
       
   208 protected:
       
   209 
       
   210     /**
       
   211      * Symbian second phase constructor.
       
   212      *
       
   213      * @since S60 v3.2
       
   214      * @param aContext The vkb layout context
       
   215      * @return None
       
   216      */
       
   217     void ConstructL(MAknFepVkbLayoutContext* aContext);  
       
   218 
       
   219     /**
       
   220      * C++ default constructor.
       
   221      *
       
   222      * @since S60 v3.2
       
   223      * @param aContext The vkb layout context
       
   224      */
       
   225     CAknFepVkbUiStateMgr(MAknFepVkbLayoutContext* aContext);
       
   226     
       
   227 private: // Data
       
   228 
       
   229     /**
       
   230      * The pointer points to current ui state (Owned)
       
   231      */
       
   232     MAknFepVkbUiState* iCurrentState;
       
   233     
       
   234     /**
       
   235      * The pointer points to initial ui state (Owned)
       
   236      */
       
   237     CAknFepVkbUiState* iUiStateInitial;
       
   238 
       
   239     /**
       
   240      * The pointer points to standby ui state (Owned)
       
   241      */
       
   242     CAknFepVkbUiStateStandby* iUiStateStandby;
       
   243 
       
   244     /**
       
   245      * The pointer points to standby cn ui state (Owned)
       
   246      */
       
   247     CAknFepVkbUiStateStandbycn* iUiStateStandbycn;
       
   248 
       
   249     /**
       
   250      * The pointer points to standby with chars ui state (Owned)
       
   251      */
       
   252     CAknFepVkbUiStateStandbycnWithChars* iUiStateStandbyWitchChars;
       
   253 
       
   254     /**
       
   255      * The pointer points to composition no chars ui state (Owned)
       
   256      */
       
   257     CAknFepVkbUiStateCompositionNoChars* iUiStateCompositionNoChars;
       
   258 
       
   259     /**
       
   260      * The pointer points to composition with chars ui state (Owned)
       
   261      */
       
   262     CAknFepVkbUiStateCompositionWithChars* iUiStateCompositionWithChars;  
       
   263       
       
   264     /**
       
   265      * The pointer points to layout context (Not owned)
       
   266      */
       
   267     MAknFepVkbLayoutContext* iContext;
       
   268     };
       
   269 
       
   270 #endif // C_AKNFEPVKBUISTATEMGR_H
       
   271 
       
   272 // End Of File