Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIFormHistory2 Interface Reference

The nsIFormHistory object is a service which holds a set of name/value pairs. More...

import "nsIFormHistory.idl";

Inheritance diagram for nsIFormHistory2:
Inheritance graph
[legend]
Collaboration diagram for nsIFormHistory2:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void addEntry (in AString name, in AString value)
 Adds a name and value pair to the form history.
void removeEntry (in AString name, in AString value)
 Removes a name and value pair from the form history.
void removeEntriesForName (in AString name)
 Removes all entries that are paired with a name.
void removeAllEntries ()
 Removes all entries in the entire form history.
boolean nameExists (in AString name)
 Returns true if there is no entry that is paired with a name.
boolean entryExists (in AString name, in AString value)
 Gets whether a name and value pair exists in the form history.

Public Attributes

readonly attribute boolean hasEntries
 Returns true if the form history has any entries.

Detailed Description

The nsIFormHistory object is a service which holds a set of name/value pairs.

The names correspond to form field names, and the values correspond to values the user has submitted. So, several values may exist for a single name.

Note: this interface provides no means to access stored values. Stored values are used by the FormFillController to generate autocomplete matches.

Definition at line 53 of file nsIFormHistory.idl.


Member Function Documentation

void nsIFormHistory2::addEntry ( in AString  name,
in AString  value 
)

Adds a name and value pair to the form history.

boolean nsIFormHistory2::entryExists ( in AString  name,
in AString  value 
)

Gets whether a name and value pair exists in the form history.

Returns true if there is no entry that is paired with a name.

Removes all entries in the entire form history.

Removes all entries that are paired with a name.

void nsIFormHistory2::removeEntry ( in AString  name,
in AString  value 
)

Removes a name and value pair from the form history.


Member Data Documentation

Returns true if the form history has any entries.

Definition at line 58 of file nsIFormHistory.idl.


The documentation for this interface was generated from the following file: