<!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: gccv::Client Class 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacegccv.html">gccv</a></li><li class="navelem"><a class="el" href="classgccv_1_1Client.html">Client</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="classgccv_1_1Client-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gccv::Client Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The document associated with the canvas.
<a href="classgccv_1_1Client.html#details">More...</a></p>
<p><code>#include <<a class="el" href="client_8h_source.html">client.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gccv::Client:</div>
<div class="dyncontent">
<div class="center">
<img src="classgccv_1_1Client.png" usemap="#gccv::Client_map" alt=""/>
<map id="gccv::Client_map" name="gccv::Client_map">
<area href="classgcp_1_1View.html" alt="gcp::View" shape="rect" coords="0,56,78,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a352d30c4c6963ee2af0a6bf074ef903c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Client.html#a352d30c4c6963ee2af0a6bf074ef903c">Client</a> ()</td></tr>
<tr class="memitem:a16b15cc49bfa1ad092e4dda2bb9114e1"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Client.html#a16b15cc49bfa1ad092e4dda2bb9114e1">~Client</a> ()</td></tr>
<tr class="memitem:ac77f2e2970939c62b11d37a39275dc1d"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Client.html#ac77f2e2970939c62b11d37a39275dc1d">OnButtonPressed</a> (<a class="el" href="classgccv_1_1ItemClient.html">ItemClient</a> *client, unsigned button, double x, double y, unsigned state)</td></tr>
<tr class="memitem:a8faf7ecf3ad36cabbbdad051f622c334"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Client.html#a8faf7ecf3ad36cabbbdad051f622c334">OnButtonReleased</a> (<a class="el" href="classgccv_1_1ItemClient.html">ItemClient</a> *client, unsigned button, double x, double y, unsigned state)</td></tr>
<tr class="memitem:a97df2f8eea13149b03c9ca383014bf15"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Client.html#a97df2f8eea13149b03c9ca383014bf15">OnMotion</a> (<a class="el" href="classgccv_1_1ItemClient.html">ItemClient</a> *client, double x, double y, unsigned state)</td></tr>
<tr class="memitem:ac59752e837c04e06d85b04c7b96cc184"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Client.html#ac59752e837c04e06d85b04c7b96cc184">OnDrag</a> (<a class="el" href="classgccv_1_1ItemClient.html">ItemClient</a> *client, double x, double y, unsigned state)</td></tr>
<tr class="memitem:a8943ebe7e04648f96181b2420d7d9ca5"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Client.html#a8943ebe7e04648f96181b2420d7d9ca5">OnLeaveNotify</a> (unsigned state)</td></tr>
<tr class="memitem:a013c83cef95b8e678fd0f232a7727743"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgccv_1_1Canvas.html">Canvas</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Client.html#a013c83cef95b8e678fd0f232a7727743">GetCanvas</a> (void)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a73fba75a18a37113a4f8c8a091c8bde5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgccv_1_1Canvas.html">Canvas</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Client.html#a73fba75a18a37113a4f8c8a091c8bde5">m_Canvas</a></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The document associated with the canvas. </p>
<p>The <a class="el" href="classgccv_1_1Client.html" title="The document associated with the canvas.">Client</a> object might represent the document or its view. This class is used to propagate mouse events to the document. </p>
<p>Definition at line <a class="el" href="client_8h_source.html#l00043">43</a> of file <a class="el" href="client_8h_source.html">client.h</a>.</p>
</div><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a352d30c4c6963ee2af0a6bf074ef903c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gccv::Client::Client </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The standard constructor. </p>
</div>
</div>
<a class="anchor" id="a16b15cc49bfa1ad092e4dda2bb9114e1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual gccv::Client::~Client </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The destructor. </p>
</div>
</div>
<h2>Member Function Documentation</h2>
<a class="anchor" id="a013c83cef95b8e678fd0f232a7727743"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gccv::Client::GetCanvas </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>the associated canvas. </dd></dl>
<p>Definition at line <a class="el" href="client_8h_source.html#l00124">124</a> of file <a class="el" href="client_8h_source.html">client.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac77f2e2970939c62b11d37a39275dc1d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool gccv::Client::OnButtonPressed </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgccv_1_1ItemClient.html">ItemClient</a> * </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>button</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>state</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>the <a class="el" href="classgccv_1_1ItemClient.html" title="the base class for objects associated with a canvas item.">ItemClient</a> for the <a class="el" href="classgccv_1_1Item.html" title="The base class for the canvas contents.">Item</a> at the event position if any. </td></tr>
<tr><td class="paramname">button</td><td>the mouse button. </td></tr>
<tr><td class="paramname">x</td><td>horizontal event position. </td></tr>
<tr><td class="paramname">y</td><td>vertical event position. </td></tr>
<tr><td class="paramname">state</td><td>the GdkModifierType value for the event.</td></tr>
</table>
</dd>
</dl>
<p>Called when a mouse button is pressed. <em>client</em> is NULL when there is no <a class="el" href="classgccv_1_1Item.html" title="The base class for the canvas contents.">Item</a> at the event position, or the <a class="el" href="classgccv_1_1Item.html" title="The base class for the canvas contents.">Item</a> does not have an associated <a class="el" href="classgccv_1_1ItemClient.html" title="the base class for objects associated with a canvas item.">ItemClient</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>true to stop other handlers from being invoked for the event. false to propagate the event further. </dd></dl>
<p>Reimplemented in <a class="el" href="classgcp_1_1View.html#a0de9c2556a36015fd6ceeabf5c315757">gcp::View</a>.</p>
</div>
</div>
<a class="anchor" id="a8faf7ecf3ad36cabbbdad051f622c334"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool gccv::Client::OnButtonReleased </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgccv_1_1ItemClient.html">ItemClient</a> * </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>button</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>state</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>the <a class="el" href="classgccv_1_1ItemClient.html" title="the base class for objects associated with a canvas item.">ItemClient</a> for the <a class="el" href="classgccv_1_1Item.html" title="The base class for the canvas contents.">Item</a> at the event position if any. </td></tr>
<tr><td class="paramname">button</td><td>the mouse button. </td></tr>
<tr><td class="paramname">x</td><td>horizontal event position. </td></tr>
<tr><td class="paramname">y</td><td>vertical event position. </td></tr>
<tr><td class="paramname">state</td><td>the GdkModifierType value for the event.</td></tr>
</table>
</dd>
</dl>
<p>Called when a mouse button is released. <em>client</em> is NULL when there is no <a class="el" href="classgccv_1_1Item.html" title="The base class for the canvas contents.">Item</a> at the event position, or the <a class="el" href="classgccv_1_1Item.html" title="The base class for the canvas contents.">Item</a> does not have an associated <a class="el" href="classgccv_1_1ItemClient.html" title="the base class for objects associated with a canvas item.">ItemClient</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>true to stop other handlers from being invoked for the event. false to propagate the event further. </dd></dl>
<p>Reimplemented in <a class="el" href="classgcp_1_1View.html#a9af01f150186073bfb5e8222639dc9b7">gcp::View</a>.</p>
</div>
</div>
<a class="anchor" id="ac59752e837c04e06d85b04c7b96cc184"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool gccv::Client::OnDrag </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgccv_1_1ItemClient.html">ItemClient</a> * </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>state</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>the <a class="el" href="classgccv_1_1ItemClient.html" title="the base class for objects associated with a canvas item.">ItemClient</a> for the <a class="el" href="classgccv_1_1Item.html" title="The base class for the canvas contents.">Item</a> at the event position if any. </td></tr>
<tr><td class="paramname">x</td><td>horizontal event position. </td></tr>
<tr><td class="paramname">y</td><td>vertical event position. </td></tr>
<tr><td class="paramname">state</td><td>the GdkModifierType value for the event.</td></tr>
</table>
</dd>
</dl>
<p>Called when the mouse moves over the canvas, with at least one button pressed. <em>client</em> is NULL when there is no <a class="el" href="classgccv_1_1Item.html" title="The base class for the canvas contents.">Item</a> at the event position, or the <a class="el" href="classgccv_1_1Item.html" title="The base class for the canvas contents.">Item</a> does not have an associated <a class="el" href="classgccv_1_1ItemClient.html" title="the base class for objects associated with a canvas item.">ItemClient</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>true to stop other handlers from being invoked for the event. false to propagate the event further. </dd></dl>
<p>Reimplemented in <a class="el" href="classgcp_1_1View.html#a5b87ad01d72b67ba0aa95f6128ecfdc3">gcp::View</a>.</p>
</div>
</div>
<a class="anchor" id="a8943ebe7e04648f96181b2420d7d9ca5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool gccv::Client::OnLeaveNotify </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">state</td><td>the GdkModifierType value for the event.</td></tr>
</table>
</dd>
</dl>
<p>Called when the mouse leaves the <a class="el" href="classgccv_1_1Canvas.html" title="the Canvas class">Canvas</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>true to stop other handlers from being invoked for the event. false to propagate the event further. </dd></dl>
<p>Reimplemented in <a class="el" href="classgcp_1_1View.html#ac34efaed7d917b569564ec0130a4b1eb">gcp::View</a>.</p>
</div>
</div>
<a class="anchor" id="a97df2f8eea13149b03c9ca383014bf15"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool gccv::Client::OnMotion </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgccv_1_1ItemClient.html">ItemClient</a> * </td>
<td class="paramname"><em>client</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>state</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">client</td><td>the <a class="el" href="classgccv_1_1ItemClient.html" title="the base class for objects associated with a canvas item.">ItemClient</a> for the <a class="el" href="classgccv_1_1Item.html" title="The base class for the canvas contents.">Item</a> at the event position if any. </td></tr>
<tr><td class="paramname">x</td><td>horizontal event position. </td></tr>
<tr><td class="paramname">y</td><td>vertical event position. </td></tr>
<tr><td class="paramname">state</td><td>the GdkModifierType value for the event.</td></tr>
</table>
</dd>
</dl>
<p>Called when the mouse moves over the canvas, with no button pressed. <em>client</em> is NULL when there is no <a class="el" href="classgccv_1_1Item.html" title="The base class for the canvas contents.">Item</a> at the event position, or the <a class="el" href="classgccv_1_1Item.html" title="The base class for the canvas contents.">Item</a> does not have an associated <a class="el" href="classgccv_1_1ItemClient.html" title="the base class for objects associated with a canvas item.">ItemClient</a>. @return true to stop other handlers from being invoked for the event. false to propagate the event further. </p>
<p>Reimplemented in <a class="el" href="classgcp_1_1View.html#a15b9e94bfa7791478260211c122c75f0">gcp::View</a>.</p>
</div>
</div>
<h2>Member Data Documentation</h2>
<a class="anchor" id="a73fba75a18a37113a4f8c8a091c8bde5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gccv::Client::m_Canvas</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The associated canvas. </p>
<p>Definition at line <a class="el" href="client_8h_source.html#l00124">124</a> of file <a class="el" href="client_8h_source.html">client.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="client_8h_source.html">client.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 14 2013 17:34:29 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>
