Sophie

Sophie

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

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::ReactionOperator 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_1ReactionOperator.html">ReactionOperator</a>
  </div>
</div>
<div class="contents">
<h1>gcp::ReactionOperator Class Reference</h1><!-- doxytag: class="gcp::ReactionOperator" --><!-- doxytag: inherits="gcu::Object" -->
<p>Class for '+' signs in chemical reaction equations.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="reaction-operator_8h_source.html">gcp/reaction-operator.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gcp::ReactionOperator:</div>
<div class="dynsection">
 <div class="center">
  <img src="classgcp_1_1ReactionOperator.gif" usemap="#gcp::ReactionOperator_map" alt=""/>
  <map id="gcp::ReactionOperator_map" name="gcp::ReactionOperator_map">
<area href="classgcu_1_1Object.html" alt="gcu::Object" shape="rect" coords="0,0,139,24"/>
</map>
 </div>
</div>

<p><a href="classgcp_1_1ReactionOperator-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_1ReactionOperator.html#a91e5da7ba28d6ad19e3db79cd0eeaca6">ReactionOperator</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionOperator.html#a0526575b7c5ae3f322fbcc4e31a7e9e7">~ReactionOperator</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionOperator.html#a0ec163cd7f398383df1ba2ecc7b0f4f9">Add</a> (GtkWidget *w) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionOperator.html#a0d346a7b3be3b2dacbe02a18e1d54432">Update</a> (GtkWidget *w) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionOperator.html#af62c746dcdf5f637515727fd93ab8d12">Move</a> (double x, double y, double z=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionOperator.html#ad039fbf0ebf1b3898d37cc2a42efc388">SetSelected</a> (GtkWidget *w, int state)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionOperator.html#a13160376fe64913d4fc62a9f1fb85147">SetCoords</a> (double x, double y)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionOperator.html#add53a8be1f2fe89d1c0400e114da6d95">GetCoords</a> (double *x, double *y) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcp_1_1ReactionOperator.html#a749b55a5fdaa4d86e63d7b3cb0afc7eb">GetYAlign</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Class for '+' signs in chemical reaction equations. </p>
<p>Objects of this class are added when useful by the framework. There is no need to create them manually. </p>

<p>Definition at line <a class="el" href="reaction-operator_8h_source.html#l00039">39</a> of file <a class="el" href="reaction-operator_8h_source.html">reaction-operator.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a91e5da7ba28d6ad19e3db79cd0eeaca6"></a><!-- doxytag: member="gcp::ReactionOperator::ReactionOperator" ref="a91e5da7ba28d6ad19e3db79cd0eeaca6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gcp::ReactionOperator::ReactionOperator </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The constructor. Adds a '+' sign in the chemical equation. </p>

</div>
</div>
<a class="anchor" id="a0526575b7c5ae3f322fbcc4e31a7e9e7"></a><!-- doxytag: member="gcp::ReactionOperator::~ReactionOperator" ref="a0526575b7c5ae3f322fbcc4e31a7e9e7" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual gcp::ReactionOperator::~ReactionOperator </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="a0ec163cd7f398383df1ba2ecc7b0f4f9"></a><!-- doxytag: member="gcp::ReactionOperator::Add" ref="a0ec163cd7f398383df1ba2ecc7b0f4f9" args="(GtkWidget *w) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void gcp::ReactionOperator::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 operator will be displayed.</td></tr>
  </table>
  </dd>
</dl>
<p>Used to add a representation of the operator 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="add53a8be1f2fe89d1c0400e114da6d95"></a><!-- doxytag: member="gcp::ReactionOperator::GetCoords" ref="add53a8be1f2fe89d1c0400e114da6d95" args="(double *x, double *y) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool gcp::ReactionOperator::GetCoords </td>
          <td>(</td>
          <td class="paramtype">double *&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double *&nbsp;</td>
          <td class="paramname"> <em>y</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const</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>x</em>&nbsp;</td><td>where to store the x coordinate of the operator. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>where to store the y coordinate of the operator.</td></tr>
  </table>
  </dd>
</dl>
<p>Retrieves the current coordinates of the operator. </p>

</div>
</div>
<a class="anchor" id="a749b55a5fdaa4d86e63d7b3cb0afc7eb"></a><!-- doxytag: member="gcp::ReactionOperator::GetYAlign" ref="a749b55a5fdaa4d86e63d7b3cb0afc7eb" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual double gcp::ReactionOperator::GetYAlign </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Used to retrieve the y coordinate for alignment. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>y coordinate used for reaction operators alignment. </dd></dl>

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

</div>
</div>
<a class="anchor" id="af62c746dcdf5f637515727fd93ab8d12"></a><!-- doxytag: member="gcp::ReactionOperator::Move" ref="af62c746dcdf5f637515727fd93ab8d12" args="(double x, double y, double z=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void gcp::ReactionOperator::Move </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>z</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></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>x</em>&nbsp;</td><td>the x component of the transation vector. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>the y component of the transation vector. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>z</em>&nbsp;</td><td>the z component of the transation vector (unused).</td></tr>
  </table>
  </dd>
</dl>
<p>Moves the reaction operator. </p>

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

</div>
</div>
<a class="anchor" id="a13160376fe64913d4fc62a9f1fb85147"></a><!-- doxytag: member="gcp::ReactionOperator::SetCoords" ref="a13160376fe64913d4fc62a9f1fb85147" args="(double x, double y)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gcp::ReactionOperator::SetCoords </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>y</em></td><td>&nbsp;</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>x</em>&nbsp;</td><td>the new x coordinate of the operator. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>the new y coordinate of the operator.</td></tr>
  </table>
  </dd>
</dl>
<p>Sets the coordinates of the operator. The values are understood horizontally as left side and vertically as base line. </p>

</div>
</div>
<a class="anchor" id="ad039fbf0ebf1b3898d37cc2a42efc388"></a><!-- doxytag: member="gcp::ReactionOperator::SetSelected" ref="ad039fbf0ebf1b3898d37cc2a42efc388" args="(GtkWidget *w, int state)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void gcp::ReactionOperator::SetSelected </td>
          <td>(</td>
          <td class="paramtype">GtkWidget *&nbsp;</td>
          <td class="paramname"> <em>w</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>state</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></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>w,:</em>&nbsp;</td><td>the GtkWidget inside which the operator is displayed. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>state,:</em>&nbsp;</td><td>the selection state of the operator.</td></tr>
  </table>
  </dd>
</dl>
<p>Used to set the selection state of the operator inside the widget. The values of state might be <a class="el" href="namespacegcp.html#a2873f45c769a642340cfd80eff3dde74abd6a663c786e2d2b135a74d52f0cd552">gcp::SelStateUnselected</a>, <a class="el" href="namespacegcp.html#a2873f45c769a642340cfd80eff3dde74a94b317915b52f90cbc98b15a577b25d8">gcp::SelStateSelected</a>, <a class="el" href="namespacegcp.html#a2873f45c769a642340cfd80eff3dde74adcae1871fb81a60e980331b689fe3ce0">gcp::SelStateUpdating</a>, or <a class="el" href="namespacegcp.html#a2873f45c769a642340cfd80eff3dde74a2d4e3b5f28ae0af00b9381c2548dea00">gcp::SelStateErasing</a>. Children will be selected too. </p>

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

</div>
</div>
<a class="anchor" id="a0d346a7b3be3b2dacbe02a18e1d54432"></a><!-- doxytag: member="gcp::ReactionOperator::Update" ref="a0d346a7b3be3b2dacbe02a18e1d54432" args="(GtkWidget *w) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void gcp::ReactionOperator::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 operator is displayed.</td></tr>
  </table>
  </dd>
</dl>
<p>Used to update the representation of the operator 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="reaction-operator_8h_source.html">reaction-operator.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>