The Gnome Chemistry Utils  0.13.90
Public Member Functions
gcp::MesomeryArrow Class Reference

#include <gcp/mesomery-arrow.h>

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

List of all members.

Public Member Functions

 MesomeryArrow (Mesomery *mesomery)
virtual ~MesomeryArrow ()
xmlNodePtr Save (xmlDocPtr xml) const
bool Load (xmlNodePtr node)
void AddItem ()
void UpdateItem ()
void SetStartMesomer (Mesomer *mesomer)
MesomerGetStartMesomer ()
void SetEndMesomer (Mesomer *mesomer)
MesomerGetEndMesomer ()
void Reverse ()
std::string Name ()
- Public Member Functions inherited from gcp::Arrow
 Arrow (gcu::TypeId Type)
virtual ~Arrow ()
void SetSelected (int state)
void SetCoords (double xstart, double ystart, double xend, double yend)
bool GetCoords (double *xstart, double *ystart, double *xend, double *yend) const
bool GetCoords (double *x, double *y, double *z=NULL) const
void Move (double x, double y, double z=0)
void Transform2D (gcu::Matrix2D &m, double x, double y)
double GetYAlign ()
bool SetProperty (unsigned property, char const *value)
void SetStartStep (Step *step)
Step ** GetStartStepPtr ()
StepGetStartStep () const
void SetEndStep (Step *step)
StepGetEndStep () const
Step ** GetEndStepPtr ()
void RemoveStep (Step *step)
double GetLength (void) const
- 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)
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 bool BuildContextualMenu (UIManager *uim, Object *object, double x, double y)
void EmitSignal (SignalId Signal)
virtual bool OnSignal (SignalId Signal, Object *Child)
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
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 gccv::ItemClient
 ItemClient ()
virtual ~ItemClient ()
ItemGetItem (void)

Additional Inherited Members

- Protected Member Functions inherited from gcp::Arrow
bool Save (xmlDocPtr xml, xmlNodePtr node) const
void OnLoaded ()
- 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 double headed arrows used in mesomery relationships.

Definition at line 38 of file mesomery-arrow.h.


Constructor & Destructor Documentation

gcp::MesomeryArrow::MesomeryArrow ( Mesomery mesomery)
Parameters:
mesomerythe parent mesomery relationship if any.

Constructs a mesomery arrow. If mesomery is not NULL, the arrow becomes is added to its children list.

virtual gcp::MesomeryArrow::~MesomeryArrow ( )
virtual

The destructor.


Member Function Documentation

void gcp::MesomeryArrow::AddItem ( )
virtual

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

Reimplemented from gccv::ItemClient.

Mesomer* gcp::MesomeryArrow::GetEndMesomer ( )
inline
Returns:
the mesomer at last end of the arrow.

Definition at line 96 of file mesomery-arrow.h.

Mesomer* gcp::MesomeryArrow::GetStartMesomer ( )
inline
Returns:
the mesomer at first end of the arrow.

Definition at line 85 of file mesomery-arrow.h.

bool gcp::MesomeryArrow::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.

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

Reimplemented from gcp::Arrow.

void gcp::MesomeryArrow::Reverse ( )

Exchange both ends or the arrow and their associated mesomers.

Reimplemented from gcp::Arrow.

xmlNodePtr gcp::MesomeryArrow::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::MesomeryArrow::SetEndMesomer ( Mesomer mesomer)
inline
Parameters:
mesomera mesomer

Sets mesomer at last end of the arrow. This does not affect coordinates, alignment is dealt with elsewhere.

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

void gcp::MesomeryArrow::SetStartMesomer ( Mesomer mesomer)
inline
Parameters:
mesomera mesomer

Sets mesomer at first end of the arrow. This does not affect coordinates, alignment is dealt with elsewhere.

Definition at line 81 of file mesomery-arrow.h.

void gcp::MesomeryArrow::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: