Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIRDFContainer Interface Reference

import "nsIRDFContainer.idl";

Inheritance diagram for nsIRDFContainer:
Inheritance graph
[legend]
Collaboration diagram for nsIRDFContainer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void Init (in nsIRDFDataSource aDataSource, in nsIRDFResource aContainer)
 Initialize the container wrapper to the specified resource using the specified datasource for context.
long GetCount ()
 Return the number of elements in the container.
nsISimpleEnumerator GetElements ()
 Return an enumerator that can be used to enumerate the contents of the container in ascending order.
void AppendElement (in nsIRDFNode aElement)
 Append an element to the container, assigning it the next available ordinal.
void RemoveElement (in nsIRDFNode aElement, in boolean aRenumber)
 Remove the first occurence of the specified element from the container.
void InsertElementAt (in nsIRDFNode aElement, in long aIndex, in boolean aRenumber)
 Insert aElement at the specified index.
nsIRDFNode RemoveElementAt (in long aIndex, in boolean aRenumber)
 Remove the element at the specified index.
long IndexOf (in nsIRDFNode aElement)
 Determine the index of an element in the container.

Public Attributes

readonly attribute nsIRDFDataSource DataSource
readonly attribute nsIRDFResource Resource

Detailed Description

Definition at line 46 of file nsIRDFContainer.idl.


Member Function Documentation

Append an element to the container, assigning it the next available ordinal.

Here is the caller graph for this function:

Return the number of elements in the container.

Note that this may not always be accurate due to aggregation.

Here is the caller graph for this function:

Return an enumerator that can be used to enumerate the contents of the container in ascending order.

Determine the index of an element in the container.

Returns:
The index of the specified element in the container. If the element is not contained in the container, this function returns '-1'.
void nsIRDFContainer::Init ( in nsIRDFDataSource  aDataSource,
in nsIRDFResource  aContainer 
)

Initialize the container wrapper to the specified resource using the specified datasource for context.

void nsIRDFContainer::InsertElementAt ( in nsIRDFNode  aElement,
in long  aIndex,
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.

Here is the caller graph for this function:

void nsIRDFContainer::RemoveElement ( in nsIRDFNode  aElement,
in boolean  aRenumber 
)

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.

Here is the caller graph for this function:

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.

Returns:
the element that was removed.

Member Data Documentation

Definition at line 47 of file nsIRDFContainer.idl.

Definition at line 48 of file nsIRDFContainer.idl.


The documentation for this interface was generated from the following file: