|
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 ui state manager |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef M_MPENINPUTUISTATEMGR_H |
|
20 #define M_MPENINPUTUISTATEMGR_H |
|
21 |
|
22 // Forward declarations |
|
23 class CPeninputUiStateBase; |
|
24 |
|
25 /** |
|
26 * The ui state manager interfaces |
|
27 * It provides intefaces to access ui state manager |
|
28 * |
|
29 * @lib peninputcommonlayout.lib |
|
30 * @since S60 v3.2 |
|
31 */ |
|
32 class MPeninputUiStateMgr |
|
33 { |
|
34 |
|
35 public: |
|
36 |
|
37 /** |
|
38 * Get current ui state |
|
39 * |
|
40 * @since S60 v3.2 |
|
41 * @return The pointer to CPeninputUiStateBase object |
|
42 */ |
|
43 virtual CPeninputUiStateBase* CurrentUiState() = 0; |
|
44 |
|
45 /** |
|
46 * Get ui state object according to the ui state type |
|
47 * |
|
48 * @since S60 v3.2 |
|
49 * @param aUiStateType The type of ui state |
|
50 * @return The pointer to CPeninputUiStateBase object |
|
51 */ |
|
52 virtual CPeninputUiStateBase* GetUiState( TInt aUiStateType ) = 0; |
|
53 |
|
54 /** |
|
55 * Set current ui state by state object |
|
56 * |
|
57 * @since S60 v3.2 |
|
58 * @param aUiState The state to be set as current ui state |
|
59 * @return None |
|
60 */ |
|
61 virtual void SetCurrentUiState( CPeninputUiStateBase* aUiState ) = 0; |
|
62 |
|
63 /** |
|
64 * Set current ui state by state type |
|
65 * |
|
66 * @since S60 v3.2 |
|
67 * @param aUiStateType The type of ui state |
|
68 * @return None |
|
69 */ |
|
70 virtual void SetCurrentUiState( TInt aUiStateType ) = 0; |
|
71 |
|
72 /** |
|
73 * Add ui state to list |
|
74 * |
|
75 * @since S60 v3.2 |
|
76 * @param aUiState The ui state object to be added to list |
|
77 * @param aUiStateType The ui state type to be added to list |
|
78 * @return None |
|
79 */ |
|
80 virtual void AddUiState( CPeninputUiStateBase* aUiState, |
|
81 TInt aUiStateType ) = 0; |
|
82 |
|
83 }; |
|
84 |
|
85 #endif // M_MPENINPUTUISTATEMGR_H |