homescreensrv_plat/homescreen_information_api/inc/homescreendomainpskeys.h
author hgs
Mon, 13 Sep 2010 13:26:33 +0300
changeset 116 305818acdca4
parent 99 7aaf39b772ac
permissions -rw-r--r--
201036
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
87
hgs
parents:
diff changeset
     1
/*
116
hgs
parents: 99
diff changeset
     2
 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
87
hgs
parents:
diff changeset
     3
 * All rights reserved.
hgs
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
 * under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
 *
hgs
parents:
diff changeset
     9
 * Initial Contributors:
hgs
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
 *
hgs
parents:
diff changeset
    12
 * Contributors:
hgs
parents:
diff changeset
    13
 *
hgs
parents:
diff changeset
    14
 * Description: declaration of functions providing string constants
hgs
parents:
diff changeset
    15
 *
hgs
parents:
diff changeset
    16
 */
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef HOMESCREEN_DOMAIN_PS_KEYS_H
hgs
parents:
diff changeset
    19
#define HOMESCREEN_DOMAIN_PS_KEYS_H
hgs
parents:
diff changeset
    20
98
hgs
parents: 94
diff changeset
    21
hgs
parents: 94
diff changeset
    22
/*!
hgs
parents: 94
diff changeset
    23
    \file homescreendomainpskeys.h
hgs
parents: 94
diff changeset
    24
    \brief 
hgs
parents: 94
diff changeset
    25
*/
hgs
parents: 94
diff changeset
    26
hgs
parents: 94
diff changeset
    27
/*!
hgs
parents: 94
diff changeset
    28
    P&S Key path for all Home Screen information keys provided by this API.
hgs
parents: 94
diff changeset
    29
*/
88
hgs
parents: 87
diff changeset
    30
const char HsStatePSKeyPath[] = "/homescreen";
87
hgs
parents:
diff changeset
    31
98
hgs
parents: 94
diff changeset
    32
/*!
hgs
parents: 94
diff changeset
    33
    P&S Key sub path to represent the state of the Home Screen. This property is updated when
116
hgs
parents: 99
diff changeset
    34
    Home screen state is changed. Valid values are defined by the enum EPSHomescreenState.
98
hgs
parents: 94
diff changeset
    35
    
116
hgs
parents: 99
diff changeset
    36
    \see EPSHomescreenState
98
hgs
parents: 94
diff changeset
    37
*/
88
hgs
parents: 87
diff changeset
    38
const char HsStatePSKeySubPath[] = "state";
87
hgs
parents:
diff changeset
    39
99
hgs
parents: 98
diff changeset
    40
#if defined(__SYMBIAN32__) || defined(SYMBIAN) 
98
hgs
parents: 94
diff changeset
    41
/*!
hgs
parents: 94
diff changeset
    42
    Home Screen P&S category Uid for pure Symbian usage.
hgs
parents: 94
diff changeset
    43
*/
93
hgs
parents: 88
diff changeset
    44
const TUid KHsCategoryUid = { 0x20022F35 };
hgs
parents: 88
diff changeset
    45
98
hgs
parents: 94
diff changeset
    46
/*!
hgs
parents: 94
diff changeset
    47
    P&S Key to represent the state of the Home Screen for pure Symbian usage.
hgs
parents: 94
diff changeset
    48
    This property is updated when Home screen state is changed. Valid values
116
hgs
parents: 99
diff changeset
    49
    are defined by the enum EPSHomescreenState.
98
hgs
parents: 94
diff changeset
    50
*/
93
hgs
parents: 88
diff changeset
    51
const TUint KHsCategoryStateKey = 0x1;
99
hgs
parents: 98
diff changeset
    52
#endif //SYMBIAN
116
hgs
parents: 99
diff changeset
    53
    
hgs
parents: 99
diff changeset
    54
/*!
hgs
parents: 99
diff changeset
    55
    Home screen state.
hgs
parents: 99
diff changeset
    56
    As Homescreen and Application Library are in the same process
hgs
parents: 99
diff changeset
    57
    EHomeScreenApplicationBackground and EHomeScreenApplicationForeground
hgs
parents: 99
diff changeset
    58
    information considers both of them simultaneously.
hgs
parents: 99
diff changeset
    59
*/
hgs
parents: 99
diff changeset
    60
