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";

Collaboration diagram for nsIFormHistory2:

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.
void removeEntriesByTimeframe (in long long aBeginTime, in long long aEndTime)
 Removes entries that were created between the specified times.

Public Attributes

readonly attribute boolean hasEntries
 Returns true if the form history has any entries.
readonly attribute
mozIStorageConnection 
DBConnection
 Returns the underlying DB connection the form history module is using.

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.


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.

boolean nsIFormHistory2::nameExists ( in AString  name  ) 

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

void nsIFormHistory2::removeAllEntries (  ) 

Removes all entries in the entire form history.

void nsIFormHistory2::removeEntriesByTimeframe ( in long long  aBeginTime,
in long long  aEndTime 
)

Removes entries that were created between the specified times.

Parameters:
aBeginTime The beginning of the timeframe, in microseconds
aEndTime The end of the timeframe, in microseconds
void nsIFormHistory2::removeEntriesForName ( in AString  name  ) 

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 the underlying DB connection the form history module is using.

Returns true if the form history has any entries.


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