|
1 /* |
|
2 * Copyright (c) 2005-2007 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 for handling UI events. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef M_AIUIEVENTHANDLER_H |
|
20 #define M_AIUIEVENTHANDLER_H |
|
21 |
|
22 |
|
23 namespace AiXmlUiController |
|
24 { |
|
25 |
|
26 /** |
|
27 * Extension of the CAiContentPublisher interface, which allows Active Idle |
|
28 * Framework to notify their plug-ins that they must to handle event. |
|
29 * Plug-ins must provide implementation of interface only if they are |
|
30 * supporting event model (e.g. provides possibility to manipulate with |
|
31 * engine properties via UI). |
|
32 * |
|
33 * @lib AiXmlUiMain |
|
34 */ |
|
35 class MAiUiEventHandler |
|
36 { |
|
37 protected: |
|
38 |
|
39 /** |
|
40 * Protected destructor prevents deletion through this interface. |
|
41 */ |
|
42 ~MAiUiEventHandler() { } |
|
43 |
|
44 public: // New functions |
|
45 |
|
46 /** |
|
47 * Invoked by the framework when plug-in must handle an event. |
|
48 * |
|
49 * @param aEvent - event. |
|
50 * @param aParam - parameters associated with event. Each UI Definition |
|
51 * declares events in the format: <event name>(<event params>), |
|
52 * where <event name> is mapped by the framework to unique |
|
53 * identifier suppied in aEvent, <event params> are provided to |
|
54 * plug-in as-is in the descriptor. |
|
55 * @return ETrue if event was handled by this handler. |
|
56 */ |
|
57 virtual TBool HandleUiEvent(TAny* aEvent, const TDesC8& aParam) = 0; |
|
58 |
|
59 }; |
|
60 |
|
61 } // namespace AiXmlUiController |
|
62 |
|
63 #endif // M_AIUIEVENTHANDLER_H |
|
64 |
|
65 // End of File. |