gecko-dev/rdf/base/idl/nsIRDFObserver.idl

114 строки
4.2 KiB
Plaintext

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* The contents of this file are subject to the Netscape 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/NPL/
*
* 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 Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
*/
#include "nsISupports.idl"
#include "nsIRDFResource.idl"
#include "nsIRDFNode.idl"
interface nsIRDFDataSource;
// An nsIRDFObserver object is an observer that will be notified
// when assertions are made or removed from a datasource
[scriptable, uuid(3CC75360-484A-11D2-BC16-00805F912FE7)]
interface nsIRDFObserver : nsISupports {
/**
* This method is called whenever a new assertion is made
* in the data source
* @param aDataSource the datasource that is issuing
* the notification.
* @param aSource the subject of the assertion
* @param aProperty the predicate of the assertion
* @param aTarget the object of the assertion
*/
void onAssert(in nsIRDFDataSource aDataSource,
in nsIRDFResource aSource,
in nsIRDFResource aProperty,
in nsIRDFNode aTarget);
/**
* This method is called whenever an assertion is removed
* from the data source
* @param aDataSource the datasource that is issuing
* the notification.
* @param aSource the subject of the assertion
* @param aProperty the predicate of the assertion
* @param aTarget the object of the assertion
*/
void onUnassert(in nsIRDFDataSource aDataSource,
in nsIRDFResource aSource,
in nsIRDFResource aProperty,
in nsIRDFNode aTarget);
/**
* This method is called when the object of an assertion
* changes from one value to another.
* @param aDataSource the datasource that is issuing
* the notification.
* @param aSource the subject of the assertion
* @param aProperty the predicate of the assertion
* @param aOldTarget the old object of the assertion
* @param aNewTarget the new object of the assertion
*/
void onChange(in nsIRDFDataSource aDataSource,
in nsIRDFResource aSource,
in nsIRDFResource aProperty,
in nsIRDFNode aOldTarget,
in nsIRDFNode aNewTarget);
/**
* This method is called when the subject of an assertion
* changes from one value to another.
* @param aDataSource the datasource that is issuing
* the notification.
* @param aOldSource the old subject of the assertion
* @param aNewSource the new subject of the assertion
* @param aProperty the predicate of the assertion
* @param aTarget the object of the assertion
*/
void onMove(in nsIRDFDataSource aDataSource,
in nsIRDFResource aOldSource,
in nsIRDFResource aNewSource,
in nsIRDFResource aProperty,
in nsIRDFNode aTarget);
/**
* This method is called when a datasource is about to
* send several notifications at once. The observer can
* use this as a cue to optimize its behavior. The observer
* can expect the datasource to call endUpdateBatch() when
* the group of notifications has completed.
* @param aDataSource the datasource that is going to
* be issuing the notifications.
*/
void beginUpdateBatch(in nsIRDFDataSource aDataSource);
/**
* This method is called when a datasource has completed
* issuing a notification group.
* @param aDataSource the datasource that has finished
* issuing a group of notifications
*/
void endUpdateBatch(in nsIRDFDataSource aDataSource);
};