зеркало из https://github.com/mozilla/gecko-dev.git
119 строки
4.4 KiB
Plaintext
119 строки
4.4 KiB
Plaintext
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* ***** 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 Robert Sayre.
|
|
* Portions created by the Initial Developer are Copyright (C) 2006
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* 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 nsIFeedResult;
|
|
interface nsIFeedEntry;
|
|
|
|
/**
|
|
* nsIFeedResultListener defines a callback used when feed processing
|
|
* completes.
|
|
*/
|
|
[scriptable, uuid(4d2ebe88-36eb-4e20-bcd1-997b3c1f24ce)]
|
|
interface nsIFeedResultListener : nsISupports
|
|
{
|
|
/**
|
|
* Always called, even after an error. There could be new feed-level
|
|
* data available at this point, if it followed or was interspersed
|
|
* with the items. Fire-and-Forget implementations only need this.
|
|
*
|
|
* @param result
|
|
* An object implementing nsIFeedResult representing the feed
|
|
* and its metadata.
|
|
*/
|
|
void handleResult(in nsIFeedResult result);
|
|
};
|
|
|
|
|
|
/**
|
|
* nsIFeedProgressListener defines callbacks used during feed
|
|
* processing.
|
|
*/
|
|
[scriptable, uuid(ebfd5de5-713c-40c0-ad7c-f095117fa580)]
|
|
interface nsIFeedProgressListener : nsIFeedResultListener {
|
|
|
|
/**
|
|
* ReportError will be called in the event of fatal
|
|
* XML errors, or if the document is not a feed. The bozo
|
|
* bit will be set if the error was due to a fatal error.
|
|
*
|
|
* @param errorText
|
|
* A short description of the error.
|
|
* @param lineNumber
|
|
* The line on which the error occurred.
|
|
*/
|
|
void reportError(in AString errorText, in long lineNumber,
|
|
in boolean bozo);
|
|
|
|
/**
|
|
* StartFeed will be called as soon as a reasonable start to
|
|
* a feed is detected.
|
|
*
|
|
* @param result
|
|
* An object implementing nsIFeedResult representing the feed
|
|
* and its metadata. At this point, the result has version
|
|
* information.
|
|
*/
|
|
void handleStartFeed(in nsIFeedResult result);
|
|
|
|
/**
|
|
* Called when the first entry/item is encountered. In Atom, all
|
|
* feed data is required to preceed the entries. In RSS, the data
|
|
* usually does. If the type is one of the entry/item-only types,
|
|
* this event will not be called.
|
|
*
|
|
* @param result
|
|
* An object implementing nsIFeedResult representing the feed
|
|
* and its metadata. At this point, the result will likely have
|
|
* most of its feed-level metadata.
|
|
*/
|
|
void handleFeedAtFirstEntry(in nsIFeedResult result);
|
|
|
|
/**
|
|
* Called after each entry/item. If the document is a standalone
|
|
* item or entry, this HandleFeedAtFirstEntry will not have been
|
|
* called. Also, this entry's parent field will be null.
|
|
*
|
|
* @param entry
|
|
* An object implementing nsIFeedEntry that represents the latest
|
|
* entry encountered.
|
|
* @param result
|
|
* An object implementing nsIFeedResult representing the feed
|
|
* and its metadata.
|
|
*/
|
|
void handleEntry(in nsIFeedEntry entry, in nsIFeedResult result);
|
|
};
|