enum EPSHomescreenState
hgs
parents: 99
diff changeset
    61
     {
hgs
parents: 99
diff changeset
    62
     /**
hgs
parents: 99
diff changeset
    63
     Invalid state. P&S key not initialized.
hgs
parents: 99
diff changeset
    64
     */
hgs
parents: 99
diff changeset
    65
     EHomeScreenInvalid = 0x0,
hgs
parents: 99
diff changeset
    66
     /**
hgs
parents: 99
diff changeset
    67
     Home Screen Application in background. 
hgs
parents: 99
diff changeset
    68
     */
hgs
parents: 99
diff changeset
    69
     EHomeScreenApplicationBackground = 0x1,
hgs
parents: 99
diff changeset
    70
     /**
hgs
parents: 99
diff changeset
    71
     Home Screen Application in foreground.
hgs
parents: 99
diff changeset
    72
     */
hgs
parents: 99
diff changeset
    73
     EHomeScreenApplicationForeground = 0x2,
hgs
parents: 99
diff changeset
    74
     /**
hgs
parents: 99
diff changeset
    75
     Home Screen in widget view.
hgs
parents: 99
diff changeset
    76
     */
hgs
parents: 99
diff changeset
    77
     EHomeScreenWidgetViewActive = 0x4,
hgs
parents: 99
diff changeset
    78
     /**
hgs
parents: 99
diff changeset
    79
     Home Screen in application library view.
hgs
parents: 99
diff changeset
    80
     */
hgs
parents: 99
diff changeset
    81
     EHomeScreenApplicationLibraryViewActive = 0x8,
hgs
parents: 99
diff changeset
    82
     /**
hgs
parents: 99
diff changeset
    83
     Home Screen in widget view in foreground.
hgs
parents: 99
diff changeset
    84
     */
hgs
parents: 99
diff changeset
    85
     EHomeScreenWidgetViewForeground = EHomeScreenApplicationForeground | EHomeScreenWidgetViewActive,
hgs
parents: 99
diff changeset
    86
     /**
hgs
parents: 99
diff changeset
    87
     Home Screen in application library view in foreground.
hgs
parents: 99
diff changeset
    88
     */
hgs
parents: 99
diff changeset
    89
     EHomeScreenApplicationLibraryViewForeground = EHomeScreenApplicationForeground | EHomeScreenApplicationLibraryViewActive 
hgs
parents: 99
diff changeset
    90
     };      
93
hgs
parents: 88
diff changeset
    91
98
hgs
parents: 94
diff changeset
    92
/*!
hgs
parents: 94
diff changeset
    93
    Home screen state.
116
hgs
parents: 99
diff changeset
    94
hgs
parents: 99
diff changeset
    95
    \deprecated EPSHsState
hgs
parents: 99
diff changeset
    96
        is deprecated. Please use EPSHomescreenState instead.
hgs
parents: 99
diff changeset
    97
hgs
parents: 99
diff changeset
    98
    \see EPSHomescreenState
98
hgs
parents: 94
diff changeset
    99
*/
87
hgs
parents:
diff changeset
   100
enum EPSHsState
hgs
parents:
diff changeset
   101
     {
hgs
parents:
diff changeset
   102
     /**
hgs
parents:
diff changeset
   103
     Invalid state. P&S key not initialized.
hgs
parents:
diff changeset
   104
     */
hgs
parents:
diff changeset
   105
     EHomeScreenInvalidState = 0,
hgs
parents:
diff changeset
   106
     /**
hgs
parents:
diff changeset
   107
     Home Screen inactive
hgs
parents:
diff changeset
   108
     */
hgs
parents:
diff changeset
   109
     EHomeScreenInactive = 1,
hgs
parents:
diff changeset
   110
     /**
hgs
parents:
diff changeset
   111
     Home Screen in idle state
hgs
parents:
diff changeset
   112
     */
hgs
parents:
diff changeset
   113
     EHomeScreenIdleState   = 2
hgs
parents:
diff changeset
   114
     };
hgs
parents:
diff changeset
   115
88
hgs
parents: 87
diff changeset
   116
#endif //HOMESCREEN_DOMAIN_PS_KEYS_H