QML Global Object

Contains all the properties of the JavaScript global object, plus:

Qt Object

The Qt object provides useful enums and functions from Qt, for use in all QML files.

XMLHttpRequest

QML script supports the XMLHttpRequest object, which can be used to asynchronously obtain data from over a network.

The XMLHttpRequest API implements the same W3C standard as many popular web browsers with following exceptions:

Additionally, the responseXML XML DOM tree currently supported by QML is a reduced subset of the DOM Level 3 Core API supported in a web browser. The following objects and properties are supported by the QML implementation:

NodeDocumentElementAttrCharacterDataText
  • nodeName
  • nodeValue
  • nodeType
  • parentNode
  • childNodes
  • firstChild
  • lastChild
  • previousSibling
  • nextSibling
  • attributes
  • xmlVersion
  • xmlEncoding
  • xmlStandalone
  • documentElement
  • tagName
  • name
  • value
  • ownerElement
  • data
  • length
  • isElementContentWhitespace
  • wholeText

The XMLHttpRequest example demonstrates how to use the XMLHttpRequest object to make a request and read the response headers.

Offline Storage API

Database API

The openDatabaseSync() and related functions provide the ability to access local offline storage in an SQL database.

These databases are user-specific and QML-specific, but accessible to all QML applications. They are stored in the Databases subdirectory of QDeclarativeEngine::offlineStoragePath(), currently as SQLite databases.

The API can be used from JavaScript functions in your QML:


The API conforms to the Synchronous API of the HTML5 Web Database API, W3C Working Draft 29 October 2009.

The SQL Local Storage example demonstrates the basics of using the Offline Storage API.

db = openDatabaseSync(identifier, version, description, estimated_size, callback(db))

Returns the database identified by identifier. If the database does not already exist, it is created, and the function callback is called with the database as a parameter. description and estimated_size are written to the INI file (described below), but are otherwise currently unused.

May throw exception with code property SQLException.DATABASE_ERR, or SQLException.VERSION_ERR.

When a database is first created, an INI file is also created specifying its characteristics:

KeyValue
NameThe name of the database passed to openDatabase()
VersionThe version of the database passed to openDatabase()
DescriptionThe description of the database passed to openDatabase()
EstimatedSizeThe estimated size (in bytes) of the database passed to openDatabase()
DriverCurrently "QSQLITE"

This data can be used by application tools.

db.changeVersion(from, to, callback(tx))

This method allows you to perform a Scheme Upgrade.

If the current version of db is not from, then an exception is thrown.

Otherwise, a database transaction is created and passed to callback. In this function, you can call executeSql on tx to upgrade the database.

May throw exception with code property SQLException.DATABASE_ERR or SQLException.UNKNOWN_ERR.

db.transaction(callback(tx))

This method creates a read/write transaction and passed to callback. In this function, you can call executeSql on tx to read and modify the database.

If the callback throws exceptions, the transaction is rolled back.

db.readTransaction(callback(tx))

This method creates a read-only transaction and passed to callback. In this function, you can call executeSql on tx to read the database (with SELECT statements).

results = tx.executeSql(statement, values)

This method executes a SQL statement, binding the list of values to SQL positional parameters ("?").

It returns a results object, with the following properties:

TypePropertyValueApplicability
introws.lengthThe number of rows in the resultSELECT
varrows.item(i)Function that returns row i of the resultSELECT
introwsAffectedThe number of rows affected by a modificationUPDATE, DELETE
stringinsertIdThe id of the row insertedINSERT

May throw exception with code property SQLException.DATABASE_ERR, SQLException.SYNTAX_ERR, or SQLException.UNKNOWN_ERR.

Logging

console.log() and console.debug() can be used to print information to the console. See Debugging QML for more information.

Notes provided by the Qt Community

No notes