homescreensrv_plat/homescreen_information_api/inc/homescreendomainpskeys.h
author hgs
Fri, 11 Jun 2010 16:13:51 +0300
changeset 98 d2f833ab7940
parent 94 dbb8300717f7
child 99 7aaf39b772ac
permissions -rw-r--r--
201023
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
87
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
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
hgs
parents: 94
diff changeset
    34
    Home screen state is changed. Valid values are defined by the enum EPSHsState.
hgs
parents: 94
diff changeset
    35
    
hgs
parents: 94
diff changeset
    36
    @see EPSHsState
hgs
parents: 94
diff changeset
    37
*/
88
hgs
parents: 87
diff changeset
    38
const char HsStatePSKeySubPath[] = "state";
87
hgs
parents:
diff changeset
    39
94
hgs
parents: 93
diff changeset
    40
#ifdef Q_OS_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
hgs
parents: 94
diff changeset
    49
    are defined by the enum EPSHsState.
hgs
parents: 94
diff changeset
    50
*/
93
hgs
parents: 88
diff changeset
    51
const TUint KHsCategoryStateKey = 0x1;
94
hgs
parents: 93
diff changeset
    52
#endif //Q_OS_SYMBIAN
93
hgs
parents: 88
diff changeset
    53
98
hgs
parents: 94
diff changeset
    54
/*!
hgs
parents: 94
diff changeset
    55
    Home screen state.
hgs
parents: 94
diff changeset
    56
*/
87
hgs
parents:
diff changeset
    57
enum EPSHsState
hgs
parents:
diff changeset
    58
     {
hgs
parents:
diff changeset
    59
     /**
hgs
parents:
diff changeset
    60
     Invalid state. P&S key not initialized.
hgs
parents:
diff changeset
    61
     */
hgs
parents:
diff changeset
    62
     EHomeScreenInvalidState = 0,
hgs
parents:
diff changeset
    63
     /**
hgs
parents:
diff changeset
    64
     Home Screen inactive
hgs
parents:
diff changeset
    65
     */
hgs
parents:
diff changeset
    66
     EHomeScreenInactive = 1,
hgs
parents:
diff changeset
    67
     /**
hgs
parents:
diff changeset
    68
     Home Screen in idle state
hgs
parents:
diff changeset
    69
     */
hgs
parents:
diff changeset
    70
     EHomeScreenIdleState   = 2
hgs
parents:
diff changeset
    71
     };
hgs
parents:
diff changeset
    72
88
hgs
parents: 87
diff changeset
    73
#endif //HOMESCREEN_DOMAIN_PS_KEYS_H