/*
 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
 * All rights reserved.
 * This component and the accompanying materials are made available
 * under the terms of "Eclipse Public License v1.0"
 * which accompanies this distribution, and is available
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
 *
 * Initial Contributors:
 * Nokia Corporation - initial contribution.
 *
 * Contributors:
 *
 * Description: declaration of functions providing string constants
 *
 */

#ifndef HOMESCREEN_DOMAIN_PS_KEYS_H
#define HOMESCREEN_DOMAIN_PS_KEYS_H

/**
 * P&S Key path for all Home Screen information keys provided by this API.
 */
const char HsStatePSKeyPath[] = "/homescreen";

/**
 * P&S Key sub path to represent the state of the Home Screen. This property is updated when
 * Home screen state is changed. Valid values are defined by the enum EPSHsState.
 *
 * @see EPSHsState
 */
const char HsStatePSKeySubPath[] = "state";

#ifdef Q_OS_SYMBIAN
/**
 * Home Screen P&S category Uid for pure Symbian usage.
 */
const TUid KHsCategoryUid = { 0x20022F35 };

/**
 * P&S Key to represent the state of the Home Screen for pure Symbian usage.
 * This property is updated when Home screen state is changed. Valid values
 * are defined by the enum EPSHsState.
 */
const TUint KHsCategoryStateKey = 0x1;
#endif //Q_OS_SYMBIAN

/**
 * Home screen state.
 */
enum EPSHsState
     {
     /**
     Invalid state. P&S key not initialized.
     */
     EHomeScreenInvalidState = 0,
     /**
     Home Screen inactive
     */
     EHomeScreenInactive = 1,
     /**
     Home Screen in idle state
     */
     EHomeScreenIdleState   = 2
     };

#endif //HOMESCREEN_DOMAIN_PS_KEYS_H