The Gnome Chemistry Utils  0.13.90
Public Member Functions | Protected Attributes
gcugtk::SpectrumDocument Class Reference

#include <gcugtk/spectrumdoc.h>

Inheritance diagram for gcugtk::SpectrumDocument:
gcu::Document gcugtk::Printable gcu::Object gcu::DialogOwner gcu::DialogOwner

List of all members.

Public Member Functions

 SpectrumDocument ()
 SpectrumDocument (Application *app, SpectrumView *view=NULL)
 ~SpectrumDocument ()
void Load (char const *uri, char const *mime_type=NULL)
void OnXUnitChanged (int i)
void OnYUnitChanged (int i)
void OnXAxisInvert (bool inverted)
void OnShowIntegral ()
void OnTransformFID (GtkButton *btn)
bool SetProperty (unsigned property, char const *value)
bool Loaded () throw (gcu::LoaderError)
SpectrumViewGetView (void)
bool GetEmpty (void) const
SpectrumType GetSpectrumType (void) const
SpectrumUnitType GetXUnit (void) const
SpectrumUnitType GetYUnit (void) const
bool GetIntegralVisible (void) const
- Public Member Functions inherited from gcu::Document
 Document (Application *App=NULL)
virtual ~Document ()
std::string & GetTranslatedId (const char *id)
void EraseTranslationId (const char *Id)
void EmptyTranslationTable ()
virtual void SetTitle (std::string &title)
virtual void SetTitle (char const *title)
std::string & GetTitle ()
void NotifyDirty (Object *pObject)
virtual void Save () const
virtual ResidueCreateResidue (char const *name, char const *symbol, Molecule *molecule)
virtual Residue const * GetResidue (char const *symbol, bool *ambiguous=NULL)
bool SetTarget (char const *id, Object **target, Object *parent, Object *owner=NULL, Action action=ActionException) throw (std::runtime_error)
std::string Name ()
void ObjectLoaded (Object *obj)
std::set< Object * > GetNewObjects ()
virtual WindowGetWindow ()
ApplicationGetApp (void)
bool GetEmpty (void)
void SetScale (double val)
double GetScale (void) const
double & GetRefScale (void)
- Public Member Functions inherited from gcu::Object
 Object (TypeId Id=OtherType)
virtual ~Object ()
TypeId GetType () const
void SetId (gchar const *Id)
char const * GetId () const
virtual void AddChild (Object *object)
ObjectGetMolecule () const
ObjectGetReaction () const
ObjectGetGroup () const
DocumentGetDocument () const
ApplicationGetApplication () const
ObjectGetParentOfType (TypeId Id) const
ObjectGetChild (const gchar *Id) const
ObjectGetFirstChild (std::map< std::string, Object * >::iterator &i)
ObjectGetNextChild (std::map< std::string, Object * >::iterator &i)
ObjectGetDescendant (const char *Id) const
ObjectGetParent () const
void SetParent (Object *Parent)
virtual xmlNodePtr Save (xmlDocPtr xml) const
virtual bool Load (xmlNodePtr node)
virtual bool GetCoords (double *x, double *y, double *z=NULL) const
virtual void Move (double x, double y, double z=0.)
virtual void Transform2D (Matrix2D &m, double x, double y)
bool SaveChildren (xmlDocPtr xml, xmlNodePtr node) const
void SaveId (xmlNodePtr node) const
xmlNodePtr GetNodeByProp (xmlNodePtr node, char const *Property, char const *Id)
xmlNodePtr GetNextNodeByProp (xmlNodePtr node, char const *Property, char const *Id)
xmlNodePtr GetNodeByName (xmlNodePtr node, char const *Name)
xmlNodePtr GetNextNodeByName (xmlNodePtr node, char const *Name)
bool HasChildren () const
unsigned GetChildrenNumber () const
virtual ObjectGetAtomAt (double x, double y, double z=0.)
virtual bool Build (std::set< Object * > const &Children) throw (std::invalid_argument)
virtual double GetYAlign ()
virtual bool BuildContextualMenu (UIManager *uim, Object *object, double x, double y)
void EmitSignal (SignalId Signal)
virtual bool OnSignal (SignalId Signal, Object *Child)
void Lock (bool state=true)
bool IsLocked ()
ObjectGetFirstLink (std::set< Object * >::iterator &i)
ObjectGetNextLink (std::set< Object * >::iterator &i)
void Link (Object *object)
void Unlink (Object *object)
virtual void OnUnlink (Object *object)
void GetPossibleAncestorTypes (std::set< TypeId > &types) const
virtual std::string GetProperty (unsigned property) const
virtual void OnLoaded ()
void SetDirty (bool dirty=true)
virtual void Clear ()
std::string Identity ()
virtual char const * HasPropertiesDialog () const
virtual bool CanSelect () const
virtual void NotifyEmpty ()
void ShowPropertiesDialog ()
bool GetDirty (void) const
- Public Member Functions inherited from gcu::DialogOwner
 DialogOwner ()
virtual ~DialogOwner ()
DialogGetDialog (std::string name) const
void ClearDialogs ()
- Public Member Functions inherited from gcugtk::Printable
 Printable ()
