|
85
|
1 |
/*
|
|
|
2 |
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
|
3 |
* All rights reserved.
|
|
|
4 |
* This component and the accompanying materials are made available
|
|
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
|
6 |
* which accompanies this distribution, and is available
|
|
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
|
8 |
*
|
|
|
9 |
* Initial Contributors:
|
|
|
10 |
* Nokia Corporation - initial contribution.
|
|
|
11 |
*
|
|
|
12 |
* Contributors:
|
|
|
13 |
*
|
|
|
14 |
* Description: Preference store interface.
|
|
|
15 |
*
|
|
|
16 |
*/
|
|
|
17 |
|
|
|
18 |
#ifndef HSIPREFERENCESTORE_H
|
|
|
19 |
#define HSIPREFERENCESTORE_H
|
|
|
20 |
|
|
|
21 |
|
|
|
22 |
class QString;
|
|
|
23 |
|
|
|
24 |
/*!
|
|
|
25 |
\ingroup group_hscontentmodel group_widget_api_candidates
|
|
|
26 |
\class IHsPreferenceStore
|
|
|
27 |
\brief Interface class for preference store.
|
|
|
28 |
|
|
|
29 |
The preference store is a key/value store with both the key and
|
|
|
30 |
the value being strings. The widget may store data to be reused
|
|
|
31 |
at a later date, such as a username, settings for the widget, persistent data,
|
|
|
32 |
and so on. The data is stored on the device, for example on its hard drive,
|
|
|
33 |
and can be read back at any time.
|
|
|
34 |
*/
|
|
|
35 |
class IHsPreferenceStore
|
|
|
36 |
{
|
|
|
37 |
|
|
|
38 |
public:
|
|
|
39 |
|
|
|
40 |
/*!
|
|
|
41 |
Virtual destructor.
|
|
|
42 |
*/
|
|
|
43 |
virtual ~IHsPreferenceStore() {};
|
|
|
44 |
|
|
|
45 |
/*!
|
|
|
46 |
Save a widget preference.
|
|
|
47 |
This method will store the given value in the widget
|
|
|
48 |
in the widget preference store for the given key.
|
|
|
49 |
|
|
|
50 |
The preference store is unique to this widget and any values
|
|
|
51 |
stored in it are persisted if the widget is reloaded or closed
|
|
|
52 |
and started again.
|
|
|
53 |
|
|
|
54 |
If a value for the given key already exists, it is silently
|
|
|
55 |
overwritten. Storing an empty string for the given key will
|
|
|
56 |
create an entry for the given key with an empty string as its value.
|
|
|
57 |
|
|
|
58 |
\a id HsWidget's unique identifier
|
|
|
59 |
\a key The string to save the preference under.
|
|
|
60 |
\a value The value of the preference.
|
|
|
61 |
*/
|
|
|
62 |
virtual bool setPreferenceForKey(int id, const QString &key, const QString &value) = 0;
|
|
|
63 |
|
|
|
64 |
/*!
|
|
|
65 |
Get a preference from the widget preference store.
|
|
|
66 |
Get the value stored for the given key in the widget preference store.
|
|
|
67 |
If there is no value for the given key, an empty string is returned.
|
|
|
68 |
|
|
|
69 |
\a id HsWidget's unique identifier
|
|
|
70 |
\a key The preference to get from the preference store.
|
|
|
71 |
\a value The value of the preference is written to this object.
|
|
|
72 |
*/
|
|
|
73 |
virtual bool preferenceForKey(int id, const QString &key, QString &value) = 0;
|
|
|
74 |
|
|
|
75 |
};
|
|
|
76 |
|
|
|
77 |
|
|
|
78 |
|
|
|
79 |
|
|
|
80 |
#endif
|