mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-05 08:35:26 +00:00
127 lines
4.4 KiB
Plaintext
127 lines
4.4 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* ***** 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
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either of 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"
|
|
#include "nsIRDFDataSource.idl"
|
|
#include "nsIRDFResource.idl"
|
|
#include "nsIRDFNode.idl"
|
|
#include "nsISimpleEnumerator.idl"
|
|
|
|
// A wrapper for manipulating RDF containers
|
|
[scriptable, uuid(D4214E90-FB94-11D2-BDD8-00104BDE6048)]
|
|
interface nsIRDFContainer : nsISupports {
|
|
readonly attribute nsIRDFDataSource DataSource;
|
|
readonly attribute nsIRDFResource Resource;
|
|
|
|
/**
|
|
* Initialize the container wrapper to the specified resource
|
|
* using the specified datasource for context.
|
|
*/
|
|
void Init(in nsIRDFDataSource aDataSource, in nsIRDFResource aContainer);
|
|
|
|
/**
|
|
* Return the number of elements in the container. Note that this
|
|
* may not always be accurate due to aggregation.
|
|
*/
|
|
long GetCount();
|
|
|
|
/**
|
|
* Return an enumerator that can be used to enumerate the contents
|
|
* of the container in ascending order.
|
|
*/
|
|
nsISimpleEnumerator GetElements();
|
|
|
|
/**
|
|
* Append an element to the container, assigning it the next
|
|
* available ordinal.
|
|
*/
|
|
void AppendElement(in nsIRDFNode aElement);
|
|
|
|
/**
|
|
* Remove the first occurence of the specified element from the
|
|
* container. If aRenumber is 'true', then the underlying RDF graph
|
|
* will be 're-numbered' to account for the removal.
|
|
*/
|
|
void RemoveElement(in nsIRDFNode aElement, in boolean aRenumber);
|
|
|
|
/**
|
|
* Insert aElement at the specified index. If aRenumber is 'true', then
|
|
* the underlying RDF graph will be 're-numbered' to accomodate the new
|
|
* element.
|
|
*/
|
|
void InsertElementAt(in nsIRDFNode aElement, in long aIndex, in boolean aRenumber);
|
|
|
|
/**
|
|
* Remove the element at the specified index. If aRenumber is 'true', then
|
|
* the underlying RDF graph will be 're-numbered' to account for the
|
|
* removal.
|
|
*
|
|
* @return the element that was removed.
|
|
*/
|
|
nsIRDFNode RemoveElementAt(in long aIndex, in boolean aRenumber);
|
|
|
|
/**
|
|
* Determine the index of an element in the container.
|
|
*
|
|
* @return The index of the specified element in the container. If
|
|
* the element is not contained in the container, this function
|
|
* returns '-1'.
|
|
*/
|
|
long IndexOf(in nsIRDFNode aElement);
|
|
};
|
|
|
|
%{C++
|
|
nsresult
|
|
NS_NewRDFContainer(nsIRDFContainer** aResult);
|
|
|
|
nsresult
|
|
NS_NewRDFContainer(nsIRDFDataSource* aDataSource,
|
|
nsIRDFResource* aResource,
|
|
nsIRDFContainer** aResult);
|
|
|
|
/**
|
|
* Create a cursor on a container that enumerates its contents in
|
|
* order
|
|
*/
|
|
nsresult
|
|
NS_NewContainerEnumerator(nsIRDFDataSource* aDataSource,
|
|
nsIRDFResource* aContainer,
|
|
nsISimpleEnumerator** aResult);
|
|
|
|
|
|
%}
|