Interface nsIXULStoreType

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.

The data is serialized to [profile directory]/xulstore.json

Hierarchy

Methods

AddRef QueryInterface Release getAttributeEnumerator getIDsEnumerator getValue hasValue persist removeDocument removeValue setValue

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

getAttributeEnumerator

  • Iterates over all of the attributes associated with a given document uri and id that have stored data.

    Parameters

    • doc: string

      document URI

    • id: string

      identifier of the node

    Returns nsIStringEnumerator

getIDsEnumerator

  • Iterates over all of the ids associated with a given document uri that have stored data.

    Parameters

    • doc: string

      document URI

    Returns nsIStringEnumerator

getValue

  • Retrieves a value in the store, or an empty string if it does not exist.

    Returns

    the value of the attribute

    Parameters

    • doc: string

      document URI

    • id: string

      identifier of the node

    • attr: string

      attribute to retrieve

    Returns string

hasValue

  • Returns true if the store contains a value for attr.

    Parameters

    • doc: string

      URI of the document

    • id: string

      identifier of the node

    • attr: string

      attribute

    Returns bool

persist

  • 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).

    Parameters

    • aNode: Node
    • attr: string

      attribute to store

    Returns void

removeDocument

  • Removes all values related to the given document.

    Parameters

    • doc: string

      document URI

    Returns void

removeValue

  • Removes a value in the store.

    Parameters

    • doc: string

      document URI

    • id: string

      identifier of the node

    • attr: string

      attribute to remove

    Returns void

setValue

  • Sets a value in the store.

    Parameters

    • doc: string

      document URI

    • id: string

      identifier of the node

    • attr: string

      attribute to store

    • value: string

      value of the attribute

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc