Struct xpcom::interfaces::nsIXULStore [] [src]

#[repr(C)]
pub struct nsIXULStore { /* fields omitted */ }

interface nsIXULStore : nsISupports

/**
 * 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
 */

Methods

impl nsIXULStore
[src]

[src]

Cast this nsIXULStore to one of its base interfaces.

impl nsIXULStore
[src]

[src]

/**
   * 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);

[src]

/**
   * 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);

[src]

/**
   * 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);

[src]

/**
   * 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);

[src]

/**
   * 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);

[src]

/**
   * 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);

Methods from Deref<Target = nsISupports>

[src]

Cast this nsISupports to one of its base interfaces.

[src]

void QueryInterface (in nsIIDRef uuid, [iid_is (uuid), retval] out nsQIResult result);

[src]

[noscript,notxpcom] nsrefcnt AddRef ();

[src]

[noscript,notxpcom] nsrefcnt Release ();

Trait Implementations

impl XpCom for nsIXULStore
[src]

IID: nsIID = nsID(2558282549, 50214, 19927, [173, 73, 60, 159, 164, 198, 93, 32])

[src]

Perform a QueryInterface call on this object, attempting to dynamically cast it to the requested interface type. Returns Some(RefPtr) if the cast succeeded, and None otherwise. Read more

impl RefCounted for nsIXULStore
[src]

[src]

Increment the reference count.

[src]

Decrement the reference count, potentially freeing backing memory.

impl Deref for nsIXULStore
[src]

The resulting type after dereferencing.

[src]

Dereferences the value.