camerauis/cameraxui/cxengine/inc/cxesettingsstore.h
author hgs
Fri, 06 Aug 2010 10:03:37 +0300
changeset 46 c826656d6714
permissions -rw-r--r--
201031
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
46
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 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:
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
#ifndef  CXESETTINGSSTORE_H_
hgs
parents:
diff changeset
    18
#define  CXESETTINGSSTORE_H_
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
//  Include Files
hgs
parents:
diff changeset
    21
#include <QHash>
hgs
parents:
diff changeset
    22
#include <QVariant>
hgs
parents:
diff changeset
    23
#include <QMetaType>
hgs
parents:
diff changeset
    24
#include "cxeerror.h"
hgs
parents:
diff changeset
    25
#include "cxenamespace.h"
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
/*!
hgs
parents:
diff changeset
    28
* Settings store intrerface.
hgs
parents:
diff changeset
    29
*/
hgs
parents:
diff changeset
    30
class CxeSettingsStore
hgs
parents:
diff changeset
    31
{
hgs
parents:
diff changeset
    32
public:
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
    /*!
hgs
parents:
diff changeset
    35
     * Destructor. Needs to be virtual.
hgs
parents:
diff changeset
    36
    */
hgs
parents:
diff changeset
    37
    virtual ~CxeSettingsStore() {};
hgs
parents:
diff changeset
    38
hgs
parents:
diff changeset
    39
    /*!
hgs
parents:
diff changeset
    40
    * resets the cenrep store
hgs
parents:
diff changeset
    41
    */
hgs
parents:
diff changeset
    42
    virtual void reset() = 0;
hgs
parents:
diff changeset
    43
    
hgs
parents:
diff changeset
    44
    /*!
hgs
parents:
diff changeset
    45
    * Reads a value from cenrep
hgs
parents:
diff changeset
    46
    * \param "key"   - setting key
hgs
parents:
diff changeset
    47
    * \param "value" - setting value read from cenrep
hgs
parents:
diff changeset
    48
    */
hgs
parents:
diff changeset
    49
	virtual CxeError::Id get(const QString &key, QVariant &value) = 0;
hgs
parents:
diff changeset
    50
hgs
parents:
diff changeset
    51
    /*!
hgs
parents:
diff changeset
    52
    * Reads a value from the settings store and starts monitoring it.
hgs
parents:
diff changeset
    53
    * \param "uid"   - UID of the component that own setting key
hgs
parents:
diff changeset
    54
    * \param "key"   - setting key id
hgs
parents:
diff changeset
    55
    * \param "type"  - type of setting key
hgs
parents:
diff changeset
    56
    * \param "value" - setting value read from cenrep
hgs
parents:
diff changeset
    57
    */
hgs
parents:
diff changeset
    58
    virtual void startMonitoring(long int uid, unsigned long int key, Cxe::SettingKeyType type, QVariant &value) = 0;
hgs
parents:
diff changeset
    59
hgs
parents:
diff changeset
    60
   /*!
hgs
parents:
diff changeset
    61
    * Sets a new value to cenrep
hgs
parents:
diff changeset
    62
    * \param "key"   - setting key
hgs
parents:
diff changeset
    63
    * \param "newValue" - new value set to the key in cenrep
hgs
parents:
diff changeset
    64
    */
hgs
parents:
diff changeset
    65
	virtual CxeError::Id set(const QString &key,const QVariant newValue) = 0;
hgs
parents:
diff changeset
    66
	    
hgs
parents:
diff changeset
    67
	/*!
hgs
parents:
diff changeset
    68
    * Reads/loads all run-time variation settings values from cenrep
hgs
parents:
diff changeset
    69
    * @param QList<QString> contains list of all runtime variation key ids which we use to load values from cenrep.
hgs
parents:
diff changeset
    70
    * returns: QHash container, "contains" values associated with each key that are read from cenrep
hgs
parents:
diff changeset
    71
    * NOTE: loading runtime variation settings should be done only ONCE at start-up. Its an overhead to read variation keys
hgs
parents:
diff changeset
    72
    *       unnecessarily multiple times as the values of the runtime keys are not changed.
hgs
parents:
diff changeset
    73
    *       Variation keys are only used to configure camerax application.
hgs
parents:
diff changeset
    74
    */
hgs
parents:
diff changeset
    75
	virtual QHash<QString, QVariantList> loadVariationSettings(QList<QString> &settingKeys) = 0;
hgs
parents:
diff changeset
    76
};
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
hgs
parents:
diff changeset
    79
#endif  // CXESETTINGSSTORE_H_
hgs
parents:
diff changeset
    80