The Gnome Chemistry Utils  0.13.7
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

Protected Attributes

SpectrumViewm_View

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

Default constructor

Parameters:
appthe application.
viewan optional already existing SpectrumView instance.

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.

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.

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.

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.

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

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: