The Gnome Chemistry Utils
0.12.11
|
#include <gcu/spectrumdoc.h>
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) |
SpectrumView * | GetView (void) |
bool | GetEmpty (void) const |
SpectrumType | GetSpectrumType (void) const |
SpectrumUnitType | GetXUnit (void) const |
SpectrumUnitType | GetYUnit (void) const |
bool | GetIntegralVisible (void) const |
Protected Attributes | |
SpectrumView * | m_View |
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.
Default constructor
gcu::SpectrumDocument::SpectrumDocument | ( | Application * | app, |
SpectrumView * | view = NULL |
||
) |
app | the application. |
view | an optional already existing SpectrumView instance. |
Default destructor
gcu::SpectrumDocument::GetEmpty | ( | void | ) | const [inline] |
Definition at line 365 of file spectrumdoc.h.
gcu::SpectrumDocument::GetIntegralVisible | ( | void | ) | const [inline] |
Definition at line 384 of file spectrumdoc.h.
gcu::SpectrumDocument::GetSpectrumType | ( | void | ) | const [inline] |
Definition at line 369 of file spectrumdoc.h.
gcu::SpectrumDocument::GetView | ( | void | ) | [inline] |
Definition at line 361 of file spectrumdoc.h.
gcu::SpectrumDocument::GetXUnit | ( | void | ) | const [inline] |
Definition at line 374 of file spectrumdoc.h.
gcu::SpectrumDocument::GetYUnit | ( | void | ) | const [inline] |
Definition at line 379 of file spectrumdoc.h.
void gcu::SpectrumDocument::Load | ( | char const * | uri, |
char const * | mime_type = NULL |
||
) |
uri | the uri of the spectrum file. |
mime_type | the 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.
Used to show or hide the integral curve for an NMR spectrum.
void gcu::SpectrumDocument::OnTransformFID | ( | GtkButton * | btn | ) |
btn | the clicked GtkButton. |
Called to transform an FID to the NMR spectrum. The label in the GtkButton might be changed.
void gcu::SpectrumDocument::OnXAxisInvert | ( | bool | inverted | ) |
inverted | whether 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 gcu::SpectrumDocument::OnXUnitChanged | ( | int | i | ) |
i | the 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 gcu::SpectrumDocument::OnYUnitChanged | ( | int | i | ) |
i | the 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.
gcu::SpectrumDocument::m_View [protected] |
The SpectrumView instance associated with the document.
Definition at line 361 of file spectrumdoc.h.