gcp::Fragment Class Reference

Inheritance diagram for gcp::Fragment:

gcp::TextObject gcu::Object

List of all members.

Public Member Functions

void SetSelected (GtkWidget *w, int state)
void Add (GtkWidget *w)
void Update (GtkWidget *w)
xmlNodePtr Save (xmlDocPtr xml)
bool Load (xmlNodePtr)
ObjectGetAtomAt (double x, double y, double z=0.)
void Move (double x, double y, double z=0)
void Transform2D (Matrix2D &m, double x, double y)
AtomGetAtom ()
double GetYAlign ()


Detailed Description

Definition at line 36 of file fragment.h.


Member Function Documentation

void gcp::Fragment::SetSelected ( GtkWidget *  w,
int  state 
) [virtual]

Parameters:
w,: the GtkWidget inside which the Object is displayed.
state,: the selection state of the Object.
Used to set the selection state of the Object inside the widget. The values of state are application dependant and have no default value.

Reimplemented from gcu::Object.

void gcp::Fragment::Add ( GtkWidget *  w  )  [virtual]

Parameters:
w,: the GtkWidget inside which the Object will be displayed.
Used to add a representation of the Object in the widget. This method might be overrided for displayable Object classes unless the application uses another mechanism.

Reimplemented from gcu::Object.

void gcp::Fragment::Update ( GtkWidget *  w  )  [virtual]

Parameters:
w,: the GtkWidget inside which the Object is displayed.
Used to update the representation of the Object in the widget. This method might be overrided for displayable Object classes unless the application uses another mechanism.

Reimplemented from gcu::Object.

xmlNodePtr gcp::Fragment::Save ( xmlDocPtr  xml  )  [virtual]

Parameters:
xml,: the xmlDoc used to save the document.
Used to save the Object to the xmlDoc. Each serializable Object should implement this virtual method.
Returns:
the xmlNode containing the serialized object. The name of the node should be the name of the corresponding type used as first parameter to the Object::AddType method. The default method just saves the id and children.

Reimplemented from gcu::Object.

bool gcp::Fragment::Load ( xmlNodePtr  node  )  [virtual]

Parameters:
node,: a pointer to the xmlNode containing the serialized object.
Used to load an Object in memory. The Object must already exist.

Example:

        std::string str = (const char*)node->name;
        Object* pObject = Object::CreateObject(str, this);
        if (pObject) {
                if (!pObject->Load(node)) delete Object; 
        } else
                cerr << "Warning: unknown object: " << str << endl;

Returns:
true on succes, false otherwise.

Reimplemented from gcp::TextObject.

Object* gcp::Fragment::GetAtomAt ( double  x,
double  y,
double  z = 0. 
) [virtual]

Parameters:
x,: the x coordinate
y,: the y coordinate
z,: the z coordinate
Returns:
a pointer to a child of type Atomtype at or near position defined by the coordinates passed as parameters. Default implementation returns NULL.

Reimplemented from gcu::Object.

void gcp::Fragment::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 an object. This virtual method should most often be overrided by Object derived classes for which it makes sense. The base Object class has no coordinates and the default method only loads its id and children.

Reimplemented from gcp::TextObject.

void gcp::Fragment::Transform2D ( Matrix2D m,
double  x,
double  y 
) [virtual]

Parameters:
m,: the 2D Matrix of the transformation.
x,: the x component of the center of the transformation.
y,: the y component of the center of the transformation.
Used to move and/or transform an object. This virtual method must be overrided by Object derived classes for which it makes sense. The base Object class has no coordinates and the default method calls the corresponding method for every child.

Reimplemented from gcu::Object.

double gcp::Fragment::GetYAlign (  )  [virtual]

Used to retreive the y coordinate for alignment. The default implementation returns 0.0 and every derived class for which alignment has a meaning should implement this method.

Returns:
y coordinate used for objects alignment.

Reimplemented from gcu::Object.


The documentation for this class was generated from the following file:
Generated on Sun Sep 16 14:21:56 2007 for The Gnome Chemistry Utils by  doxygen 1.5.3