virtual ~Printable ()
virtual bool SupportsHeaders ()
virtual bool SupportMultiplePages ()
virtual int GetPagesNumber ()
void Print (bool preview)
void SetPageSetup (GtkPageSetup *PageSetup)
GtkPrintSettings * GetPrintSettings (void) const
void SetUnit (GtkUnit val)
GtkUnit GetUnit (void) const
GtkUnit & GetRefUnit (void)
void SetHeaderHeight (double val)
double GetHeaderHeight (void) const
double & GetRefHeaderHeight (void)
void SetFooterHeight (double val)
double GetFooterHeight (void) const
double & GetRefFooterHeight (void)
void SetHorizCentered (bool val)
bool GetHorizCentered (void) const
bool & GetRefHorizCentered (void)
void SetVertCentered (bool val)
bool GetVertCentered (void) const
bool & GetRefVertCentered (void)
void SetScaleType (PrintScaleType val)
PrintScaleType GetScaleType (void) const
PrintScaleTypeGetRefScaleType (void)
void SetScale (double val)
double GetScale (void) const
double & GetRefScale (void)
void SetHorizFit (bool val)
bool GetHorizFit (void) const
bool & GetRefHorizFit (void)
void SetVertFit (bool val)
bool GetVertFit (void) const
bool & GetRefVertFit (void)
void SetHPages (int val)
int GetHPages (void) const
int & GetRefHPages (void)
void SetVPages (int val)
int GetVPages (void) const
int & GetRefVPages (void)
void SetHasBackground (bool val)
bool GetHasBackground (void) const
bool & GetRefHasBackground (void)
void SetPrintBackground (bool val)
bool GetPrintBackground (void) const
bool & GetRefPrintBackground (void)

Protected Attributes

SpectrumViewm_View
- Protected Attributes inherited from gcu::Document
std::string m_Title
std::set< Object * > m_DirtyObjects
Applicationm_App

Detailed Description

The document class used for spectra. This API is still quite unstable and might change in the future.

Definition at line 268 of file spectrumdoc.h.


Constructor & Destructor Documentation

gcugtk::SpectrumDocument::SpectrumDocument ( )

Default constructor

gcugtk::SpectrumDocument::SpectrumDocument ( Application app,
SpectrumView view = NULL 
)
Parameters:
appthe application.
viewan optional already existing SpectrumView instance.
gcugtk::SpectrumDocument::~SpectrumDocument ( )

Default destructor


Member Function Documentation

gcugtk::SpectrumDocument::GetEmpty ( void  ) const
inline
Returns:
true if the document does not have any data, false otherwise.

Definition at line 377 of file spectrumdoc.h.

gcugtk::SpectrumDocument::GetIntegralVisible ( void  ) const
inline
Returns:
true if the integral of an NMR spectrum is visible, false in all other cases.

Definition at line 396 of file spectrumdoc.h.

gcugtk::SpectrumDocument::GetSpectrumType ( void  ) const
inline
Returns:
the gcu::SpectrumType of the document, or GCU_SPECTRUM_TYPE_MAX.

Definition at line 381 of file spectrumdoc.h.

gcugtk::SpectrumDocument::GetView ( void  )
inline
Returns:
the SpectrumView instance associated with the document.

Definition at line 373 of file spectrumdoc.h.

gcugtk::SpectrumDocument::GetXUnit ( void  ) const
inline
Returns:
the unit of the x-axis as gcu::SpectumUnitType, or GCU_SPECTRUM_UNIT_MAX.

Definition at line 386 of file spectrumdoc.h.

gcugtk::SpectrumDocument::GetYUnit ( void  ) const
inline
Returns:
the unit of the y-axis as gcu::SpectumUnitType, or GCU_SPECTRUM_UNIT_MAX.

Definition at line 391 of file spectrumdoc.h.

void gcugtk::SpectrumDocument::Load ( char const *  uri,
char const *  mime_type = NULL 
)
Parameters:
urithe uri of the spectrum file.
mime_typethe mime type of the spectrum file.

Loads a spaectrum from the provided uri. Default mime type is NULL, "chemical/x-jcamp-dx" is the only one supported at the moment.

bool gcugtk::SpectrumDocument::Loaded ( ) throw (gcu::LoaderError)
virtual

Called by the application when the document has been loaded.

Reimplemented from gcu::Document.

void gcugtk::SpectrumDocument::OnShowIntegral ( )

Used to show or hide the integral curve for an NMR spectrum.

void gcugtk::SpectrumDocument::OnTransformFID ( GtkButton *  btn)
Parameters:
btnthe clicked GtkButton.

Called to transform an FID to the NMR spectrum. The label in the GtkButton might be changed.

void gcugtk::SpectrumDocument::OnXAxisInvert ( bool  inverted)
Parameters:
invertedwhether to invert the X axis scale.

Called to change the X axis scale order. This is used by the framework after a user made an appropriate request from the graphical interface.

void gcugtk::SpectrumDocument::OnXUnitChanged ( int  i)
Parameters:
ithe rank of the unit to set.

Called to change the displayed X axis unit. The values acceptable for the parameter are spectrum type dependent. This is used by the framework after a user made an appropriate request from the graphical interface.

void gcugtk::SpectrumDocument::OnYUnitChanged ( int  i)
Parameters:
ithe rank of the unit to set.

Called to change the displayed Y axis unit. The values acceptable for the parameter are spectrum type dependent. This is used by the framework after a user made an appropriate request from the graphical interface.

bool gcugtk::SpectrumDocument::SetProperty ( unsigned  property,
char const *  value 
)
virtual
Parameters:
propertythe property id as defined in objprops.h
valuethe property value as a string

Used when loading to set properties to spectra.

Returns:
true if the property could be set, or if the property is not relevant, false otherwise.

Reimplemented from gcu::Object.


Member Data Documentation

gcugtk::SpectrumDocument::m_View
protected

The SpectrumView instance associated with the document.

Definition at line 373 of file spectrumdoc.h.


The documentation for this class was generated from the following file: