PageRenderTime 12ms CodeModel.GetById 8ms app.highlight 1ms RepoModel.GetById 1ms app.codeStats 0ms

/gecko_sdk/idl/nsIDOMStorage.idl

http://firefox-mac-pdf.googlecode.com/
IDL | 98 lines | 11 code | 8 blank | 79 comment | 0 complexity | 48839cedfabebd340ce2aa96da1c13ae MD5 | raw file
 1/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 2/* ***** BEGIN LICENSE BLOCK *****
 3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 4 *
 5 * The contents of this file are subject to the Mozilla Public License Version
 6 * 1.1 (the "License"); you may not use this file except in compliance with
 7 * the License. You may obtain a copy of the License at
 8 * http://www.mozilla.org/MPL/
 9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is mozilla.org code.
16 *
17 * The Initial Developer of the Original Code is
18 *   Neil Deakin <enndeakin@sympatico.ca>
19 * Portions created by the Initial Developer are Copyright (C) 2006
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 *
24 * Alternatively, the contents of this file may be used under the terms of
25 * either of the GNU General Public License Version 2 or later (the "GPL"),
26 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
35 *
36 * ***** END LICENSE BLOCK ***** */
37
38#include "domstubs.idl"
39
40/**
41 * Interface for client side storage. See
42 * http://www.whatwg.org/specs/web-apps/current-work/#scs-client-side
43 * for more information.
44 *
45 * A storage object stores an arbitrary set of key-value pairs, which
46 * may be retrieved, modified and removed as needed. A key may only
47 * exist once within a storage object, and only one value may be
48 * associated with a particular key. Keys are stored in a particular
49 * order with the condition that this order not change by merely changing
50 * the value associated with a key, but the order may change when a
51 * key is added or removed.
52 */
53
54interface nsIDOMStorageItem;
55
56[scriptable, uuid(95CC1383-3B62-4B89-AAEF-1004A513EF47)]
57interface nsIDOMStorage : nsISupports
58{
59  /**
60   * The number of keys stored.
61   */
62  readonly attribute unsigned long length;
63
64  /**
65   * Retrieve the name of the key at a particular index.
66   *
67   * @param index index of the item to retrieve
68   * @returns the key at index
69   * @throws INDEX_SIZE_ERR if there is no key at that index
70   */
71  DOMString key(in unsigned long index);
72
73  /**
74   * Retrieve an item with a given key
75   *
76   * @param key key to retrieve
77   * @returns found item or null if the key was not found
78   */
79  nsIDOMStorageItem getItem(in DOMString key);
80
81  /**
82   * Assign a value with a key. If the key does not exist already, a new
83   * key is added associated with that value. If the key already exists,
84   * then the existing value is replaced with a new value.
85   *
86   * @param key key to set
87   * @param data data to associate with the key
88   * @returns found item or null if the key was not found
89   */
90  void setItem(in DOMString key, in DOMString data);
91
92  /**
93   * Remove a key and its corresponding value.
94   *
95   * @param key key to remove
96   */
97  void removeItem(in DOMString key);
98};