#include <gcp/reaction-arrow.h>

Inheritance diagram for gcp::ReactionArrow:

Public Member Functions
virtual	~ReactionArrow ()
xmlNodePtr	Save (xmlDocPtr xml) const
bool	Load (xmlNodePtr node)
void	AddItem ()
void	UpdateItem ()
bool	BuildContextualMenu (gcu::UIManager 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 ()
char	GetSymbolicPosition (double x, double y)
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) const
bool	GetCoords (double x, double y, double *z=NULL) const
void	Transform2D (gcu::Matrix2D &m, double x, double y)
double	GetYAlign ()
void	SetStartStep (Step *step)
Step **	GetStartStepPtr ()
Step *	GetStartStep () const
void	SetEndStep (Step *step)
Step *	GetEndStep () const
Step **	GetEndStepPtr ()
void	Reverse ()
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)
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)
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)
void	EmitSignal (SignalId Signal)
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 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 ()
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 gcp::Arrow
bool	Save (xmlDocPtr xml, xmlNodePtr node) const
void	OnLoaded ()
Protected Attributes inherited from gcp::Arrow
double	m_x
double	m_y
double	m_width
double	m_height

Detailed Description

Arrow class for arrows used in chemical reactions.

Definition at line 44 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

object the object to attach to the arrow.

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

bool gcp::ReactionArrow::BuildContextualMenu	(	gcu::UIManager *	UIManager,
		gcu::Object *	object,
		double	x,
		double	y
	)

virtual

Parameters

UIManager	the gcu::UIManager 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 arrow.

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

Reimplemented from gcu::Object.

char gcp::ReactionArrow::GetSymbolicPosition	(	double	x,
		double	y
	)

Returns: a character corresponding to where the point lies relative to the arrow. 't' means on tail side, 'h' on head side, and 'o' for other.

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

x	the x component of the transation vector.
y	the y component of the transation vector.
z	the 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

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 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

prop	the attached property to position.

Position an object at the right place near the arrow.

xmlNodePtr gcp::ReactionArrow::Save ( xmlDocPtr xml ) const

virtual

Parameters

xml	the 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.

bool gcp::ReactionArrow::SetProperty	(	unsigned	property,
		char const *	value
	)

virtual

Parameters

property	the property id as defined in objprops.h
value	the 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::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:

reaction-arrow.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation