dom/webidl/IDBCursor.webidl
author Andrea Marchesini <amarchesini@mozilla.com>
Thu, 01 Aug 2013 00:28:13 +0200
changeset 153114 5737186129bb1a475066132919de7f53f3d0f058
parent 153072 947b4570fae6827474da90120767c7ef3218dc68
child 156930 d3e6b1baf02ef8cc8c336f389ea44bbf7c2ffa63
permissions -rw-r--r--
Bug 891944 - Move IDBCursor to WebIDL, r=janv

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * The origin of this IDL file is
 * https://dvcs.w3.org/hg/IndexedDB/raw-file/tip/Overview.html#idl-def-IDBCursorDirection
 */

enum IDBCursorDirection {
    "next",
    "nextunique",
    "prev",
    "prevunique"
};

interface IDBCursor {
    // This should be: readonly    attribute (IDBObjectStore or IDBIndex) source;
    readonly    attribute nsISupports source;

    readonly    attribute IDBCursorDirection           direction;

    [Throws]
    readonly    attribute any                          key;

    [Throws]
    readonly    attribute any                          primaryKey;

    [Throws]
    IDBRequest update (any value);

    [Throws]
    void       advance ([EnforceRange] unsigned long count);

    [Throws]
    void       continue (optional any key);

    [Throws]
    IDBRequest delete ();
};

interface IDBCursorWithValue : IDBCursor {
    [Throws]
    readonly    attribute any value;
};