List of all members.
Detailed Description
Arrow class for arrows used in chemical reactions.
Definition at line 40 of file reaction-arrow.h.
Constructor & Destructor Documentation
virtual gcp::ReactionArrow::~ReactionArrow |
( |
|
) |
[virtual] |
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 |
( |
GtkUIManager * |
UIManager, |
|
|
gcu::Object * |
object, |
|
|
double |
x, |
|
|
double |
y | |
|
) |
| | |
- Parameters:
-
| UIManager | the GtkUIManager 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.
bool gcp::ReactionArrow::Load |
( |
xmlNodePtr |
node |
) |
|
- 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 | |
|
) |
| | |
- 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 |
( |
|
) |
|
- Returns:
- the localized object generic name.
Reimplemented from gcp::Arrow.
void gcp::ReactionArrow::OnLoaded |
( |
|
) |
|
This method should be called when an arrow has been fully loaded.
- 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.
void gcp::ReactionArrow::PositionChild |
( |
ReactionProp * |
prop |
) |
|
- Parameters:
-
| prop | the attached property to position. |
Position an object at the right place near the arrow.
- Parameters:
-
| 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 |
- Parameters:
-
| xml | the xmlDoc used to save the document. |
Used to save the arrow to the xmlDoc.
- Returns:
- the xmlNode containing the serialized arrow.
void gcp::ReactionArrow::SetEndStep |
( |
ReactionStep * |
Step |
) |
[inline] |
- Parameters:
-
| Step | the reaction step after the reaction |
Sets the final reaction step.
Definition at line 88 of file reaction-arrow.h.
bool gcp::ReactionArrow::SetProperty |
( |
unsigned |
property, |
|
|
char const * |
value | |
|
) |
| | |
- 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] |
void gcp::ReactionArrow::SetStartStep |
( |
ReactionStep * |
Step |
) |
[inline] |
- Parameters:
-
| Step | the reaction step before the reaction |
Sets the initial reaction step.
Definition at line 78 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.
The documentation for this class was generated from the following file: