MathML_content_APISPEC.idl

Go to the documentation of this file.

// This file has been modified to only support content MathML, and to make
// MathMLContainer derive from XPCOM::IObject

// File: mathml-dom.idl
#ifndef _MATHMLDOM_IDL_
#define _MATHMLDOM_IDL_

#include "xpcom.idl"
#include "DOM_APISPEC.idl"

module mathml_dom
{
  interface MathMLDocument;
  interface MathMLMathElement;
  interface MathMLBvarElement;
  interface MathMLConditionElement;
  interface MathMLDeclareElement;
  interface MathMLMatrixrowElement;
  interface MathMLCaseElement;
  
  interface MathMLDOMImplementation : dom::DOMImplementation
  {
    MathMLDocument            createMathMLDocument();
  };
#pragma terminal-interface
  
  interface MathMLDocument : dom::Document
  {
    readonly attribute dom::DOMString         referrer;
    readonly attribute dom::DOMString         domain;
    readonly attribute dom::DOMString         URI;
  };
#pragma terminal-interface

  interface MathMLNodeList : dom::NodeList
  {
  };
#pragma terminal-interface

  interface MathMLElement : dom::Element
  {
             attribute dom::DOMString         className;
             attribute dom::DOMString         mathElementStyle;
             attribute dom::DOMString         id;
             attribute dom::DOMString         xref;
             attribute dom::DOMString         href;
    readonly attribute MathMLMathElement ownerMathElement;
  };
  
  interface MathMLContainer : XPCOM::IObject
  {
    readonly attribute unsigned long     nArguments;
    readonly attribute MathMLNodeList    arguments;
    readonly attribute MathMLNodeList    declarations;
    MathMLElement             getArgument(in unsigned long index)
                                               raises(dom::DOMException);
    MathMLElement             setArgument(in MathMLElement newArgument,
                                          in unsigned long index)
                                               raises(dom::DOMException);
    MathMLElement             insertArgument(in MathMLElement newArgument,
                                             in unsigned long index)
                                               raises(dom::DOMException);
    void                      deleteArgument(in unsigned long index)
                                               raises(dom::DOMException);
    MathMLElement             removeArgument(in unsigned long index)
                                               raises(dom::DOMException);
    MathMLDeclareElement      getDeclaration(in unsigned long index)
                                               raises(dom::DOMException);
    MathMLDeclareElement      setDeclaration(in MathMLDeclareElement newDeclaration,
                                             in unsigned long index)
                                               raises(dom::DOMException);
    MathMLDeclareElement      insertDeclaration(in MathMLDeclareElement newDeclaration,
                                                in unsigned long index)
                                               raises(dom::DOMException);
    MathMLDeclareElement      removeDeclaration(in unsigned long index)
                                               raises(dom::DOMException);
    void                      deleteDeclaration(in unsigned long index)
                                               raises(dom::DOMException);
  };
  
  interface MathMLMathElement : MathMLElement, MathMLContainer
  {
             attribute dom::DOMString         macros;
             attribute dom::DOMString         display;
  };
#pragma terminal-interface

  interface MathMLContentElement : MathMLElement
  {
  };

  interface MathMLContentToken : MathMLContentElement
  {
    readonly attribute MathMLNodeList    arguments;
             attribute dom::DOMString         definitionURL;
             attribute dom::DOMString         encoding;
    dom::Node                      getArgument(in unsigned long index);
    dom::Node                      insertArgument(in dom::Node newArgument,
                                             in unsigned long index);
    dom::Node                      setArgument(in dom::Node newArgument,
                                          in unsigned long index);
    void                      deleteArgument(in unsigned long index);
    dom::Node                      removeArgument(in unsigned long index);
  };
  
  interface MathMLCnElement : MathMLContentToken
  {
             attribute dom::DOMString         type;
             attribute dom::DOMString         base;
    readonly attribute unsigned long     nargs;
  };
#pragma terminal-interface
  
  interface MathMLCiElement : MathMLContentToken
  {
             attribute dom::DOMString         type;
  };
#pragma terminal-interface
  
  interface MathMLCsymbolElement : MathMLContentToken
  {
  };
#pragma terminal-interface
  
  interface MathMLContentContainer : MathMLContentElement, MathMLContainer
  {
    readonly attribute unsigned long     nBoundVariables;
             attribute MathMLConditionElement condition;
                                               // raises(dom::DOMException) on setting
             attribute MathMLElement     opDegree;
                                               // raises(dom::DOMException) on setting
             attribute MathMLElement     domainOfApplication;
                                               // raises(dom::DOMException) on setting
             attribute MathMLElement     momentAbout;
                                               // raises(dom::DOMException) on setting
    MathMLBvarElement         getBoundVariable(in unsigned long index);
    MathMLBvarElement         insertBoundVariable(in MathMLBvarElement newBVar,
                                                  in unsigned long index)
                                               raises(dom::DOMException);
    MathMLBvarElement         setBoundVariable(in MathMLBvarElement newBVar,
                                               in unsigned long index)
                                               raises(dom::DOMException);
    void                      deleteBoundVariable(in unsigned long index);
    MathMLBvarElement         removeBoundVariable(in unsigned long index);
  };
  
  interface MathMLApplyElement : MathMLContentContainer
  {
             attribute MathMLElement     operator;
             attribute MathMLElement     lowLimit;
                                               // raises(dom::DOMException) on setting
             attribute MathMLElement     upLimit;
                                               // raises(dom::DOMException) on setting
  };
#pragma terminal-interface
  
