gcp::ReactionOperator Class Reference

Class for '+' signs in chemical reaction equations. More...

#include <gcp/reaction-operator.h>

Inheritance diagram for gcp::ReactionOperator:

Public Member Functions
	ReactionOperator ()
virtual	~ReactionOperator ()
void	AddItem ()
virtual void	Move (double x, double y, double z=0)
virtual void	SetSelected (int state)
void	SetCoords (double x, double y)
bool	GetCoords (double *x, double *y, double *z=NULL) const
virtual double	GetYAlign ()
std::string	Name ()
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)
Object *	GetMolecule () const
Object *	GetReaction () const
Object *	GetGroup () const
Document *	GetDocument () const
Application *	GetApplication () const
Object *	GetParentOfType (TypeId Id) const
Object *	GetChild (const gchar *Id) const
Object *	GetFirstChild (std::map< std::string, Object * >::iterator &i)
Object *	GetNextChild (std::map< std::string, Object * >::iterator &i)
Object *	GetDescendant (const char *Id) const
Object *	GetParent () const
void	SetParent (Object *Parent)
virtual xmlNodePtr	Save (xmlDocPtr xml) const
virtual bool	Load (xmlNodePtr node)
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 Object *	GetAtomAt (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 ()
Object *	GetFirstLink (std::set< Object * >::iterator &i)
Object *	GetNextLink (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 gccv::ItemClient
	ItemClient ()
virtual	~ItemClient ()
virtual void	UpdateItem ()
Item *	GetItem (void)

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 Object *	CreateObject (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 Dialog *	BuildPropertiesDialog ()
Protected Attributes inherited from gccv::ItemClient
Item *	m_Item

Detailed Description

Class for '+' signs in chemical reaction equations.

Objects of this class are added when useful by the framework. There is no need to create them manually.

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

Constructor & Destructor Documentation

gcp::ReactionOperator::ReactionOperator

(

)

The constructor. Adds a '+' sign in the chemical equation.

virtual gcp::ReactionOperator::~ReactionOperator ( )

virtual

The destructor.

Member Function Documentation

void gcp::ReactionOperator::AddItem ( )

virtual

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

Reimplemented from gccv::ItemClient.

bool gcp::ReactionOperator::GetCoords ( double *  x, double *  y, double *  z = NULL  ) const

virtual

Parameters

x	where to store the x coordinate of the operator.
y	where to store the y coordinate of the operator.
z	where to store the z coordinate of the operator or NULL for 2D representations.

Retrieves the current coordinates of the operator.

Returns

true if successful and false if an error occurs (if x or y is NULL).

Reimplemented from gcu::Object.

virtual double gcp::ReactionOperator::GetYAlign ( )

virtual

Used to retrieve the y coordinate for alignment.

Returns

y coordinate used for reaction operators alignment.

Reimplemented from gcu::Object.

virtual void gcp::ReactionOperator::Move ( double  x, double  y, double  z = 0  )

virtual

Parameters

x	the x component of the transation vector.
y	the y component of the transation vector.
z	the z component of the transation vector (unused).

Moves the reaction operator.

Reimplemented from gcu::Object.

std::string gcp::ReactionOperator::Name ( )

virtual

Returns

the localized object generic name.

Reimplemented from gcu::Object.

void gcp::ReactionOperator::SetCoords	(	double	x,
		double	y
	)

Parameters

x	the new x coordinate of the operator.
y	the new y coordinate of the operator.

Sets the coordinates of the operator. The values are understood horizontally as left side and vertically as base line.

virtual void gcp::ReactionOperator::SetSelected ( int  state )

virtual

Parameters

state,:

the selection state of the operator.

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

Reimplemented from gccv::ItemClient.

---

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

• reaction-operator.h