#include <gcugtk/spectrumdoc.h>

Inheritance diagram for gcugtk::SpectrumDocument:

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)

SpectrumView *	GetView (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 Residue *	CreateResidue (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 Window *	GetWindow ()

Application *	GetApp (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)

Object *	GetMolecule () const

Object *	GetReaction () const

Object *	GetGroup () const

Document *	GetDocument () const

Application *	GetApplication () const

Object *	GetParentOfType (TypeId Id) const

Object *	GetChild (const gchar *Id) const

Object *	GetFirstChild (std::map< std::string, Object *>::iterator &i)

Object *	GetNextChild (std::map< std::string, Object *>::iterator &i)

Object *	GetDescendant (const char *Id) const

Object *	GetParent () 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 Object *	GetAtomAt (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 ()

Object *	GetFirstLink (std::set< Object *>::iterator &i)

Object *	GetNextLink (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 ()

Dialog *	GetDialog (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

GtkPageSetup *	GetPageSetup (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

PrintScaleType &	GetRefScaleType (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
SpectrumView *	m_View

Protected Attributes inherited from gcu::Document
std::string	m_Title

std::set< Object * >	m_DirtyObjects

Application *	m_App

bool	m_Empty

Additional Inherited Members
Static Public Member Functions inherited from gcu::Object
static TypeId	AddType (std::string TypeName, Object (CreateFunc)(), TypeId id=OtherType)

static void	AddAlias (TypeId id, std::string TypeName)

static Object *	CreateObject (const std::string &TypeName, Object *parent=NULL)

static TypeId	GetTypeId (const std::string &Name)

static std::string	GetTypeName (TypeId Id)

static void	AddMenuCallback (TypeId Id, BuildMenuCb cb)

static void	AddRule (TypeId type1, RuleId rule, TypeId type2)

static void	AddRule (const std::string &type1, RuleId rule, const std::string &type2)

static const std::set< TypeId > &	GetRules (TypeId type, RuleId rule)

static const std::set< TypeId > &	GetRules (const std::string &type, RuleId rule)

static void	SetCreationLabel (TypeId Id, std::string Label)

static const std::string &	GetCreationLabel (TypeId Id)

static const std::string &	GetCreationLabel (const std::string &TypeName)

static SignalId	CreateNewSignalId ()

Protected Member Functions inherited from gcu::Object
virtual Dialog *	BuildPropertiesDialog ()

Detailed Description

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

Definition at line 272 of file spectrumdoc.h.

Constructor & Destructor Documentation

◆ SpectrumDocument() [1/2]

gcugtk::SpectrumDocument::SpectrumDocument ( )

Default constructor

◆ SpectrumDocument() [2/2]

gcugtk::SpectrumDocument::SpectrumDocument	(	Application *	app,
		SpectrumView *	view = `NULL`
	)

Parameters

app	the application.
view	an optional already existing SpectrumView instance.

◆ ~SpectrumDocument()

gcugtk::SpectrumDocument::~SpectrumDocument ( )

Default destructor

Member Function Documentation

◆ GetEmpty()

gcugtk::SpectrumDocument::GetEmpty ( void ) const

inline

Returns: true if the document does not have any data, false otherwise.

Definition at line 381 of file spectrumdoc.h.

◆ GetIntegralVisible()

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 400 of file spectrumdoc.h.

◆ GetSpectrumType()

gcugtk::SpectrumDocument::GetSpectrumType ( void ) const

inline

Returns: the gcu::SpectrumType of the document, or GCU_SPECTRUM_TYPE_MAX.

Definition at line 385 of file spectrumdoc.h.

◆ GetView()

gcugtk::SpectrumDocument::GetView ( void )

inline

Returns: the SpectrumView instance associated with the document.

Definition at line 377 of file spectrumdoc.h.

◆ GetXUnit()

gcugtk::SpectrumDocument::GetXUnit ( void ) const

inline

Returns: the unit of the x-axis as gcu::SpectumUnitType, or GCU_SPECTRUM_UNIT_MAX.

Definition at line 390 of file spectrumdoc.h.

◆ GetYUnit()

gcugtk::SpectrumDocument::GetYUnit ( void ) const

inline

Returns: the unit of the y-axis as gcu::SpectumUnitType, or GCU_SPECTRUM_UNIT_MAX.

Definition at line 395 of file spectrumdoc.h.

◆ Load()

void gcugtk::SpectrumDocument::Load	(	char const *	uri,
		char const *	mime_type = `NULL`
	)

Parameters

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.

◆ Loaded()

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

virtual

Called by the application when the document has been loaded.

Reimplemented from gcu::Document.

◆ OnShowIntegral()

void gcugtk::SpectrumDocument::OnShowIntegral ( )

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

◆ OnTransformFID()

void gcugtk::SpectrumDocument::OnTransformFID ( GtkButton * btn )

Parameters

btn	the clicked GtkButton.

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

◆ OnXAxisInvert()

void gcugtk::SpectrumDocument::OnXAxisInvert ( bool inverted )

Parameters

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.

◆ OnXUnitChanged()

void gcugtk::SpectrumDocument::OnXUnitChanged ( int i )

Parameters

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.

◆ OnYUnitChanged()

void gcugtk::SpectrumDocument::OnYUnitChanged ( int i )

Parameters

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.

◆ SetProperty()

bool gcugtk::SpectrumDocument::SetProperty	(	unsigned	property,
		char const *	value
	)

virtual

Parameters

property	the property id as defined in objprops.h
value	the 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

◆ m_View

gcugtk::SpectrumDocument::m_View

protected

The SpectrumView instance associated with the document.

Definition at line 377 of file spectrumdoc.h.

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

spectrumdoc.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SpectrumDocument() [1/2]

◆ SpectrumDocument() [2/2]

◆ ~SpectrumDocument()

Member Function Documentation

◆ GetEmpty()

◆ GetIntegralVisible()

◆ GetSpectrumType()

◆ GetView()

◆ GetXUnit()

◆ GetYUnit()

◆ Load()

◆ Loaded()

◆ OnShowIntegral()

◆ OnTransformFID()

◆ OnXAxisInvert()

◆ OnXUnitChanged()

◆ OnYUnitChanged()

◆ SetProperty()

Member Data Documentation

◆ m_View