  interface MathMLFnElement : MathMLContentContainer
  {
             attribute dom::DOMString         definitionURL;
             attribute dom::DOMString         encoding;
  };
#pragma terminal-interface
  
  interface MathMLLambdaElement : MathMLContentContainer
  {
             attribute MathMLElement     expression;
  };
#pragma terminal-interface
  
  interface MathMLSetElement : MathMLContentContainer
  {
    readonly attribute boolean           isExplicit;
             attribute dom::DOMString         type;
  };
#pragma terminal-interface
  
  interface MathMLListElement : MathMLContentContainer
  {
    readonly attribute boolean           isExplicit;
             attribute dom::DOMString         ordering;
  };
#pragma terminal-interface
  
  interface MathMLBvarElement : MathMLContentContainer
  {
  };
#pragma terminal-interface
  
  interface MathMLPredefinedSymbol : MathMLContentElement
  {
             attribute dom::DOMString         definitionURL;
             attribute dom::DOMString         encoding;
    readonly attribute dom::DOMString         arity;
    readonly attribute dom::DOMString         symbolName;
  };
  
  interface MathMLTendsToElement : MathMLPredefinedSymbol
  {
             attribute dom::DOMString         type;
  };
#pragma terminal-interface
  
  interface MathMLIntervalElement : MathMLContentElement
  {
             attribute dom::DOMString         closure;
             attribute MathMLContentElement start;
             attribute MathMLContentElement end;
  };
#pragma terminal-interface
  
  interface MathMLConditionElement : MathMLContentElement
  {
             attribute MathMLApplyElement condition;
  };
#pragma terminal-interface
  
  interface MathMLDeclareElement : MathMLContentElement
  {
             attribute dom::DOMString         type;
             attribute unsigned long     nargs;
             attribute dom::DOMString         occurrence;
             attribute dom::DOMString         definitionURL;
             attribute dom::DOMString         encoding;
             attribute MathMLCiElement   identifier;
             attribute MathMLElement     constructor;
  };
#pragma terminal-interface
  
  interface MathMLVectorElement : MathMLContentElement
  {
    readonly attribute unsigned long     ncomponents;
    MathMLContentElement      getComponent(in unsigned long index);
    MathMLContentElement      insertComponent(in MathMLContentElement newComponent,
                                              in unsigned long index)
                                               raises(dom::DOMException);
    MathMLContentElement      setComponent(in MathMLContentElement newComponent,
                                           in unsigned long index)
                                               raises(dom::DOMException);
    void                      deleteComponent(in unsigned long index)
                                               raises(dom::DOMException);
    MathMLContentElement      removeComponent(in unsigned long index);
  };
#pragma terminal-interface
  
  interface MathMLMatrixElement : MathMLContentElement
  {
    readonly attribute unsigned long     nrows;
    readonly attribute unsigned long     ncols;
    readonly attribute MathMLNodeList    rows;
    MathMLMatrixrowElement    getRow(in unsigned long index)
                                               raises(dom::DOMException);
    MathMLMatrixrowElement    insertRow(in MathMLMatrixrowElement newRow,
                                        in unsigned long index)
                                               raises(dom::DOMException);
    MathMLMatrixrowElement    setRow(in MathMLMatrixrowElement newRow,
                                     in unsigned long index)
                                               raises(dom::DOMException);
    void                      deleteRow(in unsigned long index)
                                               raises(dom::DOMException);
    MathMLMatrixrowElement    removeRow(in unsigned long index)
                                               raises(dom::DOMException);
  };
#pragma terminal-interface
  
  interface MathMLMatrixrowElement : MathMLContentElement
  {
    readonly attribute unsigned long     nEntries;
    MathMLContentElement      getEntry(in unsigned long index)
                                               raises(dom::DOMException);
    MathMLContentElement      insertEntry(in MathMLContentElement newEntry,
                                          in unsigned long index)
                                               raises(dom::DOMException);
    MathMLContentElement      setEntry(in MathMLContentElement newEntry,
                                       in unsigned long index)
                                               raises(dom::DOMException);
    void                      deleteEntry(in unsigned long index)
                                               raises(dom::DOMException);
    MathMLContentElement      removeEntry(in unsigned long index)
                                               raises(dom::DOMException);
  };
#pragma terminal-interface
  
  interface MathMLPiecewiseElement : MathMLContentElement
  {
    readonly attribute MathMLNodeList    pieces;
             attribute MathMLContentElement otherwise;
    MathMLCaseElement         getCase(in unsigned long index);
    MathMLCaseElement         setCase(in unsigned long index,
                                      in MathMLCaseElement caseEl)
                                               raises(dom::DOMException);
    void                      deleteCase(in unsigned long index)
                                               raises(dom::DOMException);
    MathMLCaseElement         removeCase(in unsigned long index)
                                               raises(dom::DOMException);
    MathMLCaseElement         insertCase(in unsigned long index,
                                         in MathMLCaseElement newCase)
                                               raises(dom::DOMException);
    MathMLContentElement      getCaseValue(in unsigned long index)
                                               raises(dom::DOMException);
    MathMLContentElement      setCaseValue(in unsigned long index,
                                           in MathMLContentElement value)
                                               raises(dom::DOMException);
    MathMLContentElement      getCaseCondition(in unsigned long index)
                                               raises(dom::DOMException);
    MathMLContentElement      setCaseCondition(in unsigned long index,
                                               in MathMLContentElement condition)
                                               raises(dom::DOMException);
  };
#pragma terminal-interface
  
  interface MathMLCaseElement : MathMLContentElement
  {
             attribute MathMLContentElement caseCondition;
             attribute MathMLContentElement caseValue;
  };
#pragma terminal-interface
};

#endif