<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>The Gnome Chemistry Utils: gcuperiodic.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">The Gnome Chemistry Utils
 <span id="projectnumber">0.14.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6719ab1f1f7655efc2fa43f7eb574fd1.html">libs</a></li><li class="navelem"><a class="el" href="dir_9d0e2ffb2597f8e76985e7846c7e7149.html">gcugtk</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">gcuperiodic.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <gdk/gdk.h></code><br/>
<code>#include <gtk/gtk.h></code><br/>
</div>
<p><a href="gcuperiodic_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a55c1b2ea7aee6b3b475305663e97e0f8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#a55c1b2ea7aee6b3b475305663e97e0f8">GCU_TYPE_PERIODIC</a>   (<a class="el" href="gcuperiodic_8h.html#a83adf841ce94abcfe2a2c0cadc4f5b98">gcu_periodic_get_type</a> ())</td></tr>
<tr class="memitem:a7110dd5bb5bb7e9ea18fb6b60e696df9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#a7110dd5bb5bb7e9ea18fb6b60e696df9">GCU_PERIODIC</a>(obj)   (G_TYPE_CHECK_INSTANCE_CAST ((obj), <a class="el" href="gcuperiodic_8h.html#a55c1b2ea7aee6b3b475305663e97e0f8">GCU_TYPE_PERIODIC</a>, <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a>))</td></tr>
<tr class="memitem:a868379defe9d2c28ff00bc52241ba037"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#a868379defe9d2c28ff00bc52241ba037">GCU_PERIODIC_CLASS</a>(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), <a class="el" href="gcuperiodic_8h.html#a55c1b2ea7aee6b3b475305663e97e0f8">GCU_TYPE_PERIODIC</a>, <a class="el" href="gcuperiodic_8h.html#aababd3721ea1e383037179f956d4ef3e">GcuPeriodicClass</a>))</td></tr>
<tr class="memitem:a5b8667cb13d1c8cbf0d482be2416d4d3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#a5b8667cb13d1c8cbf0d482be2416d4d3">GCU_IS_PERIODIC</a>(obj)   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), <a class="el" href="gcuperiodic_8h.html#a55c1b2ea7aee6b3b475305663e97e0f8">GCU_TYPE_PERIODIC</a>))</td></tr>
<tr class="memitem:abf0054c8d21b0979644de0c9c39e9f66"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#abf0054c8d21b0979644de0c9c39e9f66">GCU_IS_PERIODIC_CLASS</a>(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), <a class="el" href="gcuperiodic_8h.html#a55c1b2ea7aee6b3b475305663e97e0f8">GCU_TYPE_PERIODIC</a>))</td></tr>
<tr class="memitem:abbf18c6627c7f34aa4f1cde79e2e09aa"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#abbf18c6627c7f34aa4f1cde79e2e09aa">GCU_PERIODIC_GET_CLASS</a>(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), <a class="el" href="gcuperiodic_8h.html#a55c1b2ea7aee6b3b475305663e97e0f8">GCU_TYPE_PERIODIC</a>, <a class="el" href="gcuperiodic_8h.html#aababd3721ea1e383037179f956d4ef3e">GcuPeriodicClass</a>))</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:af154d9d658c02d8e8650ab161ff1a365"><td class="memItemLeft" align="right" valign="top">typedef struct _GcuPeriodic </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#af154d9d658c02d8e8650ab161ff1a365">GcuPeriodic</a></td></tr>
<tr class="memitem:aababd3721ea1e383037179f956d4ef3e"><td class="memItemLeft" align="right" valign="top">typedef struct _GcuPeriodicClass </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#aababd3721ea1e383037179f956d4ef3e">GcuPeriodicClass</a></td></tr>
<tr class="memitem:a5a588c1bfa9bb57d5dc9321b012c00c1"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#a5a588c1bfa9bb57d5dc9321b012c00c1">GcuPeriodicColorFunc</a> )(int, GdkRGBA *, gpointer)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a63833ef26ba90242887c9804685fba0b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#a63833ef26ba90242887c9804685fba0b">GcuPeriodicColorSchemes</a> </td></tr>
<tr class="memitem:a25c0f4bf98503d7f336b234cddb6e29a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#a25c0f4bf98503d7f336b234cddb6e29a">GcuPeriodicTipSchemes</a> { <a class="el" href="gcuperiodic_8h.html#a25c0f4bf98503d7f336b234cddb6e29aaea8fa1f71afc9ccde1f0196959773999">GCU_PERIODIC_TIP_NAME</a>,
<a class="el" href="gcuperiodic_8h.html#a25c0f4bf98503d7f336b234cddb6e29aa3e2c506f85a00b401796b1ed388219ef">GCU_PERIODIC_TIP_STANDARD</a>
}</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a83adf841ce94abcfe2a2c0cadc4f5b98"><td class="memItemLeft" align="right" valign="top">GType </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#a83adf841ce94abcfe2a2c0cadc4f5b98">gcu_periodic_get_type</a> (void) G_GNUC_CONST</td></tr>
<tr class="memitem:aa6d9628e6de9c6fde4734e845872d07d"><td class="memItemLeft" align="right" valign="top">GtkWidget * </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#aa6d9628e6de9c6fde4734e845872d07d">gcu_periodic_new</a> (void)</td></tr>
<tr class="memitem:a35f51ff182ce53fbde184c218746be85"><td class="memItemLeft" align="right" valign="top">guint </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#a35f51ff182ce53fbde184c218746be85">gcu_periodic_get_element</a> (<a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> *periodic)</td></tr>
<tr class="memitem:aa4a64501b9acf86111a3830b1032e5db"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#aa4a64501b9acf86111a3830b1032e5db">gcu_periodic_set_element</a> (<a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> *periodic, guint element)</td></tr>
<tr class="memitem:af68fdbf8b352eb700c47d85fd6ed89db"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#af68fdbf8b352eb700c47d85fd6ed89db">gcu_periodic_add_color_scheme</a> (<a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> *periodic, <a class="el" href="gcuperiodic_8h.html#a5a588c1bfa9bb57d5dc9321b012c00c1">GcuPeriodicColorFunc</a> func, GtkWidget *extra_widget, gpointer user_data)</td></tr>
<tr class="memitem:a5ba1a3af4f7d1fc5165a33485d88b299"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#a5ba1a3af4f7d1fc5165a33485d88b299">gcu_periodic_set_colors</a> (<a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> *periodic)</td></tr>
<tr class="memitem:ac860ca3a0ea1d3a57278b60a2b7cf376"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="gcuperiodic_8h.html#ac860ca3a0ea1d3a57278b60a2b7cf376">gcu_periodic_set_tips</a> (<a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> *periodic, unsigned scheme)</td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Declaration of the <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> widget. </p>
<p>Definition in file <a class="el" href="gcuperiodic_8h_source.html">gcuperiodic.h</a>.</p>
</div><h2>Macro Definition Documentation</h2>
<a class="anchor" id="a5b8667cb13d1c8cbf0d482be2416d4d3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GCU_IS_PERIODIC</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">obj</td><td>)</td>
<td>   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), <a class="el" href="gcuperiodic_8h.html#a55c1b2ea7aee6b3b475305663e97e0f8">GCU_TYPE_PERIODIC</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>TRUE if <em>obj</em> points to a <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> widget, FALSE otherwise. </dd></dl>
<p>Definition at line <a class="el" href="gcuperiodic_8h_source.html#l00082">82</a> of file <a class="el" href="gcuperiodic_8h_source.html">gcuperiodic.h</a>.</p>
<p>Referenced by <a class="el" href="gcuperiodic_8c_source.html#l00317">gcu_periodic_get_element()</a>, and <a class="el" href="gcuperiodic_8c_source.html#l00323">gcu_periodic_set_element()</a>.</p>
</div>
</div>
<a class="anchor" id="abf0054c8d21b0979644de0c9c39e9f66"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GCU_IS_PERIODIC_CLASS</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">klass</td><td>)</td>
<td>   (G_TYPE_CHECK_CLASS_TYPE ((klass), <a class="el" href="gcuperiodic_8h.html#a55c1b2ea7aee6b3b475305663e97e0f8">GCU_TYPE_PERIODIC</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>TRUE if <em>klass</em> points to a GcuPeriodicClass, FALSE otherwise. </dd></dl>
<p>Definition at line <a class="el" href="gcuperiodic_8h_source.html#l00086">86</a> of file <a class="el" href="gcuperiodic_8h_source.html">gcuperiodic.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7110dd5bb5bb7e9ea18fb6b60e696df9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GCU_PERIODIC</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">obj</td><td>)</td>
<td>   (G_TYPE_CHECK_INSTANCE_CAST ((obj), <a class="el" href="gcuperiodic_8h.html#a55c1b2ea7aee6b3b475305663e97e0f8">GCU_TYPE_PERIODIC</a>, <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Casts <em>obj</em> to a <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> * pointer. </p>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> * or NULL if <em>obj</em> does not point to a <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> widget. </dd></dl>
<p>Definition at line <a class="el" href="gcuperiodic_8h_source.html#l00073">73</a> of file <a class="el" href="gcuperiodic_8h_source.html">gcuperiodic.h</a>.</p>
<p>Referenced by <a class="el" href="gcucomboperiodic_8c_source.html#l00121">gcu_combo_periodic_get_element()</a>, <a class="el" href="gcucomboperiodic_8c_source.html#l00126">gcu_combo_periodic_set_element()</a>, and <a class="el" href="testgcuperiodic_8c_source.html#l00066">main()</a>.</p>
</div>
</div>
<a class="anchor" id="a868379defe9d2c28ff00bc52241ba037"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GCU_PERIODIC_CLASS</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">klass</td><td>)</td>
<td>   (G_TYPE_CHECK_CLASS_CAST ((klass), <a class="el" href="gcuperiodic_8h.html#a55c1b2ea7aee6b3b475305663e97e0f8">GCU_TYPE_PERIODIC</a>, <a class="el" href="gcuperiodic_8h.html#aababd3721ea1e383037179f956d4ef3e">GcuPeriodicClass</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Casts <em>klass</em> to a GcuPeriodicClass * pointer. </p>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the GcuPeriodicClass * or NULL if <em>obj</em> not point to a GcuPeriodicClass. </dd></dl>
<p>Definition at line <a class="el" href="gcuperiodic_8h_source.html#l00078">78</a> of file <a class="el" href="gcuperiodic_8h_source.html">gcuperiodic.h</a>.</p>
</div>
</div>
<a class="anchor" id="abbf18c6627c7f34aa4f1cde79e2e09aa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GCU_PERIODIC_GET_CLASS</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">obj</td><td>)</td>
<td>   (G_TYPE_INSTANCE_GET_CLASS ((obj), <a class="el" href="gcuperiodic_8h.html#a55c1b2ea7aee6b3b475305663e97e0f8">GCU_TYPE_PERIODIC</a>, <a class="el" href="gcuperiodic_8h.html#aababd3721ea1e383037179f956d4ef3e">GcuPeriodicClass</a>))</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the GcuPeriodicClass * associated to <em>obj</em> if obj points to a <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> widget, NULL otherwise. </dd></dl>
<p>Definition at line <a class="el" href="gcuperiodic_8h_source.html#l00091">91</a> of file <a class="el" href="gcuperiodic_8h_source.html">gcuperiodic.h</a>.</p>
</div>
</div>
<a class="anchor" id="a55c1b2ea7aee6b3b475305663e97e0f8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GCU_TYPE_PERIODIC   (<a class="el" href="gcuperiodic_8h.html#a83adf841ce94abcfe2a2c0cadc4f5b98">gcu_periodic_get_type</a> ())</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the GType associated to <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> </dd></dl>
<p>Definition at line <a class="el" href="gcuperiodic_8h_source.html#l00067">67</a> of file <a class="el" href="gcuperiodic_8h_source.html">gcuperiodic.h</a>.</p>
</div>
</div>
<h2>Typedef Documentation</h2>
<a class="anchor" id="af154d9d658c02d8e8650ab161ff1a365"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct _GcuPeriodic <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> widget. </p>
<p>Definition at line <a class="el" href="gcuperiodic_8h_source.html#l00094">94</a> of file <a class="el" href="gcuperiodic_8h_source.html">gcuperiodic.h</a>.</p>
</div>
</div>
<a class="anchor" id="aababd3721ea1e383037179f956d4ef3e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct _GcuPeriodicClass <a class="el" href="gcuperiodic_8h.html#aababd3721ea1e383037179f956d4ef3e">GcuPeriodicClass</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> widget object class. </p>
<p>Definition at line <a class="el" href="gcuperiodic_8h_source.html#l00096">96</a> of file <a class="el" href="gcuperiodic_8h_source.html">gcuperiodic.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5a588c1bfa9bb57d5dc9321b012c00c1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* GcuPeriodicColorFunc)(int, GdkRGBA *, gpointer)</td>
</tr>
</table>
</div><div class="memdoc">
<p>The callback used for color schemes. It takes three arguments: </p>
<ul>
<li>the atomic number Z. </li>
<li>a pointer to the GdkColor structure to be filled by the callback </li>
<li>a pointer to user's data. </li>
</ul>
<p>Definition at line <a class="el" href="gcuperiodic_8h_source.html#l00140">140</a> of file <a class="el" href="gcuperiodic_8h_source.html">gcuperiodic.h</a>.</p>
</div>
</div>
<h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a63833ef26ba90242887c9804685fba0b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="gcuperiodic_8h.html#a63833ef26ba90242887c9804685fba0b">GcuPeriodicColorSchemes</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Predefined coloring scheme used for the buttons when displaying the periodic table of the <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> widget. Possible values are:</p>
<ul>
<li>GCU_PERIODIC_COLOR_NONE: the default Gtk theme is used.</li>
<li>GCU_PERIODIC_COLOR_DEFAULT: the default color for each element is used as returned by gcu_element_get_default_color. Other values can be added using gcu_periodic_add_color_scheme. </li>
</ul>
<p>Definition at line <a class="el" href="gcuperiodic_8h_source.html#l00043">43</a> of file <a class="el" href="gcuperiodic_8h_source.html">gcuperiodic.h</a>.</p>
</div>
</div>
<a class="anchor" id="a25c0f4bf98503d7f336b234cddb6e29a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="gcuperiodic_8h.html#a25c0f4bf98503d7f336b234cddb6e29a">GcuPeriodicTipSchemes</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Predefined tipsg scheme used when the mouse cursor is over an element button. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a25c0f4bf98503d7f336b234cddb6e29aaea8fa1f71afc9ccde1f0196959773999"></a>GCU_PERIODIC_TIP_NAME</em> </td><td>
<p>Show the element name in the tips popup. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a25c0f4bf98503d7f336b234cddb6e29aa3e2c506f85a00b401796b1ed388219ef"></a>GCU_PERIODIC_TIP_STANDARD</em> </td><td>
<p>Show the element atomic number, symbol, name, electronic configuration, and atomic weight. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="gcuperiodic_8h_source.html#l00053">53</a> of file <a class="el" href="gcuperiodic_8h_source.html">gcuperiodic.h</a>.</p>
</div>
</div>
<h2>Function Documentation</h2>
<a class="anchor" id="af68fdbf8b352eb700c47d85fd6ed89db"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gcu_periodic_add_color_scheme </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> * </td>
<td class="paramname"><em>periodic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="gcuperiodic_8h.html#a5a588c1bfa9bb57d5dc9321b012c00c1">GcuPeriodicColorFunc</a> </td>
<td class="paramname"><em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">GtkWidget * </td>
<td class="paramname"><em>extra_widget</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gpointer </td>
<td class="paramname"><em>user_data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">periodic</td><td>a <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> widget. </td></tr>
<tr><td class="paramname">func</td><td>the callback used to get the color for an element in the new color scheme. </td></tr>
<tr><td class="paramname">extra_widget</td><td>a widget to be added as a child of <em>periodic</em>. </td></tr>
<tr><td class="paramname">user_data</td><td>data to be passed to the <em>func</em> callback.</td></tr>
</table>
</dd>
</dl>
<p>Using this function and the appropriate callback, the color used for the elements buttons can be changed to depend on any property of the elements. </p>
<dl class="section return"><dt>Returns</dt><dd>the identifier of the new color scheme. </dd></dl>
<p>Definition at line <a class="el" href="gcuperiodic_8c_source.html#l00399">399</a> of file <a class="el" href="gcuperiodic_8c_source.html">gcuperiodic.c</a>.</p>
</div>
</div>
<a class="anchor" id="a35f51ff182ce53fbde184c218746be85"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">guint gcu_periodic_get_element </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> * </td>
<td class="paramname"><em>periodic</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gcu_periodic_get_element: </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">periodic</td><td>a <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> widget</td></tr>
</table>
</dd>
</dl>
<p>Description: used to get the currently selected element in the periodic table.</p>
<p>Returns: the atomic number of the currently selected element or %0 if none is selected. </p>
<p>Definition at line <a class="el" href="gcuperiodic_8c_source.html#l00317">317</a> of file <a class="el" href="gcuperiodic_8c_source.html">gcuperiodic.c</a>.</p>
<p>References <a class="el" href="gcuperiodic_8h_source.html#l00082">GCU_IS_PERIODIC</a>.</p>
</div>
</div>
<a class="anchor" id="a83adf841ce94abcfe2a2c0cadc4f5b98"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GType gcu_periodic_get_type </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the GType associated to <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa6d9628e6de9c6fde4734e845872d07d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkWidget* gcu_periodic_new </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>a new <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> </dd></dl>
<p>Referenced by <a class="el" href="testgcuperiodic_8c_source.html#l00066">main()</a>.</p>
</div>
</div>
<a class="anchor" id="a5ba1a3af4f7d1fc5165a33485d88b299"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcu_periodic_set_colors </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> * </td>
<td class="paramname"><em>periodic</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">periodic</td><td>a <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> widget.</td></tr>
</table>
</dd>
</dl>
<p>Forces the update of the current color scheme. This is useful when the color scheme depends upon a parameter which has changed. </p>
<p>Definition at line <a class="el" href="gcuperiodic_8c_source.html#l00340">340</a> of file <a class="el" href="gcuperiodic_8c_source.html">gcuperiodic.c</a>.</p>
<p>References <a class="el" href="chemistry_8h.html#a401cb383e489bfeb166dda46a3256320">gcu_element_get_default_color()</a>.</p>
</div>
</div>
<a class="anchor" id="aa4a64501b9acf86111a3830b1032e5db"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcu_periodic_set_element </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> * </td>
<td class="paramname"><em>periodic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">guint </td>
<td class="paramname"><em>element</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>gcu_periodic_set_element: </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">periodic</td><td>a <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> widget </td></tr>
<tr><td class="paramname">element</td><td>the atomic number of the element to select or 0</td></tr>
</table>
</dd>
</dl>
<p>Description: sets the selected element in the periodic table. </p>
<p>Definition at line <a class="el" href="gcuperiodic_8c_source.html#l00323">323</a> of file <a class="el" href="gcuperiodic_8c_source.html">gcuperiodic.c</a>.</p>
<p>References <a class="el" href="gcuperiodic_8h_source.html#l00082">GCU_IS_PERIODIC</a>.</p>
</div>
</div>
<a class="anchor" id="ac860ca3a0ea1d3a57278b60a2b7cf376"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcu_periodic_set_tips </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> * </td>
<td class="paramname"><em>periodic</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>scheme</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">periodic</td><td>a <a class="el" href="structGcuPeriodic.html">GcuPeriodic</a> widget. </td></tr>
<tr><td class="paramname">scheme</td><td>a tips scheme identifier.</td></tr>
</table>
</dd>
</dl>
<p>Configures the element buttons tips. <em>scheme</em> must be one of the values defined in the GcuPeriodicTipSchemes enum. </p>
<p>Definition at line <a class="el" href="gcuperiodic_8c_source.html#l00413">413</a> of file <a class="el" href="gcuperiodic_8c_source.html">gcuperiodic.c</a>.</p>
<p>References <a class="el" href="chemistry_8h.html#a31857e24f0d14cd75ea419f75f412d65">gcu_element_get_electronic_configuration()</a>, <a class="el" href="chemistry_8h.html#a76dce0fd30dcae4120e124c03a9ea457">gcu_element_get_name()</a>, <a class="el" href="chemistry_8h.html#a4f87dfa17437dc175581d1a617e2caee">gcu_element_get_symbol()</a>, <a class="el" href="chemistry_8h.html#aa1ed00303ca527984d1253208960199c">gcu_element_get_weight_as_string()</a>, <a class="el" href="gcuperiodic_8h_source.html#l00058">GCU_PERIODIC_TIP_NAME</a>, and <a class="el" href="gcuperiodic_8h_source.html#l00063">GCU_PERIODIC_TIP_STANDARD</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 14 2013 17:34:28 for The Gnome Chemistry Utils by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1.2
</small></address>
</body>
</html>
