gcu Namespace Reference


Classes

class  Application
class  Atom
class  Bond
class  Chem3dDoc
class  CrystalAtom
class  CrystalCleavage
class  CrystalDoc
class  CrystalLine
class  CrystalView
class  DialogOwner
class  Dialog
class  Document
class  Element
class  FileChooser
class  parse_error
class  Formula
class  GLDocument
class  GLView
class  Isotope
class  IsotopicPattern
class  Matrix
class  Matrix2D
class  Object
class  Value
class  SimpleValue
class  DimensionalValue
class  StringValue
class  LocalizedStringValue

Typedefs

typedef list< CrystalAtom * > CrystalAtomList
typedef std::list< CrystalCleavage * > CrystalCleavageList
typedef list< CrystalLine * > CrystalLineList
typedef unsigned TypeId
typedef unsigned SignalId

Enumerations

enum  Display3DMode { BALL_AND_STICK, SPACEFILL }
enum  gcLattices {
  cubic = 0, body_centered_cubic, face_centered_cubic, hexagonal,
  tetragonal, body_centered_tetragonal, orthorhombic, base_centered_orthorhombic,
  body_centered_orthorhombic, face_centered_orthorhombic, rhombohedral, monoclinic,
  base_centered_monoclinic, triclinic
}
enum  CrystalLineType {
  edges = 0, diagonals, medians, normal,
  unique
}
enum  CheckType {
  NoCheck, Min, Max, MinMax,
  MinEq, MaxEq, MinEqMax, MinMaxEq,
  MinEqMaxEq
}
enum  MatrixType { euler, antieuler, rotation }
enum  GcuTypeId {
  NoType, AtomType, FragmentType, BondType,
  MoleculeType, ChainType, CycleType, ReactantType,
  ReactionArrowType, ReactionOperatorType, ReactionType, MesomeryType,
  MesomeryArrowType, DocumentType, TextType, OtherType
}
enum  RuleId { RuleMayContain, RuleMustContain, RuleMayBeIn, RuleMustBeIn }


Detailed Description

The namespace used for all C++ classes provided by the Gnome Chemistry Utils.


Typedef Documentation

typedef list<CrystalAtom*> gcu::CrystalAtomList

a list of pointers to CrystalAtom instances derived from std::list.

Definition at line 230 of file crystalatom.h.

typedef std::list<CrystalCleavage*> gcu::CrystalCleavageList

a list of pointers to CrystalCleavage instances derived from std::list.

Definition at line 121 of file crystalcleavage.h.

typedef list<CrystalLine*> gcu::CrystalLineList

a list of pointers to CrystalLine instances derived from std::list.

Definition at line 353 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().

Definition at line 120 of file object.h.

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.

Definition at line 94 of file object.h.


Enumeration Type Documentation

enum gcu::CheckType

CheckType CheckType describes how numbers entered in entries might be checked. Possible values are:

This enumeration is used in Dialog::GetNumber.

Enumerator:
NoCheck 
Min 
Max 
MinMax 
MinEq 
MaxEq 
MinEqMax 
MinMaxEq 
MinEqMaxEq 

Definition at line 50 of file dialog.h.

enum gcu::CrystalLineType

crystalviewer/crystalline.h The type of a CrystalLine instance. Possible values are:

Enumerator:
edges 
diagonals 
medians 
normal 
unique 

Definition at line 44 of file crystalline.h.

enum gcu::Display3DMode

3D display mode. Possible values are:

Enumerator:
BALL_AND_STICK 
SPACEFILL 

Definition at line 45 of file chem3ddoc.h.

enum gcu::gcLattices

crystalviewer/crystaldoc.h This enumeration gives sympolic names to the fourteen Bravais lattices.

Possible values are:

Enumerator:
cubic 
body_centered_cubic 
face_centered_cubic 
hexagonal 
tetragonal 
body_centered_tetragonal 
orthorhombic 
base_centered_orthorhombic 
body_centered_orthorhombic 
face_centered_orthorhombic 
rhombohedral 
monoclinic 
base_centered_monoclinic 
triclinic 

Definition at line 61 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.
Enumerator:
NoType 
AtomType 
FragmentType 
BondType 
MoleculeType 
ChainType 
CycleType 
ReactantType 
ReactionArrowType 
ReactionOperatorType 
ReactionType 
MesomeryType 
MesomeryArrowType 
DocumentType 
TextType 
OtherType 

Definition at line 70 of file object.h.

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.
Enumerator:
euler 
antieuler 
rotation 

Definition at line 41 of file matrix.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:

Enumerator:
RuleMayContain 
RuleMustContain 
RuleMayBeIn 
RuleMustBeIn 

Definition at line 108 of file object.h.


Generated on Tue Sep 18 14:59:48 2007 for The Gnome Chemistry Utils by  doxygen 1.5.2