The Gnome Chemistry Utils
0.12.11
|
The Gnome Chemistry Utils C++ classes. More...
The Gnome Chemistry Utils C++ classes.
The namespace used for all C++ classes provided by the Gnome Chemistry Utils base library.
typedef bool(* gcu::BuildMenuCb)(Object *target, GtkUIManager *UIManager, Object *object, double x, double y) |
typedef std::list<CrystalAtom*> gcu::CrystalAtomList |
a list of pointers to CrystalAtom instances derived from std::list.
Definition at line 247 of file crystalatom.h.
typedef std::list<CrystalCleavage*> gcu::CrystalCleavageList |
a list of pointers to CrystalCleavage instances derived from std::list.
Definition at line 122 of file crystalcleavage.h.
typedef std::list<CrystalLine*> gcu::CrystalLineList |
a list of pointers to CrystalLine instances derived from std::list.
Definition at line 348 of file crystalline.h.
typedef unsigned gcu::SignalId |
The types of the signals used in Object::EmitSignal() and Object::OnSignal(). Each signal must type be retrieved from a call to Object::CreateNewSignalId().
typedef unsigned gcu::TypeId |
The type of an object instance. Either predefined types are defined in the enum above or dynamically defined types by calls to Object::AddType.
enum gcu::CheckType |
CheckType CheckType describes how numbers entered in entries might be checked. Possible values are:
This enumeration is used in Dialog::GetNumber.
enum gcu::ContentType |
The list of supported data types.
Definition at line 35 of file gcu/structs.h.
enum gcu::CrystalLineType |
crystalviewer/crystalline.h The type of a CrystalLine instance. Possible values are:
Definition at line 43 of file crystalline.h.
enum gcu::Display3DMode |
3D display mode. Possible values are:
Definition at line 46 of file chem3ddoc.h.
gcu/formula.h The way formula should be interpreted when they contain symbols that might represent both an atom or a group of atoms such as Ac and Pr. Possible values are:
enum gcu::gcLattices |
crystalviewer/crystaldoc.h This enumeration gives sympolic names to the fourteen Bravais lattices.
Possible values are:
Definition at line 66 of file crystaldoc.h.
enum gcu::GcuTypeId |
This enumeration is used to determine the type of an Object instance. Possible values are:
Some types are not used in the Gnome Chemistry Utils, but only in GChemPaint and might disappear from this list in future versions and replaced by dynamically created types.
enum gcu::MatrixType |
This enumeration is used to determine the type a Matrix. Possible values are:
This enumeration is used in one of the constructors (Matrix(Psi, Theta, Phi, Type)) of class Matrix.
enum gcu::PrintScaleType |
gcu/printable.h Represents how printing is scaled
GCU_PRINT_SCALE_NONE |
No scaling is done. |
GCU_PRINT_SCALE_FIXED |
Explicit scaling. |
GCU_PRINT_SCALE_AUTO |
Automatic scaling (will fill the print area). |
Definition at line 40 of file printable.h.
enum gcu::RuleId |
This enumeration is used to maintain a set of rules about the possible hierarchical of the document. They are used with two class names or ids. Possible values are:
gcu/spectrumdoc.h Represents the list of data formats from the JCAMP-DX specification supported by the gcu::SpectrumDocument class. See the JCAMP-DX specification for more information.
Definition at line 173 of file spectrumdoc.h.
enum gcu::SpectrumType |
gcu/spectrumdoc.h Represents the list of spectrum types supported (or which should be supported) by the gcu::SpectrumDocument class.
Definition at line 40 of file spectrumdoc.h.
gcu/spectrumdoc.h Represents the list of units supported by the gcu::SpectrumDocument class.
Definition at line 96 of file spectrumdoc.h.
enum gcu::SpectrumVarType |
gcu/spectrumdoc.h Represents the list of varialble types supported by the gcu::SpectrumDocument class.
Definition at line 148 of file spectrumdoc.h.
enum gcu::WindowState |
Window states
NormalWindowState |
Normal window. |
MaximizedWindowState |
Maximized window. |
MinimizedWindowState |
Minimized window. |
FullScreenWindowState |
Full screen window. |
Definition at line 46 of file gcu/application.h.
xmlNodePtr gcu::FindNodeByNameAndId | ( | xmlNodePtr | node, |
const char * | name, | ||
const char * | id = NULL |
||
) |
ReadPosition
node,: | a pointer to the current parsed XML Node. |
name,: | the name of the searched node. |
id,: | the id property of the node or NULL if not significant. This parameter might be omitted in the last case. |
Helper method used to search the xmlNode instance of name Name and with id property equal to id in the children of node. When id is NULL, the searched node does not have an id property. When id is not NULL, the searched node should be unique.
char const* gcu::GetStaticScale | ( | char * | buf | ) |
buf,: | a string to convert to a static instance. |
This function is used to replace a dynamically allocated string by a static instance. It works managing a set of string instances. It is used for scale names (as for radii and electronegativity), hence its name.
GtkUnit gcu::gtk_unit_from_string | ( | char const * | name | ) |
name | a string representing a GtkUnit. |
char const* gcu::gtk_unit_to_string | ( | GtkUnit | unit | ) |
unit | a GtkUnit. |
Vector gcu::operator* | ( | double | f, |
Vector const & | v | ||
) |
f | a multiplication factor |
v | the vector to multiply |
Vector3f gcu::operator* | ( | float | f, |
Vector3f const & | v | ||
) |
f | a multiplication factor |
v | the vector to multiply |
bool gcu::ReadColor | ( | xmlNodePtr | node, |
const char * | id, | ||
float * | red, | ||
float * | green, | ||
float * | blue, | ||
float * | alpha = NULL |
||
) |
node,: | a pointer to the xmlNode representing an Object instance. |
id,: | the value of the id property of the color. This is used for Object instances having at least two colors. |
red,: | a pointer to the red component of the color. |
green,: | a pointer to the green component of the color. |
blue,: | a pointer to the blue component of the color. |
alpha,: | a pointer to the alpha component of the color or NULL if tranparency is not managed. |
This method can be used to load a color in an Object instance. It should be used in cunjunction with WriteColor() which executes the inverse operation. If id is NULL, a color with no id property will be search and parsed.
GOColor gcu::ReadColor | ( | xmlNodePtr | node | ) |
node,: | a pointer to the xmlNode from which the color must be retrieved. Builds a GOColor from the node properties. |
bool gcu::ReadFloat | ( | xmlNodePtr | node, |
char const * | name, | ||
double & | value, | ||
double | default_value = 0. |
||
) |
node | a pointer to an XML node. |
name | the property name. |
value | the value for the property. |
default_value | the default value for the property if the property can't be retrieved. |
Retrieves value from the node property with name name. Sets the default value if somthing goes wrong.
bool gcu::ReadPosition | ( | xmlNodePtr | node, |
const char * | id, | ||
double * | x, | ||
double * | y, | ||
double * | z = NULL |
||
) |
node,: | a pointer to the xmlNode representing an Object instance. |
id,: | the value of the id property of the position. This is used for example for arrows because both the head and the tail of the arrow are positions. |
x,: | a pointer to the x coordinate of the position. |
y,: | a pointer to the y coordinate of the position. |
z,: | a pointer to the z coordinate of the position or NULL for 2D objects. |
This method can be used to load the coordinates of a point in an Object instance. It should be used in cunjunction with WritePosition() which executes the inverse operation. If id is NULL, a position with no id property will be search and parsed.
bool gcu::ReadRadius | ( | xmlNodePtr | node, |
GcuAtomicRadius & | radius | ||
) |
node,: | a pointer to the xmlNode representing an Object instance. |
radius,: | a GcuAtomicRadius structure. |
This function parses the XML node representing a radius (written using WriteRadius()) and fills the fields in the GcuAtomicRadius structure with the data parsed.
bool gcu::WriteColor | ( | xmlDocPtr | xml, |
xmlNodePtr | node, | ||
const char * | id, | ||
double | red, | ||
double | green, | ||
double | blue, | ||
double | alpha = 1.0 |
||
) |
xml,: | a pointer to the xmlDoc used to serialize the document. |
node,: | a pointer to the xmlNode representing an Object instance. |
id,: | the value of the id property of the color. This is used for Object instances having at least two colors. of the arrow are positions. |
red,: | the red component of the color. |
green,: | the green component of the color. |
blue,: | the blue component of the color. |
alpha,: | the alpha component of the color. |
Save a color as an XML node added to the children of node. This color can then be parsed using ReadColor().
void gcu::WriteColor | ( | xmlNodePtr | node, |
GOColor | color | ||
) |
node,: | a pointer to the xmlNode to which the color must be serialized. |
color,: | a pointer to the xmlNode from which the color must be retrieved. Serializes color to node. |
void gcu::WriteFloat | ( | xmlNodePtr | node, |
char const * | name, | ||
double | value | ||
) |
node | a pointer to an XML node. |
name | the property name. |
value | the value for the property. |
Adds value as a property with name name to node.
bool gcu::WritePosition | ( | xmlDocPtr | xml, |
xmlNodePtr | node, | ||
const char * | id, | ||
double | x, | ||
double | y, | ||
double | z = 0.0 |
||
) |
WritePosition
xml,: | a pointer to the xmlDoc used to serialize the document. |
node,: | a pointer to the xmlNode representing an Object instance. |
id,: | the value of the id property of the position. This is used for example for arrows because both the head and the tail of the arrow are positions. |
x,: | the x coordinate of the position. |
y,: | the y coordinate of the position. |
z,: | the z coordinate of the position. |
Save a position as an XML node added to the children of node. This position can then be parsed using ReadPosition().
bool gcu::WriteRadius | ( | xmlDocPtr | xml, |
xmlNodePtr | node, | ||
const GcuAtomicRadius & | radius | ||
) |
xml,: | a pointer to the xmlDoc used to serialize the document. |
node,: | a pointer to the xmlNode representing an Object instance. |
radius,: | a GcuAtomicRadius structure. |
Save a radius as an XML node added to the children of node. This radius can then be parsed using ReadRadius().
gchar const* gcu::LatticeName[] |
A table of the Bravais lattices names.
char const* gcu::LineTypeName[] |
an array of the line types names used for serialization.