<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>The Gnome Chemistry Utils: gcu::SpectrumDocument Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespacegcu.html">gcu</a>::<a class="el" href="classgcu_1_1SpectrumDocument.html">SpectrumDocument</a> </div> </div> <div class="contents"> <h1>gcu::SpectrumDocument Class Reference</h1><!-- doxytag: class="gcu::SpectrumDocument" --><!-- doxytag: inherits="gcu::Document,gcu::Printable" --> <p><code>#include <<a class="el" href="spectrumdoc_8h_source.html">gcu/spectrumdoc.h</a>></code></p> <div class="dynheader"> Inheritance diagram for gcu::SpectrumDocument:</div> <div class="dynsection"> <div class="center"> <img src="classgcu_1_1SpectrumDocument.gif" usemap="#gcu::SpectrumDocument_map" alt=""/> <map id="gcu::SpectrumDocument_map" name="gcu::SpectrumDocument_map"> <area href="classgcu_1_1Document.html" alt="gcu::Document" shape="rect" coords="79,56,227,80"/> <area href="classgcu_1_1Printable.html" alt="gcu::Printable" shape="rect" coords="316,56,464,80"/> <area href="classgcu_1_1Object.html" alt="gcu::Object" shape="rect" coords="0,0,148,24"/> <area href="classgcu_1_1DialogOwner.html" alt="gcu::DialogOwner" shape="rect" coords="158,0,306,24"/> <area href="classgcu_1_1DialogOwner.html" alt="gcu::DialogOwner" shape="rect" coords="316,0,464,24"/> </map> </div> </div> <p><a href="classgcu_1_1SpectrumDocument-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#aede9f218a48a597198a700c365cb45c9">SpectrumDocument</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#a77393ef8a3e41487975428770a6e538a">SpectrumDocument</a> (<a class="el" href="classgcu_1_1Application.html">Application</a> *app, <a class="el" href="classgcu_1_1SpectrumView.html">SpectrumView</a> *view=NULL)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#a2ba0b084789fc5899c096835c8f3bb0f">~SpectrumDocument</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#a8f0307776ff3648020e6ae4617035f6e">Load</a> (char const *uri, char const *mime_type=NULL)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#a65470df2c4afebfb158f0e8aad1d3149">OnXUnitChanged</a> (int i)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#a838d6437c3ee6f9799f8f17de9fa9b2a">OnYUnitChanged</a> (int i)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#a28ebd003f3693db706f3ee9572601cef">OnXAxisInvert</a> (bool inverted)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#abb45e9430ff51069482041aac9393097">OnShowIntegral</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#ae227aa5890ec8010d529a13fb81e1f1e">OnTransformFID</a> (GtkButton *btn)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcu_1_1SpectrumView.html">SpectrumView</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#a2ec256065fc0a7f15ac3f72756c0dd38">GetView</a> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#a98c6546d8ad295e0f176c28178b7efca">GetEmpty</a> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegcu.html#aa14418f1622fbe189b5561453b6b279d">SpectrumType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#a3aa9ec5f715a7d6e70a6be9a20908989">GetSpectrumType</a> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegcu.html#a9adc7ab242a5df784fd11a569f6467f8">SpectrumUnitType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#a840a9dce0c6e909d2130a718bf2d4abb">GetXUnit</a> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegcu.html#a9adc7ab242a5df784fd11a569f6467f8">SpectrumUnitType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#a6c681c8867717a3ea51553ff9824da2e">GetYUnit</a> (void)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#a7e5c3bd5d155d52650af00f18c40e1bb">GetIntegralVisible</a> (void)</td></tr> <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcu_1_1SpectrumView.html">SpectrumView</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1SpectrumDocument.html#ad9ab27216cbbb7717d7518b28e9ecfd6">m_View</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>The document class used for spectra. This API is still quite unstable and might change in the future. </p> <p>Definition at line <a class="el" href="spectrumdoc_8h_source.html#l00273">273</a> of file <a class="el" href="spectrumdoc_8h_source.html">spectrumdoc.h</a>.</p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aede9f218a48a597198a700c365cb45c9"></a><!-- doxytag: member="gcu::SpectrumDocument::SpectrumDocument" ref="aede9f218a48a597198a700c365cb45c9" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gcu::SpectrumDocument::SpectrumDocument </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Default constructor </p> </div> </div> <a class="anchor" id="a77393ef8a3e41487975428770a6e538a"></a><!-- doxytag: member="gcu::SpectrumDocument::SpectrumDocument" ref="a77393ef8a3e41487975428770a6e538a" args="(Application *app, SpectrumView *view=NULL)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gcu::SpectrumDocument::SpectrumDocument </td> <td>(</td> <td class="paramtype"><a class="el" href="classgcu_1_1Application.html">Application</a> * </td> <td class="paramname"> <em>app</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classgcu_1_1SpectrumView.html">SpectrumView</a> * </td> <td class="paramname"> <em>view</em> = <code>NULL</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>app</em> </td><td>the application. </td></tr> <tr><td valign="top"></td><td valign="top"><em>view</em> </td><td>an optional already existing <a class="el" href="classgcu_1_1SpectrumView.html">SpectrumView</a> instance. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a2ba0b084789fc5899c096835c8f3bb0f"></a><!-- doxytag: member="gcu::SpectrumDocument::~SpectrumDocument" ref="a2ba0b084789fc5899c096835c8f3bb0f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gcu::SpectrumDocument::~SpectrumDocument </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Default destructor </p> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a98c6546d8ad295e0f176c28178b7efca"></a><!-- doxytag: member="gcu::SpectrumDocument::GetEmpty" ref="a98c6546d8ad295e0f176c28178b7efca" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gcu::SpectrumDocument::GetEmpty </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>true if the document does not have any data, false otherwise. </dd></dl> <p>Definition at line <a class="el" href="spectrumdoc_8h_source.html#l00370">370</a> of file <a class="el" href="spectrumdoc_8h_source.html">spectrumdoc.h</a>.</p> </div> </div> <a class="anchor" id="a7e5c3bd5d155d52650af00f18c40e1bb"></a><!-- doxytag: member="gcu::SpectrumDocument::GetIntegralVisible" ref="a7e5c3bd5d155d52650af00f18c40e1bb" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gcu::SpectrumDocument::GetIntegralVisible </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>true if the integral of an NMR spectrum is visible, false in all other cases. </dd></dl> <p>Definition at line <a class="el" href="spectrumdoc_8h_source.html#l00389">389</a> of file <a class="el" href="spectrumdoc_8h_source.html">spectrumdoc.h</a>.</p> </div> </div> <a class="anchor" id="a3aa9ec5f715a7d6e70a6be9a20908989"></a><!-- doxytag: member="gcu::SpectrumDocument::GetSpectrumType" ref="a3aa9ec5f715a7d6e70a6be9a20908989" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gcu::SpectrumDocument::GetSpectrumType </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>the <a class="el" href="namespacegcu.html#aa14418f1622fbe189b5561453b6b279d">gcu::SpectrumType</a> of the document, or GCU_SPECTRUM_TYPE_MAX. </dd></dl> <p>Definition at line <a class="el" href="spectrumdoc_8h_source.html#l00374">374</a> of file <a class="el" href="spectrumdoc_8h_source.html">spectrumdoc.h</a>.</p> </div> </div> <a class="anchor" id="a2ec256065fc0a7f15ac3f72756c0dd38"></a><!-- doxytag: member="gcu::SpectrumDocument::GetView" ref="a2ec256065fc0a7f15ac3f72756c0dd38" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gcu::SpectrumDocument::GetView </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>the <a class="el" href="classgcu_1_1SpectrumView.html">SpectrumView</a> instance associated with the document. </dd></dl> <p>Definition at line <a class="el" href="spectrumdoc_8h_source.html#l00366">366</a> of file <a class="el" href="spectrumdoc_8h_source.html">spectrumdoc.h</a>.</p> </div> </div> <a class="anchor" id="a840a9dce0c6e909d2130a718bf2d4abb"></a><!-- doxytag: member="gcu::SpectrumDocument::GetXUnit" ref="a840a9dce0c6e909d2130a718bf2d4abb" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gcu::SpectrumDocument::GetXUnit </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>the unit of the x-axis as gcu::SpectumUnitType, or GCU_SPECTRUM_UNIT_MAX. </dd></dl> <p>Definition at line <a class="el" href="spectrumdoc_8h_source.html#l00379">379</a> of file <a class="el" href="spectrumdoc_8h_source.html">spectrumdoc.h</a>.</p> </div> </div> <a class="anchor" id="a6c681c8867717a3ea51553ff9824da2e"></a><!-- doxytag: member="gcu::SpectrumDocument::GetYUnit" ref="a6c681c8867717a3ea51553ff9824da2e" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gcu::SpectrumDocument::GetYUnit </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <dl class="return"><dt><b>Returns:</b></dt><dd>the unit of the y-axis as gcu::SpectumUnitType, or GCU_SPECTRUM_UNIT_MAX. </dd></dl> <p>Definition at line <a class="el" href="spectrumdoc_8h_source.html#l00384">384</a> of file <a class="el" href="spectrumdoc_8h_source.html">spectrumdoc.h</a>.</p> </div> </div> <a class="anchor" id="a8f0307776ff3648020e6ae4617035f6e"></a><!-- doxytag: member="gcu::SpectrumDocument::Load" ref="a8f0307776ff3648020e6ae4617035f6e" args="(char const *uri, char const *mime_type=NULL)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gcu::SpectrumDocument::Load </td> <td>(</td> <td class="paramtype">char const * </td> <td class="paramname"> <em>uri</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char const * </td> <td class="paramname"> <em>mime_type</em> = <code>NULL</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>uri</em> </td><td>the uri of the spectrum file. </td></tr> <tr><td valign="top"></td><td valign="top"><em>mime_type</em> </td><td>the mime type of the spectrum file.</td></tr> </table> </dd> </dl> <p>Loads a spaectrum from the provided uri. Default mime type is NULL, "chemical/x-jcamp-dx" is the only one supported at the moment. </p> </div> </div> <a class="anchor" id="abb45e9430ff51069482041aac9393097"></a><!-- doxytag: member="gcu::SpectrumDocument::OnShowIntegral" ref="abb45e9430ff51069482041aac9393097" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gcu::SpectrumDocument::OnShowIntegral </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Used to show or hide the integral curve for an NMR spectrum. </p> </div> </div> <a class="anchor" id="ae227aa5890ec8010d529a13fb81e1f1e"></a><!-- doxytag: member="gcu::SpectrumDocument::OnTransformFID" ref="ae227aa5890ec8010d529a13fb81e1f1e" args="(GtkButton *btn)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gcu::SpectrumDocument::OnTransformFID </td> <td>(</td> <td class="paramtype">GtkButton * </td> <td class="paramname"> <em>btn</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>btn</em> </td><td>the clicked GtkButton.</td></tr> </table> </dd> </dl> <p>Called to transform an FID to the NMR spectrum. The label in the GtkButton might be changed. </p> </div> </div> <a class="anchor" id="a28ebd003f3693db706f3ee9572601cef"></a><!-- doxytag: member="gcu::SpectrumDocument::OnXAxisInvert" ref="a28ebd003f3693db706f3ee9572601cef" args="(bool inverted)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gcu::SpectrumDocument::OnXAxisInvert </td> <td>(</td> <td class="paramtype">bool </td> <td class="paramname"> <em>inverted</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>inverted</em> </td><td>whether to invert the X axis scale.</td></tr> </table> </dd> </dl> <p>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. </p> </div> </div> <a class="anchor" id="a65470df2c4afebfb158f0e8aad1d3149"></a><!-- doxytag: member="gcu::SpectrumDocument::OnXUnitChanged" ref="a65470df2c4afebfb158f0e8aad1d3149" args="(int i)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gcu::SpectrumDocument::OnXUnitChanged </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>i</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>the rank of the unit to set.</td></tr> </table> </dd> </dl> <p>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. </p> </div> </div> <a class="anchor" id="a838d6437c3ee6f9799f8f17de9fa9b2a"></a><!-- doxytag: member="gcu::SpectrumDocument::OnYUnitChanged" ref="a838d6437c3ee6f9799f8f17de9fa9b2a" args="(int i)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gcu::SpectrumDocument::OnYUnitChanged </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>i</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>i</em> </td><td>the rank of the unit to set.</td></tr> </table> </dd> </dl> <p>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. </p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="ad9ab27216cbbb7717d7518b28e9ecfd6"></a><!-- doxytag: member="gcu::SpectrumDocument::m_View" ref="ad9ab27216cbbb7717d7518b28e9ecfd6" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classgcu_1_1SpectrumDocument.html#ad9ab27216cbbb7717d7518b28e9ecfd6">gcu::SpectrumDocument::m_View</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>The <a class="el" href="classgcu_1_1SpectrumView.html">SpectrumView</a> instance associated with the document. </p> <p>Definition at line <a class="el" href="spectrumdoc_8h_source.html#l00366">366</a> of file <a class="el" href="spectrumdoc_8h_source.html">spectrumdoc.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="spectrumdoc_8h_source.html">spectrumdoc.h</a></li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 6 18:33:56 2009 for The Gnome Chemistry Utils by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>