PersistentObject

Comments

(no comments yet)

Log in or Join to leave comments.

This article explains how to create and use simple persistent objects in QML

Article Metadata

---

Code Example

Source file: https://projects.developer.nokia.com/persistentobject/browser

---

Compatibility

Platform(s): QtQuick 1.0+ (MeeGo Harmattan, Symbian, desktop)

Device(s): MeeGo Harmattan and newer, Symbian^1 and newer

---

Article

Keywords: QML, QtQuick, settings, storage, persistence

Created: (28 May 2012)

Last edited: hamishwillee (13 Jun 2012)

Introduction

Apps often need to store (persist) low-volume data between sessions. This can be account names, user settings, recently viewed items, etc. QML in Qt Quick has no direct support for this. However, combining Qt Quick's Offline Storage API and QML, this feature can be added very elegantly.

Usage

Include PersistentObject.qml and PersistentObjectStore.js to your QML directory (see "Code Example" on the right for these files). Now you can declare a PersistentObject object everywhere you want. The properties you declare in this object are automatically loaded and saved each time the application is started or exited.

Example:

import QtQuick 1.0
 
Rectangle {
	width: 300
	height: 300
 
	PersistentObject {
		id: simpleObject
		property string someText: "initial text"
	}
 
	TextInput {
		text: simpleObject.someText
		onTextChanged: simpleObject.someText = text
	}
}

When you start this application for the first time, the text "initial text" is shown in an editable input field. When you alter this text, quit the app and restart it again, the altered text is shown instead. Data is stored on a per-application basis. For the Nokia N9, the storage directory is /home/user/.local/share/data/QML/OfflineStorage/Databases.

More demos and sources can be downloaded from the PersistentObject project. For a real live example take a look at "main.qml" of the Nokia N9 buienradar app.

Limitations and caveats

• As this method was designed and tested to store nothing more than some basic application settings, it's probably best to limit the number and complexity of the properties you want to store.
• Data is stored unencrypted and can be read by other apps.
• If you want to use more than one PersistentObject in your application, don't forget to provide an unique objectName for each PersistentObject (see demo4.qml). The default objectName is "default".

Alternatives

Some alternative solutions for storing data in Qt Quick apps worth investigating:

• Using_QSettings_in_QML_with_also_json_and_XML_support
• How-to_create_a_persistent_settings_database_in_Qt_Quick_(QML)

Summary

PersistentObjects are simple pure QML objects just like QtObject. However, the property values of a PersistentObject are automatically saved between sessions. Useful for storing user settings in QML applications. Uses the QML Offline Storage API.