summaryrefslogtreecommitdiffstats
path: root/rdf/base/rdfITripleVisitor.idl
diff options
context:
space:
mode:
Diffstat (limited to 'rdf/base/rdfITripleVisitor.idl')
-rw-r--r--rdf/base/rdfITripleVisitor.idl31
1 files changed, 31 insertions, 0 deletions
diff --git a/rdf/base/rdfITripleVisitor.idl b/rdf/base/rdfITripleVisitor.idl
new file mode 100644
index 000000000..ecac14871
--- /dev/null
+++ b/rdf/base/rdfITripleVisitor.idl
@@ -0,0 +1,31 @@
+/* -*- Mode: IDL; 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/. */
+
+#include "nsISupports.idl"
+
+interface nsIRDFResource;
+interface nsIRDFNode;
+
+/**
+ * Interface used in RDF to enumerate triples.
+ * Also used by rdfIDataSource::getAllSubjects, then aPredicate,
+ * aObject and aTruthValue are ignored.
+ *
+ * @status PLASMA
+ */
+
+[scriptable, function, uuid(aafea151-c271-4505-9978-a100d292800c)]
+interface rdfITripleVisitor : nsISupports
+{
+ /**
+ * Callback function for returning query results.
+ *
+ * @param aSubject, aPredicate, aObject describe the (sub-)arc
+ * @returnCode NS_RDF_STOP_VISIT to stop iterating over the query result.
+ * Any error code will stop the iteration as well.
+ */
+ void visit(in nsIRDFNode aSubject, in nsIRDFResource aPredicate,
+ in nsIRDFNode aObject, in boolean aTruthValue);
+};