gcp::Reactant Class Reference

Inheritance diagram for gcp::Reactant:

gcu::Object List of all members.

Public Member Functions

virtual xmlNodePtr Save (xmlDocPtr xml)
virtual bool Load (xmlNodePtr)
unsigned GetStoich ()
void SetStoich (unsigned Stoich)
unsigned GetStoichiometry ()
void SetStoichiometry (unsigned coef)
virtual double GetYAlign ()
virtual bool BuildContextualMenu (GtkUIManager *UIManager, Object *object, double x, double y)
virtual bool OnSignal (SignalId Signal, Object *Child)
ObjectGetChild ()
ObjectGetStoichChild ()

Detailed Description

Definition at line 36 of file reactant.h.


Member Function Documentation

virtual xmlNodePtr gcp::Reactant::Save ( xmlDocPtr  xml  )  [virtual]

Parameters:
xml,: the xmlDoc used to save the document.
Used to save the Object to the xmlDoc. Each serializable Object should implement this virtual method.
Returns:
the xmlNode containing the serialized object. The name of the node should be the name of the corresponding type used as first parameter to the Object::AddType method. The default method just saves the id and children.

Reimplemented from gcu::Object.

virtual bool gcp::Reactant::Load ( xmlNodePtr  node  )  [virtual]

Parameters:
node,: a pointer to the xmlNode containing the serialized object.
Used to load an Object in memory. The Object must already exist.

Example:

        std::string str = (const char*)node->name;
        Object* pObject = Object::CreateObject(str, this);
        if (pObject) {
                if (!pObject->Load(node)) delete Object; 
        } else
                cerr << "Warning: unknown object: " << str << endl;

Returns:
true on succes, false otherwise.

Reimplemented from gcu::Object.

virtual double gcp::Reactant::GetYAlign (  )  [virtual]

Used to retreive the y coordinate for alignment. The default implementation returns 0.0 and every derived class for which alignment has a meaning should implement this method.

Returns:
y coordinate used for objects alignment.

Reimplemented from gcu::Object.

virtual bool gcp::Reactant::BuildContextualMenu ( GtkUIManager *  UIManager,
Object object,
double  x,
double  y 
) [virtual]

Parameters:
UIManager,: the GtkUIanager to populate.
object,: the Object on which occured the mouse click.
x,: x coordinate of the mouse click.
y,: y coordinate of the mouse click.
This method is called to build a contextual menu for the object. It is called by Object::ShowContextualMenu, so it should not be necessary to call it directly. It should be overrided by derived classes when a contextual menu is needed. Typically, each class adds a submenu and calls the same method for its parent. Default implementation calls registered BuildMenuCb callbacks and the parent's method. Derived classes should call Object::BuildContextualMenu before returning.
Returns:
true if something is added to the UIManager, false otherwise.

Reimplemented from gcu::Object.

virtual bool gcp::Reactant::OnSignal ( SignalId  Signal,
Object Child 
) [virtual]

Parameters:
Signal,: the appropriate SignalId
Child,: the child which emitted the signal or NULL
This function is called by the framework when a signal has been emitted for the object. It should not be called by a program; call Object::EmitSignal instead.

Returns:
true if the signal should be propagated to the parent, false otherwise.

Reimplemented from gcu::Object.


The documentation for this class was generated from the following file:
Generated on Thu Jun 28 09:02:03 2007 for The Gnome Chemistry Utils by  doxygen 1.5.2