gecko/toolkit/components/satchel/public/nsIFormHistory.idl

124 lines
4.2 KiB
Plaintext
Raw Normal View History

/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 2001
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Joe Hewitt <hewitt@netscape.com> (Original Author)
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
interface nsIFile;
interface mozIStorageConnection;
/**
* 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.
*/
[scriptable, uuid(5d7d84d1-9798-4016-bf61-a32acf09b29d)]
interface nsIFormHistory2 : nsISupports
{
/**
* Returns true if the form history has any entries.
*/
readonly attribute boolean hasEntries;
/**
* Adds a name and value pair to the form history.
*/
void addEntry(in AString name, in AString value);
/**
* Removes a name and value pair from the form history.
*/
void removeEntry(in AString name, in AString value);
/**
* Removes all entries that are paired with a name.
*/
void removeEntriesForName(in AString name);
/**
* Removes all entries in the entire form history.
*/
void removeAllEntries();
/**
* Returns true if there is no entry that is paired with a name.
*/
boolean nameExists(in AString name);
/**
* Gets whether a name and value pair exists in the form history.
*/
boolean entryExists(in AString name, in AString value);
/**
* Removes entries that were created between the specified times.
*
* @param aBeginTime
* The beginning of the timeframe, in microseconds
* @param aEndTime
* The end of the timeframe, in microseconds
*/
void removeEntriesByTimeframe(in long long aBeginTime, in long long aEndTime);
/**
* Returns the underlying DB connection the form history module is using.
*/
readonly attribute mozIStorageConnection DBConnection;
};
/**
* nsIFormHistoryImporter is an interface for importing a Mork formhistory.dat
* file into the new form history storage.
*/
[scriptable, uuid(9e811188-6a5b-4d96-a92d-1bac66a41898)]
interface nsIFormHistoryImporter : nsISupports
{
/**
* Import the given Mork form history file.
* @param file The Mork form history file to import
* @param history A reference to the nsIFormHistory. This is
* supplied since the importer is invoked during
* form history initialization.
*/
void importFormHistory(in nsIFile file, in nsIFormHistory2 formHistory);
};