Back to index

lightning-sunbird  0.9+nobinonly
nsIRDFXMLSink.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 /*
00039 
00040   Interfaces for the RDF/XML sink, which parses RDF/XML into
00041   a graph representation.
00042 
00043 */
00044 
00045 #include "nsISupports.idl"
00046 
00047 // XXX Until these get scriptable. See nsIRDFXMLSink::AddNameSpace()
00048 [ptr] native nsIAtomPtr(nsIAtom);
00049 [ref] native nsStringRef(nsString);
00050 %{C++
00051 class nsIAtom;
00052 class nsString;
00053 %}
00054 
00055 interface nsIRDFXMLSink;
00056 
00061 [scriptable, uuid(EB1A5D30-AB33-11D2-8EC6-00805F29F370)]
00062 interface nsIRDFXMLSinkObserver : nsISupports
00063 {
00068     void onBeginLoad(in nsIRDFXMLSink aSink);
00069 
00074     void onInterrupt(in nsIRDFXMLSink aSink);
00075 
00080     void onResume(in nsIRDFXMLSink aSink);
00081 
00086     void onEndLoad(in nsIRDFXMLSink aSink);
00087 
00094     void onError(in nsIRDFXMLSink aSink, in nsresult aStatus, in wstring aErrorMsg);
00095 };
00096 
00097 
00098 
00103 [scriptable, uuid(EB1A5D31-AB33-11D2-8EC6-00805F29F370)]
00104 interface nsIRDFXMLSink : nsISupports
00105 {
00110     attribute boolean readOnly;
00111 
00115     void beginLoad();
00116 
00120     void interrupt();
00121 
00125     void resume();
00126 
00130     void endLoad();
00131 
00137     [noscript] void addNameSpace(in nsIAtomPtr aPrefix,
00138                                  [const] in nsStringRef aURI);
00139 
00154     void addXMLSinkObserver(in nsIRDFXMLSinkObserver aObserver);
00155 
00160     void removeXMLSinkObserver(in nsIRDFXMLSinkObserver aObserver);
00161 };
00162