|
1 /* |
|
2 * Copyright (c) 2008 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: IM command handler interface |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef MVIMPSTCMDHANDLER_H |
|
20 #define MVIMPSTCMDHANDLER_H |
|
21 |
|
22 // INCLUDES |
|
23 #include <e32def.h> |
|
24 #include "vimpstcmd.hrh" |
|
25 #include "mvimpstprocessarray.h" |
|
26 |
|
27 // FORWARD DECLARATIONS |
|
28 class MVIMPSTCmd; |
|
29 class MVIMPSTCmdObserver; |
|
30 class MVIMPSTProcessArray; |
|
31 |
|
32 // CLASS DECLARATION |
|
33 |
|
34 /** |
|
35 * IM command handler interface. |
|
36 * @lib vimpstcmdprocess.dll |
|
37 * @since 5.0 |
|
38 */ |
|
39 class MVIMPSTCmdHandler |
|
40 { |
|
41 public: // Interface |
|
42 |
|
43 /** |
|
44 * Handles IM commands. |
|
45 * |
|
46 * @param aCommandId The id of the command to handle. |
|
47 * @param aObserver The observer |
|
48 * @param aData Pass the data required for the command to process |
|
49 * @return ETrue if the command was handled, EFalse otherwise. |
|
50 */ |
|
51 virtual TBool HandleCommandL( |
|
52 const TImCommandId aCommandId, MVIMPSTCmdObserver* aObserver, |
|
53 TAny* aData ) = 0; |
|
54 /** |
|
55 * RegisterEventObserverL :register the observer from ui to get back the events |
|
56 * @param: aObserver |
|
57 */ |
|
58 virtual void RegisterEventObserverL( MVIMPSTCmdObserver* aObserver ) = 0; |
|
59 |
|
60 /** |
|
61 * UnRegisterEventObserver :Unregister the observer from ui to stop getting the events |
|
62 * @param: aObserver |
|
63 */ |
|
64 virtual void UnRegisterEventObserver( MVIMPSTCmdObserver* aObserver ) = 0; |
|
65 |
|
66 |
|
67 /** |
|
68 * GetProcessInterface :Returns the Process interface |
|
69 * @return MVIMPSTProcessArray, reference to process array. |
|
70 */ |
|
71 virtual MVIMPSTProcessArray& GetProcessInterface() = 0 ; |
|
72 |
|
73 |
|
74 |
|
75 /** |
|
76 * destructor. |
|
77 */ |
|
78 virtual ~MVIMPSTCmdHandler() {} |
|
79 }; |
|
80 |
|
81 #endif // MVIMPSTCMDHANDLER_H |
|
82 |
|
83 // End of File |