CellML API
cellml_context::CellMLModule Interface Reference
This interface represents a CellML module. More...
Public Types | |
| enum | ModuleTypes { TOOL, SERVICE } |
Public Member Functions | |
| void | unload () |
| Called to request that a module unload itself and exit. | |
 Public Member Functions inherited from XPCOM::IObject | |
| void | add_ref () |
| Called to indicate that some code is keeping an owning reference to the object. | |
| oneway void | release_ref () |
| Removes a reference to an object which was created by some other means (e.g. | |
| IObject | query_interface (in utf8string id) |
| Returns an IObject of the same implementation, which supports a specific interface. | |
Public Attributes | |
| readonly attribute ModuleTypes | moduleType |
| The type of module. | |
| readonly attribute wstring | moduleName |
| The module name(should be short). | |
| readonly attribute wstring | moduleDescription |
| A brief description of what the module does, in the language the module is currently operating in. | |
| readonly attribute wstring | moduleVersion |
| The version of the module. | |
| readonly attribute wstring | moduleIconURL |
| A URL for an icon for the module(PNG format), or the empty string if no icon is provided. | |
| Public Attributes inherited from XPCOM::IObject | |
| readonly attribute string | objid |
| Fetches the ID of the object. | |
Detailed Description
This interface represents a CellML module.
The module can be a tool (which has a user interface) or a service (which does not have a user interface, but can be called from other UIs). It is provided mainly so other modules can determine what else is running. All modules should provide a class which derives from this class, and register it with the CellMLToolManager. For services, the module can also implement one of the service interfaces in IDL module cellml_services.
Definition at line 20 of file CellML_Context.idl.
Member Enumeration Documentation
Definition at line 22 of file CellML_Context.idl.
Member Function Documentation
| void cellml_context::CellMLModule::unload | ( | ) |
Called to request that a module unload itself and exit.
A tool may still ask the user to confirm, and if the user doesn't confirm, cancel the unload. Modules which decide to unload must still deregister themselves with the module manager.
Member Data Documentation
| readonly attribute wstring cellml_context::CellMLModule::moduleDescription |
A brief description of what the module does, in the language the module is currently operating in.
Definition at line 42 of file CellML_Context.idl.
| readonly attribute wstring cellml_context::CellMLModule::moduleIconURL |
A URL for an icon for the module(PNG format), or the empty string if no icon is provided.
Definition at line 54 of file CellML_Context.idl.
| readonly attribute wstring cellml_context::CellMLModule::moduleName |
The module name(should be short).
Definition at line 36 of file CellML_Context.idl.
| readonly attribute ModuleTypes cellml_context::CellMLModule::moduleType |
The type of module.
Definition at line 31 of file CellML_Context.idl.
| readonly attribute wstring cellml_context::CellMLModule::moduleVersion |
The version of the module.
Module developers are free to format this however they like...
Definition at line 48 of file CellML_Context.idl.