The Gnome Chemistry Utils  0.12.11
Public Member Functions
gcp::ReactionArrow Class Reference

#include <gcp/reaction-arrow.h>

Inheritance diagram for gcp::ReactionArrow:
gcp::Arrow gcu::Object gccv::ItemClient

List of all members.

Public Member Functions

virtual ~ReactionArrow ()
xmlNodePtr Save (xmlDocPtr xml) const
bool Load (xmlNodePtr node)
void AddItem ()
void UpdateItem ()
void SetStartStep (ReactionStep *Step)
ReactionStepGetStartStep ()
void SetEndStep (ReactionStep *Step)
ReactionStepGetEndStep ()
void RemoveStep (ReactionStep *Step)
bool BuildContextualMenu (GtkUIManager *UIManager, gcu::Object *object, double x, double y)
void Move (double x, double y, double z=0)
void SetSelected (int state)
void AddProp (gcu::Object *object)
void PositionChild (ReactionProp *prop)
bool OnSignal (gcu::SignalId Signal, gcu::Object *Child)
bool SetProperty (unsigned property, char const *value)
std::string Name ()
- Public Member Functions inherited from gcp::Arrow
 Arrow (gcu::TypeId Type)
virtual ~Arrow ()
void SetCoords (double xstart, double ystart, double xend, double yend)
bool GetCoords (double *xstart, double *ystart, double *xend, double *yend)
void Transform2D (gcu::Matrix2D &m, double x, double y)
double GetYAlign ()
- Public Member Functions inherited from gcu::Object
 Object (TypeId Id=OtherType)
virtual ~Object ()
TypeId GetType () const
void SetId (gchar const *Id)
gchar const * GetId () const
virtual void AddChild (Object *object)
ObjectGetMolecule () const
ObjectGetReaction () const
ObjectGetGroup () const
DocumentGetDocument () 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 gchar *Id) const
ObjectGetParent () const
void SetParent (Object *Parent)
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::list< Object * > &Children) throw (std::invalid_argument)
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 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
void ShowPropertiesDialog ()
bool GetDirty (void) const
- Public Member Functions inherited from gccv::ItemClient
 ItemClient ()
virtual ~ItemClient ()
ItemGetItem (void)

Additional Inherited Members

- Protected Member Functions inherited from gcp::Arrow
bool Save (xmlDocPtr xml, xmlNodePtr node) const
- Protected Member Functions inherited from gcu::Object
virtual DialogBuildPropertiesDialog ()
- Protected Attributes inherited from gcp::Arrow
double m_x
double m_y
double m_width
double m_height
- Protected Attributes inherited from gccv::ItemClient
Itemm_Item

Detailed Description

Arrow class for arrows used in chemical reactions.

Definition at line 40 of file reaction-arrow.h.


Constructor & Destructor Documentation

virtual gcp::ReactionArrow::~ReactionArrow ( )
virtual

The destructor.


Member Function Documentation

void gcp::ReactionArrow::AddItem ( )
virtual

Used to add a representation of the arrow in the view.

Reimplemented from gccv::ItemClient.

void gcp::ReactionArrow::AddProp ( gcu::Object object)
Parameters:
objectthe object to attach to the arrow.

Attach an object to the arrow and pops up the reaction property dialog box.

bool gcp::ReactionArrow::BuildContextualMenu ( GtkUIManager *  UIManager,
gcu::Object object,
double  x,
double  y 
)
virtual
Parameters:
UIManagerthe GtkUIManager to populate.
objectthe Object on which occured the mouse click.
xx coordinate of the mouse click.
yy coordinate of the mouse click.

This method is called to build a contextual menu for the arrow.

Returns:
true if something is added to the UIManager, false otherwise.

Reimplemented from gcu::Object.

ReactionStep* gcp::ReactionArrow::GetEndStep ( )
inline
Returns:
the final reaction step.

Definition at line 92 of file reaction-arrow.h.

ReactionStep* gcp::ReactionArrow::GetStartStep ( )
inline
Returns:
the initial reaction step.

Definition at line 82 of file reaction-arrow.h.

bool gcp::ReactionArrow::Load ( xmlNodePtr  node)
virtual
Parameters:
node,:a pointer to the xmlNode containing the serialized arrow.

Used to load an arrow in memory.

Returns:
true on succes, false otherwise.

Reimplemented from gcp::Arrow.

void gcp::ReactionArrow::Move ( double  x,
double  y,
double  z = 0 
)
virtual
Parameters:
xthe x component of the transation vector.
ythe y component of the transation vector.
zthe z component of the transation vector.

Used to move a reaction arrow. It will also move the objects attached to the arrow if any.

Reimplemented from gcp::Arrow.

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

Reimplemented from gcp::Arrow.

bool gcp::ReactionArrow::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 arrow, such as when an attached object size changed. 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.

void gcp::ReactionArrow::PositionChild ( ReactionProp prop)
Parameters:
propthe attached property to position.

Position an object at the right place near the arrow.

void gcp::ReactionArrow::RemoveStep ( ReactionStep Step)
Parameters:
Stepthe reaction step to remove from the reaction

Removes the reaction step, which might be either the initial or final step. If it not one of these, nothing is done.

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

Used to save the arrow to the xmlDoc.

Returns:
the xmlNode containing the serialized arrow.

Reimplemented from gcu::Object.

void gcp::ReactionArrow::SetEndStep ( ReactionStep Step)
inline
Parameters:
Stepthe reaction step after the reaction

Sets the final reaction step.

Definition at line 88 of file reaction-arrow.h.

bool gcp::ReactionArrow::SetProperty ( unsigned  property,
char const *  value 
)
virtual
Parameters:
propertythe property id as defined in objprops.h
valuethe property value as a string

Used when loading to set common properties to arrows. Only one property is currently supported: gcu::GCU_PROP_REACTION_ARROW_TYPE.

Returns:
true if the property could be set, or if the property is not relevant, false otherwise.

Reimplemented from gcp::Arrow.

void gcp::ReactionArrow::SetSelected ( int  state)
virtual
Parameters:
state,:the selection state of the arrow.

Used to set the selection state of the arrow inside the widget. The values of state might be gcp::SelStateUnselected, gcp::SelStateSelected, gcp::SelStateUpdating, or gcp::SelStateErasing. Children will be selected too.

Reimplemented from gcp::Arrow.

void gcp::ReactionArrow::SetStartStep ( ReactionStep Step)
inline
Parameters:
Stepthe reaction step before the reaction

Sets the initial reaction step.

Definition at line 78 of file reaction-arrow.h.

void gcp::ReactionArrow::UpdateItem ( )
virtual

Used to update the representation of the arrow in the view.

Reimplemented from gccv::ItemClient.


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