Adding upstream version 110.0.1.upstream/110.0.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 100 insertions, 0 deletions

diff --git a/toolkit/components/xulstore/nsIXULStore.idl b/toolkit/components/xulstore/nsIXULStore.idl
new file mode 100644
index 0000000000..48e68e8862
--- /dev/null
+++ b/toolkit/components/xulstore/nsIXULStore.idl
@@ -0,0 +1,100 @@
+/* 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/. */
+
+#include "nsISupports.idl"
+
+interface nsIStringEnumerator;
+webidl Node;
+
+/**
+ * The XUL store is used to store information related to a XUL document/application.
+ * Typically it is used to store the persisted state for the document, such as
+ * window location, toolbars that are open and nodes that are open and closed in a tree.
+ *
+ * If MOZ_NEW_XULSTORE is enabled:
+ * XULStore.jsm wraps this API in useful abstractions for JS consumers.
+ * XULStore.h provides a more idiomatic API for C++ consumers.
+ * You should use those APIs unless you have good reasons to use this one.
+ *
+ * If MOZ_NEW_XULSTORE is disabled:
+ * The data is serialized to [profile directory]/xulstore.json
+ */
+[scriptable, uuid(987c4b35-c426-4dd7-ad49-3c9fa4c65d20)]
+interface nsIXULStore: nsISupports
+{
+  /**
+   * Sets a value for a specified node's attribute, except in
+   * the case below:
+   * If the value is empty and if calling `hasValue` with the node's
+   * document and ID and `attr` would return true, then the
+   * value instead gets removed from the store (see Bug 1476680).
+   *
+   * @param node - DOM node
+   * @param attr - attribute to store
+   */
+  void persist(in Node aNode, in AString attr);
+
+  /**
+   * Sets a value in the store.
+   *
+   * @param doc - document URI
+   * @param id - identifier of the node
+   * @param attr - attribute to store
+   * @param value - value of the attribute
+   */
+  void setValue(in AString doc, in AString id, in AString attr, in AString value);
+
+  /**
+   * Returns true if the store contains a value for attr.
+   *
+   * @param doc - URI of the document
+   * @param id - identifier of the node
+   * @param attr - attribute
+   */
+  bool hasValue(in AString doc, in AString id, in AString attr);
+
+  /**
+   * Retrieves a value in the store, or an empty string if it does not exist.
+   *
+   * @param doc - document URI
+   * @param id - identifier of the node
+   * @param attr - attribute to retrieve
+   *
+   * @returns the value of the attribute
+   */
+  AString getValue(in AString doc, in AString id, in AString attr);
+
+  /**
+   * Removes a value in the store.
+   *
+   * @param doc - document URI
+   * @param id - identifier of the node
+   * @param attr - attribute to remove
+   */
+  void removeValue(in AString doc, in AString id, in AString attr);
+
+  /**
+   * Removes all values related to the given document.
+   *
+   * @param doc - document URI
+   */
+  void removeDocument(in AString doc);
+
+  /**
+   * Iterates over all of the ids associated with a given document uri that
+   * have stored data.
+   *
+   * @param doc - document URI
+   */
+  nsIStringEnumerator getIDsEnumerator(in AString doc);
+
+  /**
+   * Iterates over all of the attributes associated with a given document uri
+   * and id that have stored data.
+   *
+   * @param doc - document URI
+   * @param id - identifier of the node
+   */
+  nsIStringEnumerator getAttributeEnumerator(in AString doc, in AString id);
+};