From 5f8de423f190bbb79a62f804151bc24824fa32d8 Mon Sep 17 00:00:00 2001 From: "Matt A. Tobin" Date: Fri, 2 Feb 2018 04:16:08 -0500 Subject: Add m-esr52 at 52.6.0 --- rdf/base/nsIRDFXMLSink.idl | 130 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 130 insertions(+) create mode 100644 rdf/base/nsIRDFXMLSink.idl (limited to 'rdf/base/nsIRDFXMLSink.idl') diff --git a/rdf/base/nsIRDFXMLSink.idl b/rdf/base/nsIRDFXMLSink.idl new file mode 100644 index 000000000..8c9d9461c --- /dev/null +++ b/rdf/base/nsIRDFXMLSink.idl @@ -0,0 +1,130 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +/* + + Interfaces for the RDF/XML sink, which parses RDF/XML into + a graph representation. + +*/ + +#include "nsISupports.idl" + +// XXX Until these get scriptable. See nsIRDFXMLSink::AddNameSpace() +[ptr] native nsIAtomPtr(nsIAtom); +[ref] native nsStringRef(nsString); +%{C++ +class nsIAtom; +class nsString; +%} + +interface nsIRDFXMLSink; + +/** + * An observer that is notified as progress is made on the load + * of an RDF/XML document in an nsIRDFXMLSink. + */ +[scriptable, uuid(EB1A5D30-AB33-11D2-8EC6-00805F29F370)] +interface nsIRDFXMLSinkObserver : nsISupports +{ + /** + * Called when the load begins. + * @param aSink the RDF/XML sink on which the load is beginning. + */ + void onBeginLoad(in nsIRDFXMLSink aSink); + + /** + * Called when the load is suspended (e.g., for network quantization). + * @param aSink the RDF/XML sink that is being interrupted. + */ + void onInterrupt(in nsIRDFXMLSink aSink); + + /** + * Called when a suspended load is resuming. + * @param aSink the RDF/XML sink that is resuming. + */ + void onResume(in nsIRDFXMLSink aSink); + + /** + * Called when an RDF/XML load completes successfully. + * @param aSink the RDF/XML sink that has finished loading. + */ + void onEndLoad(in nsIRDFXMLSink aSink); + + /** + * Called when an error occurs during the load + * @param aSink the RDF/XML sink in which the error occurred + * @param aStatus the networking result code + * @param aErrorMsg an error message, if applicable + */ + void onError(in nsIRDFXMLSink aSink, in nsresult aStatus, in wstring aErrorMsg); +}; + + + +/** + * A "sink" that receives and processes RDF/XML. This interface is used + * by the RDF/XML parser. + */ +[scriptable, uuid(EB1A5D31-AB33-11D2-8EC6-00805F29F370)] +interface nsIRDFXMLSink : nsISupports +{ + /** + * Set to true if the sink is read-only and cannot + * be modified + */ + attribute boolean readOnly; + + /** + * Initiate the RDF/XML load. + */ + void beginLoad(); + + /** + * Suspend the RDF/XML load. + */ + void interrupt(); + + /** + * Resume the RDF/XML load. + */ + void resume(); + + /** + * Complete the RDF/XML load. + */ + void endLoad(); + + /** + * Add namespace information to the RDF/XML sink. + * @param aPrefix the namespace prefix + * @param aURI the namespace URI + */ + [noscript] void addNameSpace(in nsIAtomPtr aPrefix, + [const] in nsStringRef aURI); + + /** + * Add an observer that will be notified as the RDF/XML load + * progresses. + *

+ * + * Note that the sink will acquire a strong reference to the + * observer, so care should be taken to avoid cyclical references + * that cannot be released (i.e., if the observer holds a + * reference to the sink, it should be sure that it eventually + * clears the reference). + * + * @param aObserver the observer to add to the sink's set of + * load observers. + */ + void addXMLSinkObserver(in nsIRDFXMLSinkObserver aObserver); + + /** + * Remove an observer from the sink's set of observers. + * @param aObserver the observer to remove. + */ + void removeXMLSinkObserver(in nsIRDFXMLSinkObserver aObserver); +}; + -- cgit v1.2.3