The Gnome Chemistry Utils  0.13.7
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 ()
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)

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.

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 ( gcu::UIManager UIManager,
gcu::Object object,
double  x,
double  y 
) [virtual]
Parameters:
UIManagerthe gcu::UIManager 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.

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

Parameters:
propthe attached property to position.

Position an object at the right place near the arrow.

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.

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