1 /* |
|
2 * Copyright (c) 2004-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: Internal Publish & Subscribe keys. |
|
15 * |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 #ifndef SCREENSAVER_INTERNAL_PS_KEYS_H |
|
21 #define SCREENSAVER_INTERNAL_PS_KEYS_H |
|
22 |
|
23 #include <e32def.h> |
|
24 #include <e32cmn.h> |
|
25 |
|
26 const TUid KPSUidScreenSaver = { 0x101F8771 }; |
|
27 |
|
28 /** |
|
29 * Screen saver preview mode. This integer value triggers screen saver |
|
30 * preview mode. Value is normally 0 but when set to 1 screen saver |
|
31 * application goes to preview mode (ie. turns screensaver on for 10 seconds |
|
32 * and then terminates it). If screensaver is already on when value is set |
|
33 * to 1 then nothing happens. |
|
34 * |
|
35 * Possible values: |
|
36 * 0: default value |
|
37 * 1: triggers screensaver preview mode |
|
38 */ |
|
39 const TUint32 KScreenSaverPreviewMode = 0x00000001; |
|
40 |
|
41 /** |
|
42 * Indication of allowing screen saver to be activated. |
|
43 * |
|
44 * Possible values: |
|
45 * 0: screen saver is allowed to be activated. |
|
46 * >0: screen saver is not allowed to be activated. |
|
47 */ |
|
48 const TUint32 KScreenSaverAllowScreenSaver = 0x00000002; |
|
49 |
|
50 /** |
|
51 * Indication of whether screen saver is on (active) or not. |
|
52 * |
|
53 * Possible values: |
|
54 * 0: screen saver is not active. |
|
55 * >0: screen saver is displaying. |
|
56 */ |
|
57 const TUint32 KScreenSaverOn = 0x00000003; |
|
58 |
|
59 /** |
|
60 * Indication of the state of screensaver preview |
|
61 */ |
|
62 const TUint32 KScreenSaverPreviewState = 0x00000004; |
|
63 enum TScreenSaverPreviewState |
|
64 { |
|
65 EScreenSaverPreviewNone, // Initial state, no preview in progress |
|
66 EScreenSaverPreviewLoading, // Preview is loading |
|
67 EScreenSaverPreviewInvalid, // Invalid file for preview |
|
68 EScreenSaverPreviewLoaded, // Preview has been loaded, about to start |
|
69 EScreenSaverPreviewStart, // Start of preview displaying |
|
70 EScreenSaverPreviewEnd, // Preview displaying ended |
|
71 EScreenSaverPreviewCancel, // Preview cancelled (e.g. by user) |
|
72 EScreenSaverPreviewError // An error occurred during preview |
|
73 }; |
|
74 |
|
75 /** |
|
76 * Indicates whether Idle was in front when screensaver was started. |
|
77 * Keyguard uses this indication to decide if it can be automatically |
|
78 * activated. |
|
79 * |
|
80 * Possible values: |
|
81 * 0: Screensaver not active, or not started from Idle |
|
82 * 1: Screensaver was started from Idle |
|
83 */ |
|
84 const TUint32 KScreenSaverActivatedFromIdle = 0x00000005; |
|
85 |
|
86 /** |
|
87 * Indicates that currently selected screensaver plugin settings (that can |
|
88 * not be otherwise watched through CR & P&S notifications) are being |
|
89 * changed. Written by Themes, listened to by plugins interested in knowing |
|
90 * whether their settings have changed "on the fly". The plugin does not |
|
91 * write the value, as not all plugins will even listen to this key. |
|
92 * |
|
93 * Possible values: |
|
94 * 0: Configured plugin is not the currently selected one, |
|
95 * or settings were left unchanged |
|
96 * 1: Current plugin is being configured. This lets the configuration |
|
97 * dialog know the active plugin settings are being changed in Themes, so |
|
98 * it can notify the plugin loaded in Screensaver context that its |
|
99 * settings have changed through this key. |
|
100 * 2: Current plugin was configured, and its settings were changed. The |
|
101 * plugin running in Screensaver process should notice this, and reload |
|
102 * its settings. After this the plugin should write the value back to 0. |
|
103 */ |
|
104 const TUint32 KScreenSaverPluginSettingsChanged = 0x00000006; |
|
105 enum TScreenSaverPluginSettingsState |
|
106 { |
|
107 // Configured plugin not current, or settings did not change |
|
108 EScreenSaverPluginSettingsNoChange, |
|
109 // Current plugin is being configured |
|
110 EScreenSaverPluginSettingsChanging, |
|
111 // Current plugin settings have changed |
|
112 EScreenSaverPluginSettingsChanged |
|
113 }; |
|
114 |
|
115 |
|
116 /** |
|
117 * Indicates that Screensaver should not attempt to use display power save mode |
|
118 * |
|
119 * Possible values: |
|
120 * 0: Power save mode is used normally |
|
121 * 1: Power save mode is not used |
|
122 */ |
|
123 const TUint32 KScreenSaverNoPowerSaveMode = 0x00000007; |
|
124 |
|
125 #endif // SCREENSAVER_INTERNAL_PS_KEYS_H |
|
126 |
|
127 // End of file |
|