homescreensrv_plat/homescreen_information_api/inc/homescreendomainpskeys.h
changeset 116 305818acdca4
parent 99 7aaf39b772ac
equal deleted inserted replaced
112:dbfb5e38438b 116:305818acdca4
     1 /*
     1 /*
     2  * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
     2  * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
     3  * All rights reserved.
     3  * All rights reserved.
     4  * This component and the accompanying materials are made available
     4  * This component and the accompanying materials are made available
     5  * under the terms of "Eclipse Public License v1.0"
     5  * under the terms of "Eclipse Public License v1.0"
     6  * which accompanies this distribution, and is available
     6  * which accompanies this distribution, and is available
     7  * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7  * at the URL "http://www.eclipse.org/legal/epl-v10.html".
    29 */
    29 */
    30 const char HsStatePSKeyPath[] = "/homescreen";
    30 const char HsStatePSKeyPath[] = "/homescreen";
    31 
    31 
    32 /*!
    32 /*!
    33     P&S Key sub path to represent the state of the Home Screen. This property is updated when
    33     P&S Key sub path to represent the state of the Home Screen. This property is updated when
    34     Home screen state is changed. Valid values are defined by the enum EPSHsState.
    34     Home screen state is changed. Valid values are defined by the enum EPSHomescreenState.
    35     
    35     
    36     @see EPSHsState
    36     \see EPSHomescreenState
    37 */
    37 */
    38 const char HsStatePSKeySubPath[] = "state";
    38 const char HsStatePSKeySubPath[] = "state";
    39 
    39 
    40 #if defined(__SYMBIAN32__) || defined(SYMBIAN) 
    40 #if defined(__SYMBIAN32__) || defined(SYMBIAN) 
    41 /*!
    41 /*!
    44 const TUid KHsCategoryUid = { 0x20022F35 };
    44 const TUid KHsCategoryUid = { 0x20022F35 };
    45 
    45 
    46 /*!
    46 /*!
    47     P&S Key to represent the state of the Home Screen for pure Symbian usage.
    47     P&S Key to represent the state of the Home Screen for pure Symbian usage.
    48     This property is updated when Home screen state is changed. Valid values
    48     This property is updated when Home screen state is changed. Valid values
    49     are defined by the enum EPSHsState.
    49     are defined by the enum EPSHomescreenState.
    50 */
    50 */
    51 const TUint KHsCategoryStateKey = 0x1;
    51 const TUint KHsCategoryStateKey = 0x1;
    52 #endif //SYMBIAN
    52 #endif //SYMBIAN
       
    53     
       
    54 /*!
       
    55     Home screen state.
       
    56     As Homescreen and Application Library are in the same process
       
    57     EHomeScreenApplicationBackground and EHomeScreenApplicationForeground
       
    58     information considers both of them simultaneously.
       
    59 */
       
    60 enum EPSHomescreenState
       
    61      {
       
    62      /**
       
    63      Invalid state. P&S key not initialized.
       
    64      */
       
    65      EHomeScreenInvalid = 0x0,
       
    66      /**
       
    67      Home Screen Application in background. 
       
    68      */
       
    69      EHomeScreenApplicationBackground = 0x1,
       
    70      /**
       
    71      Home Screen Application in foreground.
       
    72      */
       
    73      EHomeScreenApplicationForeground = 0x2,
       
    74      /**
       
    75      Home Screen in widget view.
       
    76      */
       
    77      EHomeScreenWidgetViewActive = 0x4,
       
    78      /**
       
    79      Home Screen in application library view.
       
    80      */
       
    81      EHomeScreenApplicationLibraryViewActive = 0x8,
       
    82      /**
       
    83      Home Screen in widget view in foreground.
       
    84      */
       
    85      EHomeScreenWidgetViewForeground = EHomeScreenApplicationForeground | EHomeScreenWidgetViewActive,
       
    86      /**
       
    87      Home Screen in application library view in foreground.
       
    88      */
       
    89      EHomeScreenApplicationLibraryViewForeground = EHomeScreenApplicationForeground | EHomeScreenApplicationLibraryViewActive 
       
    90      };      
    53 
    91 
    54 /*!
    92 /*!
    55     Home screen state.
    93     Home screen state.
       
    94 
       
    95     \deprecated EPSHsState
       
    96         is deprecated. Please use EPSHomescreenState instead.
       
    97 
       
    98     \see EPSHomescreenState
    56 */
    99 */
    57 enum EPSHsState
   100 enum EPSHsState
    58      {
   101      {
    59      /**
   102      /**
    60      Invalid state. P&S key not initialized.
   103      Invalid state. P&S key not initialized.