The Gnome Chemistry Utils 0.13.3
|
#include <gcp/reaction-arrow.h>
Public Member Functions | |
virtual | ~ReactionArrow () |
xmlNodePtr | Save (xmlDocPtr xml) const |
bool | Load (xmlNodePtr node) |
void | AddItem () |
void | UpdateItem () |
void | SetStartStep (ReactionStep *Step) |
ReactionStep * | GetStartStep () |
void | SetEndStep (ReactionStep *Step) |
ReactionStep * | GetEndStep () |
void | RemoveStep (ReactionStep *Step) |
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) |
void | OnLoaded () |
std::string | Name () |
Arrow class for arrows used in chemical reactions.
Definition at line 44 of file reaction-arrow.h.
virtual gcp::ReactionArrow::~ReactionArrow | ( | ) | [virtual] |
The destructor.
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 | ) |
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] |
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.
Reimplemented from gcu::Object.
ReactionStep* gcp::ReactionArrow::GetEndStep | ( | ) | [inline] |
Definition at line 96 of file reaction-arrow.h.
ReactionStep* gcp::ReactionArrow::GetStartStep | ( | ) | [inline] |
Definition at line 86 of file reaction-arrow.h.
bool gcp::ReactionArrow::Load | ( | xmlNodePtr | node | ) | [virtual] |
node,: | a pointer to the xmlNode containing the serialized arrow. |
Used to load an arrow in memory.
Reimplemented from gcp::Arrow.
void gcp::ReactionArrow::Move | ( | double | x, |
double | y, | ||
double | z = 0 |
||
) | [virtual] |
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] |
Reimplemented from gcp::Arrow.
void gcp::ReactionArrow::OnLoaded | ( | ) | [virtual] |
This method should be called when an arrow has been fully loaded.
Reimplemented from gcu::Object.
bool gcp::ReactionArrow::OnSignal | ( | gcu::SignalId | Signal, |
gcu::Object * | Child | ||
) | [virtual] |
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.
Reimplemented from gcu::Object.
void gcp::ReactionArrow::PositionChild | ( | ReactionProp * | prop | ) |
prop | the attached property to position. |
Position an object at the right place near the arrow.
void gcp::ReactionArrow::RemoveStep | ( | ReactionStep * | Step | ) |
Step | the 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] |
xml | the xmlDoc used to save the document. |
Used to save the arrow to the xmlDoc.
Reimplemented from gcu::Object.
void gcp::ReactionArrow::SetEndStep | ( | ReactionStep * | Step | ) | [inline] |
Step | the reaction step after the reaction |
Sets the final reaction step.
Definition at line 92 of file reaction-arrow.h.
bool gcp::ReactionArrow::SetProperty | ( | unsigned | property, |
char const * | value | ||
) | [virtual] |
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.
Reimplemented from gcp::Arrow.
void gcp::ReactionArrow::SetSelected | ( | int | state | ) | [virtual] |
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] |
Step | the reaction step before the reaction |
Sets the initial reaction step.
Definition at line 82 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.