The Gnome Chemistry Utils 0.13.3
Public Member Functions
gcp::ReactionOperator Class Reference

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

#include <gcp/reaction-operator.h>

Inheritance diagram for gcp::ReactionOperator:
gcu::Object gccv::ItemClient

List of all members.

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

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:
xwhere to store the x coordinate of the operator.
ywhere to store the y coordinate of the operator.
zwhere 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:
xthe x component of the transation vector.
ythe y component of the transation vector.
zthe 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:
xthe new x coordinate of the operator.
ythe 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: