Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > f37f2c0b149d5391818dc5157943cda0 > files > 74

gnome-chemistry-utils-devel-0.10.8-3mdv2010.0.i586.rpm

<!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: gcp::MesomeryArrow 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespacegcp.html">gcp</a>::<a class="el" href="classgcp_1_1MesomeryArrow.html">MesomeryArrow</a>
  </div>
</div>
<div class="contents">
<h1>gcp::MesomeryArrow Class Reference</h1><!-- doxytag: class="gcp::MesomeryArrow" --><!-- doxytag: inherits="gcp::Arrow" -->
<p><code>#include &lt;<a class="el" href="mesomery-arrow_8h_source.html">gcp/mesomery-arrow.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gcp::MesomeryArrow:</div>
<div class="dynsection">
 <div class="center">
  <img src="classgcp_1_1MesomeryArrow.gif" usemap="#gcp::MesomeryArrow_map" alt=""/>
  <map id="gcp::MesomeryArrow_map" name="gcp::MesomeryArrow_map">
<area href="classgcp_1_1Arrow.html" alt="gcp::Arrow" shape="rect" coords="0,56,133,80"/>
<area href="classgcu_1_1Object.html" alt="gcu::Object" shape="rect" coords="0,0,133,24"/>
</map>
 </div>
</div>

<p><a href="classgcp_1_1MesomeryArrow-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1MesomeryArrow.html#aaa7ccf099efc070c8ac5eb3d187e1670">MesomeryArrow</a> (<a class="el" href="classgcp_1_1Mesomery.html">Mesomery</a> *mesomery)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1MesomeryArrow.html#a926130bad9336052fbc0d5fe713f26e8">~MesomeryArrow</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">xmlNodePtr&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1MesomeryArrow.html#ad823b1b976d6c12c6e6854096cafd228">Save</a> (xmlDocPtr xml) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1MesomeryArrow.html#a286cd6ad058bb8622cd27dd2cd850e48">Load</a> (xmlNodePtr node)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1MesomeryArrow.html#a76eae9987144cef8301ff6a25f9bea8a">Add</a> (GtkWidget *w) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1MesomeryArrow.html#a619640b46d2f1425dd52dc137e053e64">Update</a> (GtkWidget *w) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1MesomeryArrow.html#a52bd448da9622a0d0a6ef227fcb924fe">SetStartMesomer</a> (<a class="el" href="classgcp_1_1Mesomer.html">Mesomer</a> *mesomer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcp_1_1Mesomer.html">Mesomer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1MesomeryArrow.html#ab9a63f075badd8f51bc98eeef08dddc1">GetStartMesomer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1MesomeryArrow.html#a98773ffe0f9800a7d32f36ee85690702">SetEndMesomer</a> (<a class="el" href="classgcp_1_1Mesomer.html">Mesomer</a> *mesomer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcp_1_1Mesomer.html">Mesomer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1MesomeryArrow.html#ae98c61fc409445d09f5f77859836488a">GetEndMesomer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1MesomeryArrow.html#aebd3a53e26d024a870c7bef5cd87d590">Reverse</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classgcp_1_1Arrow.html">Arrow</a> class for double headed arrows used in mesomery relationships. </p>

<p>Definition at line <a class="el" href="mesomery-arrow_8h_source.html#l00038">38</a> of file <a class="el" href="mesomery-arrow_8h_source.html">mesomery-arrow.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aaa7ccf099efc070c8ac5eb3d187e1670"></a><!-- doxytag: member="gcp::MesomeryArrow::MesomeryArrow" ref="aaa7ccf099efc070c8ac5eb3d187e1670" args="(Mesomery *mesomery)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gcp::MesomeryArrow::MesomeryArrow </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgcp_1_1Mesomery.html">Mesomery</a> *&nbsp;</td>
          <td class="paramname"> <em>mesomery</em></td>
          <td>&nbsp;)&nbsp;</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>mesomery</em>&nbsp;</td><td>the parent mesomery relationship if any.</td></tr>
  </table>
  </dd>
</dl>
<p>Constructs a mesomery arrow. If <em>mesomery</em> is not NULL, the arrow becomes is added to its children list. </p>

</div>
</div>
<a class="anchor" id="a926130bad9336052fbc0d5fe713f26e8"></a><!-- doxytag: member="gcp::MesomeryArrow::~MesomeryArrow" ref="a926130bad9336052fbc0d5fe713f26e8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual gcp::MesomeryArrow::~MesomeryArrow </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The destructor. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a76eae9987144cef8301ff6a25f9bea8a"></a><!-- doxytag: member="gcp::MesomeryArrow::Add" ref="a76eae9987144cef8301ff6a25f9bea8a" args="(GtkWidget *w) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gcp::MesomeryArrow::Add </td>
          <td>(</td>
          <td class="paramtype">GtkWidget *&nbsp;</td>
          <td class="paramname"> <em>w</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></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>w</em>&nbsp;</td><td>the GtkWidget inside which the arrow will be displayed.</td></tr>
  </table>
  </dd>
</dl>
<p>Used to add a representation of the arrow in the widget. </p>

<p>Reimplemented from <a class="el" href="classgcu_1_1Object.html#afcd1e6f8bc15be563bd33429757d9d21">gcu::Object</a>.</p>

</div>
</div>
<a class="anchor" id="ae98c61fc409445d09f5f77859836488a"></a><!-- doxytag: member="gcp::MesomeryArrow::GetEndMesomer" ref="ae98c61fc409445d09f5f77859836488a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classgcp_1_1Mesomer.html">Mesomer</a>* gcp::MesomeryArrow::GetEndMesomer </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the mesomer at last end of the arrow. </dd></dl>

<p>Definition at line <a class="el" href="mesomery-arrow_8h_source.html#l00100">100</a> of file <a class="el" href="mesomery-arrow_8h_source.html">mesomery-arrow.h</a>.</p>

</div>
</div>
<a class="anchor" id="ab9a63f075badd8f51bc98eeef08dddc1"></a><!-- doxytag: member="gcp::MesomeryArrow::GetStartMesomer" ref="ab9a63f075badd8f51bc98eeef08dddc1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classgcp_1_1Mesomer.html">Mesomer</a>* gcp::MesomeryArrow::GetStartMesomer </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the mesomer at first end of the arrow. </dd></dl>

<p>Definition at line <a class="el" href="mesomery-arrow_8h_source.html#l00089">89</a> of file <a class="el" href="mesomery-arrow_8h_source.html">mesomery-arrow.h</a>.</p>

</div>
</div>
<a class="anchor" id="a286cd6ad058bb8622cd27dd2cd850e48"></a><!-- doxytag: member="gcp::MesomeryArrow::Load" ref="a286cd6ad058bb8622cd27dd2cd850e48" args="(xmlNodePtr node)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool gcp::MesomeryArrow::Load </td>
          <td>(</td>
          <td class="paramtype">xmlNodePtr&nbsp;</td>
          <td class="paramname"> <em>node</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></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>node,:</em>&nbsp;</td><td>a pointer to the xmlNode containing the serialized arrow.</td></tr>
  </table>
  </dd>
</dl>
<p>Used to load an arrow in memory. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on succes, false otherwise. </dd></dl>

<p>Reimplemented from <a class="el" href="classgcp_1_1Arrow.html#a35982ed701601f54af6e6632229b2216">gcp::Arrow</a>.</p>

</div>
</div>
<a class="anchor" id="aebd3a53e26d024a870c7bef5cd87d590"></a><!-- doxytag: member="gcp::MesomeryArrow::Reverse" ref="aebd3a53e26d024a870c7bef5cd87d590" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gcp::MesomeryArrow::Reverse </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Exchange both ends or the arrow and their associated mesomers. </p>

</div>
</div>
<a class="anchor" id="ad823b1b976d6c12c6e6854096cafd228"></a><!-- doxytag: member="gcp::MesomeryArrow::Save" ref="ad823b1b976d6c12c6e6854096cafd228" args="(xmlDocPtr xml) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">xmlNodePtr gcp::MesomeryArrow::Save </td>
          <td>(</td>
          <td class="paramtype">xmlDocPtr&nbsp;</td>
          <td class="paramname"> <em>xml</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></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>xml</em>&nbsp;</td><td>the xmlDoc used to save the document.</td></tr>
  </table>
  </dd>
</dl>
<p>Used to save the arrow to the xmlDoc. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the xmlNode containing the serialized arrow. </dd></dl>

<p>Reimplemented from <a class="el" href="classgcu_1_1Object.html#aad462441e79fbd93e158f8294a198d11">gcu::Object</a>.</p>

</div>
</div>
<a class="anchor" id="a98773ffe0f9800a7d32f36ee85690702"></a><!-- doxytag: member="gcp::MesomeryArrow::SetEndMesomer" ref="a98773ffe0f9800a7d32f36ee85690702" args="(Mesomer *mesomer)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gcp::MesomeryArrow::SetEndMesomer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgcp_1_1Mesomer.html">Mesomer</a> *&nbsp;</td>
          <td class="paramname"> <em>mesomer</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></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>mesomer</em>&nbsp;</td><td>a mesomer</td></tr>
  </table>
  </dd>
</dl>
<p>Sets <em>mesomer</em> at last end of the arrow. This does not affect coordinates, alignment is dealt with elsewhere. </p>

<p>Definition at line <a class="el" href="mesomery-arrow_8h_source.html#l00096">96</a> of file <a class="el" href="mesomery-arrow_8h_source.html">mesomery-arrow.h</a>.</p>

</div>
</div>
<a class="anchor" id="a52bd448da9622a0d0a6ef227fcb924fe"></a><!-- doxytag: member="gcp::MesomeryArrow::SetStartMesomer" ref="a52bd448da9622a0d0a6ef227fcb924fe" args="(Mesomer *mesomer)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gcp::MesomeryArrow::SetStartMesomer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgcp_1_1Mesomer.html">Mesomer</a> *&nbsp;</td>
          <td class="paramname"> <em>mesomer</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></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>mesomer</em>&nbsp;</td><td>a mesomer</td></tr>
  </table>
  </dd>
</dl>
<p>Sets <em>mesomer</em> at first end of the arrow. This does not affect coordinates, alignment is dealt with elsewhere. </p>

<p>Definition at line <a class="el" href="mesomery-arrow_8h_source.html#l00085">85</a> of file <a class="el" href="mesomery-arrow_8h_source.html">mesomery-arrow.h</a>.</p>

</div>
</div>
<a class="anchor" id="a619640b46d2f1425dd52dc137e053e64"></a><!-- doxytag: member="gcp::MesomeryArrow::Update" ref="a619640b46d2f1425dd52dc137e053e64" args="(GtkWidget *w) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gcp::MesomeryArrow::Update </td>
          <td>(</td>
          <td class="paramtype">GtkWidget *&nbsp;</td>
          <td class="paramname"> <em>w</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></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>w</em>&nbsp;</td><td>the GtkWidget inside which the arrow is displayed.</td></tr>
  </table>
  </dd>
</dl>
<p>Used to update the representation of the arrow in the widget. </p>

<p>Reimplemented from <a class="el" href="classgcu_1_1Object.html#af2fffc10644e8cb8a18da68c8e18e24c">gcu::Object</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="mesomery-arrow_8h_source.html">mesomery-arrow.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 6 18:33:54 2009 for The Gnome Chemistry Utils by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>