dom/webidl/IDBCursor.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  *
   6  * The origin of this IDL file is
   7  * https://dvcs.w3.org/hg/IndexedDB/raw-file/tip/Overview.html#idl-def-IDBCursorDirection
   8  */
   9
  10 enum IDBCursorDirection {
  11     "next",
  12     "nextunique",
  13     "prev",
  14     "prevunique"
  15 };
  16
  17 [Exposed=(Window,Worker)]
  18 interface IDBCursor {
  19     readonly    attribute (IDBObjectStore or IDBIndex) source;
  20
  21     [BinaryName="getDirection"]
  22     readonly    attribute IDBCursorDirection           direction;
  23
  24     [Throws]
  25     readonly    attribute any                          key;
  26
  27     [Throws]
  28     readonly    attribute any                          primaryKey;
  29
  30     readonly    attribute IDBRequest                   request;
  31
  32     [Throws]
  33     IDBRequest update (any value);
  34
  35     [Throws]
  36     void       advance ([EnforceRange] unsigned long count);
  37
  38     [Throws]
  39     void       continue (optional any key);
  40
  41     [Throws]
  42     void       continuePrimaryKey(any key, any primaryKey);
  43
  44     [Throws]
  45     IDBRequest delete ();
  46 };
  47
  48 [Exposed=(Window,Worker)]
  49 interface IDBCursorWithValue : IDBCursor {
  50     [Throws]
  51     readonly    attribute any value;
  52 };