|
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: Define the API for a external standby screen |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef EXTRSTANDBYSCR_H |
|
21 #define EXTRSTANDBYSCR_H |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32std.h> |
|
25 #include <ecom/ecom.h> |
|
26 #include <coecntrl.h> |
|
27 |
|
28 #include "ExtrStandbyScrConst.h" |
|
29 |
|
30 const TUid KCExtrStandbyScrInterfaceUid = {KExtrStandbyScrInterfaceUid} ; |
|
31 |
|
32 class CExtrStandbyScr : public CCoeControl |
|
33 { |
|
34 public: |
|
35 |
|
36 /** |
|
37 * Creates new instance of CExtrStandbyScr based class. |
|
38 * @param aImplementationUid implementation UID . |
|
39 * @param aDataStore |
|
40 * @return CExtrStandbyScr* Newly created instance. |
|
41 */ |
|
42 inline static CExtrStandbyScr* NewL(TUid aImplementationUid,CCoeControl *aContainer); |
|
43 |
|
44 /** |
|
45 * Destructor. |
|
46 */ |
|
47 inline virtual ~CExtrStandbyScr(); |
|
48 |
|
49 public: |
|
50 |
|
51 /** |
|
52 * LoadEngineL |
|
53 * Instructs the plugin that is has been selected to run and to now load its corresponding engine |
|
54 */ |
|
55 virtual void LoadEngineL()=0; |
|
56 |
|
57 public: /* Layout */ |
|
58 |
|
59 /** |
|
60 * GetPreferedSize |
|
61 * Returns the preferred size of the plugin |
|
62 */ |
|
63 inline virtual TSize GetPreferedSize(); |
|
64 |
|
65 /** |
|
66 * GetNextSizeDecrement |
|
67 * The difference in size from the current size to the next smaller size this plugin can support |
|
68 */ |
|
69 inline virtual TSize GetNextSizeDecrement() ; |
|
70 |
|
71 /** |
|
72 * ResetToDefaultState |
|
73 * Set the plugin to the default state. This is called when the plugin start and with the red key |
|
74 */ |
|
75 inline virtual void ResetToDefaultState(); |
|
76 |
|
77 public: /* Functions to read static settings from plugin */ |
|
78 |
|
79 /** |
|
80 * GetMinSize |
|
81 * Returns the minimum size this plugin can render its content in |
|
82 */ |
|
83 virtual TSize GetMinSize() = 0 ; |
|
84 |
|
85 /** |
|
86 * GetMaxSize |
|
87 * Returns the maximum size this plugin can render its content in |
|
88 */ |
|
89 virtual TSize GetMaxSize() = 0 ; |
|
90 |
|
91 protected: |
|
92 |
|
93 virtual void Draw(const TRect& aRect) const; |
|
94 |
|
95 private: |
|
96 // ECOM framework requires this ID in object destructor |
|
97 TUid iDtor_ID_Key; |
|
98 }; |
|
99 |
|
100 #include "ExtrStandbyScr.inl" |
|
101 |
|
102 #ifdef __ACTIVE_IDLE |
|
103 #include "extrstandbyscrutil.inl" |
|
104 #endif |
|
105 |
|
106 #endif // EXTRSTANDBYSCR_H |