The Gnome Chemistry Utils  0.14.0
Public Member Functions | List of all members
gcp::ReactionProp Class Reference

#include <gcp/reaction-prop.h>

Inheritance diagram for gcp::ReactionProp:
gcu::Object gcu::DialogOwner

Public Member Functions

 ReactionProp ()
 ReactionProp (ReactionArrow *parent, gcu::Object *child)
 ~ReactionProp ()
xmlNodePtr Save (xmlDocPtr xml)
bool Load (xmlNodePtr node)
bool OnSignal (gcu::SignalId Signal, gcu::Object *Child)
std::string Name ()
gcu::ObjectGetObject (void) const
void SetRole (unsigned val)
unsigned GetRole (void) const
unsigned & GetRefRole (void)
- Public Member Functions inherited from gcu::Object
 Object (TypeId Id=OtherType)
virtual ~Object ()
TypeId GetType () const
void SetId (gchar const *Id)
char const * GetId () const
virtual void AddChild (Object *object)
ObjectGetMolecule () const
ObjectGetReaction () const
ObjectGetGroup () const
DocumentGetDocument () const
ApplicationGetApplication () const
ObjectGetParentOfType (TypeId Id) const
ObjectGetChild (const gchar *Id) const
ObjectGetFirstChild (std::map< std::string, Object * >::iterator &i)
ObjectGetNextChild (std::map< std::string, Object * >::iterator &i)
ObjectGetDescendant (const char *Id) const
ObjectGetParent () const
void SetParent (Object *Parent)
virtual xmlNodePtr Save (xmlDocPtr xml) const
virtual bool GetCoords (double *x, double *y, double *z=NULL) const
virtual void Move (double x, double y, double z=0.)
virtual void Transform2D (Matrix2D &m, double x, double y)
bool SaveChildren (xmlDocPtr xml, xmlNodePtr node) const
void SaveId (xmlNodePtr node) const
xmlNodePtr GetNodeByProp (xmlNodePtr node, char const *Property, char const *Id)
xmlNodePtr GetNextNodeByProp (xmlNodePtr node, char const *Property, char const *Id)
xmlNodePtr GetNodeByName (xmlNodePtr node, char const *Name)
xmlNodePtr GetNextNodeByName (xmlNodePtr node, char const *Name)
bool HasChildren () const
unsigned GetChildrenNumber () const
virtual ObjectGetAtomAt (double x, double y, double z=0.)
virtual bool Build (std::set< Object * > const &Children) throw (std::invalid_argument)
virtual double GetYAlign ()
virtual bool BuildContextualMenu (UIManager *uim, Object *object, double x, double y)
void EmitSignal (SignalId Signal)
void Lock (bool state=true)
bool IsLocked ()
ObjectGetFirstLink (std::set< Object * >::iterator &i)
ObjectGetNextLink (std::set< Object * >::iterator &i)
void Link (Object *object)
void Unlink (Object *object)
virtual void OnUnlink (Object *object)
void GetPossibleAncestorTypes (std::set< TypeId > &types) const
virtual bool SetProperty (unsigned property, char const *value)
virtual std::string GetProperty (unsigned property) const
virtual void OnLoaded ()
void SetDirty (bool dirty=true)
virtual void Clear ()
std::string Identity ()
virtual char const * HasPropertiesDialog () const
virtual bool CanSelect () const
virtual void NotifyEmpty ()
void ShowPropertiesDialog ()
bool GetDirty (void) const
- Public Member Functions inherited from gcu::DialogOwner
 DialogOwner ()
virtual ~DialogOwner ()
DialogGetDialog (std::string name) const
void ClearDialogs ()

Additional Inherited Members

- Static Public Member Functions inherited from gcu::Object
static TypeId AddType (std::string TypeName, Object *(*CreateFunc)(), TypeId id=OtherType)
static void AddAlias (TypeId id, std::string TypeName)
static ObjectCreateObject (const std::string &TypeName, Object *parent=NULL)
static TypeId GetTypeId (const std::string &Name)
static std::string GetTypeName (TypeId Id)
static void AddMenuCallback (TypeId Id, BuildMenuCb cb)
static void AddRule (TypeId type1, RuleId rule, TypeId type2)
static void AddRule (const std::string &type1, RuleId rule, const std::string &type2)
static const std::set< TypeId > & GetRules (TypeId type, RuleId rule)
static const std::set< TypeId > & GetRules (const std::string &type, RuleId rule)
static void SetCreationLabel (TypeId Id, std::string Label)
static const std::string & GetCreationLabel (TypeId Id)
static const std::string & GetCreationLabel (const std::string &TypeName)
static SignalId CreateNewSignalId ()
- Protected Member Functions inherited from gcu::Object
virtual DialogBuildPropertiesDialog ()

Detailed Description

This is a container class for objects attached to a reaction arrow.

Definition at line 98 of file reaction-prop.h.

Constructor & Destructor Documentation

gcp::ReactionProp::ReactionProp ( )

The default constructor.

gcp::ReactionProp::ReactionProp ( ReactionArrow parent,
gcu::Object child 
)
Parameters
parentthe parent reaction arrow.
childthe molecule or text to attach to the arrow.

Builds a new reactionproperty, and attach the child to the arrow.

gcp::ReactionProp::~ReactionProp ( )

The destructor.

Member Function Documentation

gcp::ReactionProp::GetObject ( void  ) const
inline
Returns
the embedded object.

Definition at line 152 of file reaction-prop.h.

gcp::ReactionProp::GetRefRole ( void  )
inline
Returns
the property role as a reference.

Definition at line 164 of file reaction-prop.h.

gcp::ReactionProp::GetRole ( void  ) const
inline
Returns
the property role.

Definition at line 164 of file reaction-prop.h.

bool gcp::ReactionProp::Load ( xmlNodePtr  node)
virtual
Parameters
node,:a pointer to the xmlNode containing the serialized reaction property.

Used to load a reaction property in memory.

Returns
true on succes, false otherwise.

Reimplemented from gcu::Object.

std::string gcp::ReactionProp::Name ( )
virtual
Returns
the localized object generic name.

Reimplemented from gcu::Object.

bool gcp::ReactionProp::OnSignal ( gcu::SignalId  Signal,
gcu::Object Child 
)
virtual
Parameters
Signalthe appropriate SignalId
Childthe child which emitted the signal or NULL

This function is called by the framework when a signal has been emitted for the reaction property, when one its emedded object changed. It should not be called by a program; call Object::EmitSignal instead.

Returns
true to be propagate the signal to the parent.

Reimplemented from gcu::Object.

xmlNodePtr gcp::ReactionProp::Save ( xmlDocPtr  xml)
Parameters
xmlthe xmlDoc used to save the document.

Used to save the reaction property to the xmlDoc.

Returns
the xmlNode containing the serialized reaction property.
gcp::ReactionProp::SetRole ( unsigned  Role)
inline
Parameters
Rolethe new role for the property.

Sets the role for the property which should be less than REACTION_PROP_MAX.

Definition at line 164 of file reaction-prop.h.


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