AnnoTools.idl

Go to the documentation of this file.

#include "xpcom.idl"
#ifndef IN_CELLML_MODULE
#define USERDATA_NEEDED
#endif
#include "CellML_APISPEC.idl"

module cellml_services
{
  interface StringAnnotation
    : cellml_api::UserData
  {
    attribute wstring value;
  };
#pragma terminal-interface

  interface ObjectAnnotation
    : cellml_api::UserData
  {
    attribute XPCOM::IObject value;
  };
#pragma terminal-interface

  interface AnnotationSet
    : XPCOM::IObject
  {
    readonly attribute wstring prefixURI;

    void setStringAnnotation(in cellml_api::CellMLElement element,
                             in wstring key,
                             in wstring value);

    wstring getStringAnnotation(in cellml_api::CellMLElement element,
                                in wstring key);

    wstring getStringAnnotationWithDefault(in cellml_api::CellMLElement element,
                                           in wstring key, in wstring defval);


    void setObjectAnnotation(in cellml_api::CellMLElement element,
                             in wstring key,
                             in XPCOM::IObject value);

    XPCOM::IObject getObjectAnnotation(in cellml_api::CellMLElement element,
                                       in wstring key);

    XPCOM::IObject getObjectAnnotationWithDefault
    (in cellml_api::CellMLElement element, in wstring key,
     in XPCOM::IObject defval);
  };

  interface AnnotationToolService
    : XPCOM::IObject
  {
    AnnotationSet createAnnotationSet();
  };
};