<!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::Canvas 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_1Canvas.html">Canvas</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classgccv_1_1Canvas-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">gccv::Canvas Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>the <a class="el" href="classgccv_1_1Canvas.html" title="the Canvas class">Canvas</a> class <a href="classgccv_1_1Canvas.html#details">More...</a></p> <p><code>#include <<a class="el" href="canvas_8h_source.html">gccv/canvas.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a4b9637a724856b2dc795a772028ba5dc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#a4b9637a724856b2dc795a772028ba5dc">Canvas</a> (<a class="el" href="classgccv_1_1Client.html">Client</a> *client)</td></tr> <tr class="memitem:a5ea9738914d080b8a2c9dc883305a051"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#a5ea9738914d080b8a2c9dc883305a051">~Canvas</a> ()</td></tr> <tr class="memitem:a2b61387ba3712364f3426312af355c13"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgccv_1_1Item.html">Item</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#a2b61387ba3712364f3426312af355c13">GetItemAt</a> (double x, double y)</td></tr> <tr class="memitem:abe754b47999e9b2602bb5de557e584b4"><td class="memItemLeft" align="right" valign="top">GtkWidget * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#abe754b47999e9b2602bb5de557e584b4">GetWidget</a> ()</td></tr> <tr class="memitem:a1be66442953e6b59d259b6c1634c15d9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#a1be66442953e6b59d259b6c1634c15d9">Invalidate</a> (double x0, double y0, double x1, double y1)</td></tr> <tr class="memitem:aaa03a591444f581f3ddc58f08d2fd46a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#aaa03a591444f581f3ddc58f08d2fd46a">SetBackgroundColor</a> (GOColor color)</td></tr> <tr class="memitem:a822c294b145b0a080ce1b1d4ce5c8106"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#a822c294b145b0a080ce1b1d4ce5c8106">SetZoom</a> (double zoom)</td></tr> <tr class="memitem:a7e2a0a56504b4b85e517de52cc45f60a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#a7e2a0a56504b4b85e517de52cc45f60a">Render</a> (cairo_t *cr, bool is_vector)</td></tr> <tr class="memitem:af3c2b14bc6e4368316956e1095e5d5dd"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#af3c2b14bc6e4368316956e1095e5d5dd">GetZoom</a> (void) const </td></tr> <tr class="memitem:a3ee6c326b4c13ab52d68773d8ca30089"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgccv_1_1Group.html">Group</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#a3ee6c326b4c13ab52d68773d8ca30089">GetRoot</a> (void) const </td></tr> <tr class="memitem:a90d162834d7c7f44c4b18808322bbdff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#a90d162834d7c7f44c4b18808322bbdff">SetGap</a> (double val)</td></tr> <tr class="memitem:a918d29c610961f1987a528454ffef135"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#a918d29c610961f1987a528454ffef135">GetGap</a> (void) const </td></tr> <tr class="memitem:ac7b0f8891421fca82b6abfb4fd69c920"><td class="memItemLeft" align="right" valign="top">double & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#ac7b0f8891421fca82b6abfb4fd69c920">GetRefGap</a> (void)</td></tr> <tr class="memitem:adef3747078fceb0f2948cfe18f5b8b9c"><td class="memItemLeft" align="right" valign="top">GOColor </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#adef3747078fceb0f2948cfe18f5b8b9c">GetColor</a> (void) const </td></tr> <tr class="memitem:a8e0191014a75bf5a8e3669f760817c4b"><td class="memItemLeft" align="right" valign="top">GOColor </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#a8e0191014a75bf5a8e3669f760817c4b">GetBackgroundColor</a> (void) const </td></tr> <tr class="memitem:a16a390e818e174073f2494af90a35fde"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classgccv_1_1Canvas.html#a16a390e818e174073f2494af90a35fde">GetLastEventState</a> (void) const </td></tr> </table> <a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>the <a class="el" href="classgccv_1_1Canvas.html" title="the Canvas class">Canvas</a> class </p> <p>This class is the container class for the items and is the only one interacting with the underlying Gtk+ framework. It uses a private widget derived from GtkDrawingArea. </p> <p>Definition at line <a class="el" href="canvas_8h_source.html#l00053">53</a> of file <a class="el" href="canvas_8h_source.html">canvas.h</a>.</p> </div><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a4b9637a724856b2dc795a772028ba5dc"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gccv::Canvas::Canvas </td> <td>(</td> <td class="paramtype"><a class="el" href="classgccv_1_1Client.html">Client</a> * </td> <td class="paramname"><em>client</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">client</td><td>the <a class="el" href="classgccv_1_1Client.html" title="The document associated with the canvas.">gccv::Client</a> for the canvas or NULL.</td></tr> </table> </dd> </dl> <p>Constructs a canvas for <em>client</em> which is mandatory if some interaction with the canvas is needed. </p> </div> </div> <a class="anchor" id="a5ea9738914d080b8a2c9dc883305a051"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual gccv::Canvas::~Canvas </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. You should not delete the canvas, as it will be destroyed with the enclosing widget. Instead, if you never show the widget in a window, use: </p> <div class="fragment"><div class="line">gtk_widget_destroy (canvas->GetWidget ());</div> </div><!-- fragment --><p>Items are stored in an ordered tree whose top node is a <a class="el" href="classgccv_1_1Group.html" title="Item with Item children.">gccv::Group</a> instance which can be accessed by the <a class="el" href="classgccv_1_1Canvas.html#a3ee6c326b4c13ab52d68773d8ca30089">GetRoot()</a> method. </p> </div> </div> <h2>Member Function Documentation</h2> <a class="anchor" id="a8e0191014a75bf5a8e3669f760817c4b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">gccv::Canvas::GetBackgroundColor </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</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 background color. </dd></dl> <p>Definition at line <a class="el" href="canvas_8h_source.html#l00159">159</a> of file <a class="el" href="canvas_8h_source.html">canvas.h</a>.</p> </div> </div> <a class="anchor" id="adef3747078fceb0f2948cfe18f5b8b9c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">gccv::Canvas::GetColor </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</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 foreground color. </dd></dl> <p>Definition at line <a class="el" href="canvas_8h_source.html#l00152">152</a> of file <a class="el" href="canvas_8h_source.html">canvas.h</a>.</p> </div> </div> <a class="anchor" id="a918d29c610961f1987a528454ffef135"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">gccv::Canvas::GetGap </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</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 current gap for the canvas. </dd></dl> <p>Definition at line <a class="el" href="canvas_8h_source.html#l00148">148</a> of file <a class="el" href="canvas_8h_source.html">canvas.h</a>.</p> </div> </div> <a class="anchor" id="a2b61387ba3712364f3426312af355c13"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classgccv_1_1Item.html">Item</a>* gccv::Canvas::GetItemAt </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></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">x</td><td>the x coordiante. </td></tr> <tr><td class="paramname">y</td><td>the y coordinate.</td></tr> </table> </dd> </dl> <p>Used to get the top item at or near the given position. </p> <dl class="section return"><dt>Returns</dt><dd>the found item or NULL if no item is nearer than the current gap from the given position. </dd></dl> </div> </div> <a class="anchor" id="a16a390e818e174073f2494af90a35fde"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">gccv::Canvas::GetLastEventState </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</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 GdkModifierType value for the last received event. </dd></dl> <p>Definition at line <a class="el" href="canvas_8h_source.html#l00163">163</a> of file <a class="el" href="canvas_8h_source.html">canvas.h</a>.</p> </div> </div> <a class="anchor" id="ac7b0f8891421fca82b6abfb4fd69c920"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">gccv::Canvas::GetRefGap </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 current gap for the canvas as a reference. </dd></dl> <p>Definition at line <a class="el" href="canvas_8h_source.html#l00148">148</a> of file <a class="el" href="canvas_8h_source.html">canvas.h</a>.</p> </div> </div> <a class="anchor" id="a3ee6c326b4c13ab52d68773d8ca30089"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">gccv::Canvas::GetRoot </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</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 root item. </dd></dl> <p>Definition at line <a class="el" href="canvas_8h_source.html#l00130">130</a> of file <a class="el" href="canvas_8h_source.html">canvas.h</a>.</p> </div> </div> <a class="anchor" id="abe754b47999e9b2602bb5de557e584b4"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">GtkWidget* gccv::Canvas::GetWidget </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 widget used by the canvas. </dd></dl> <p>Definition at line <a class="el" href="canvas_8h_source.html#l00089">89</a> of file <a class="el" href="canvas_8h_source.html">canvas.h</a>.</p> </div> </div> <a class="anchor" id="af3c2b14bc6e4368316956e1095e5d5dd"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">gccv::Canvas::GetZoom </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td><td>)</td> <td> const</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 current zoom level for the canvas. </dd></dl> <p>Definition at line <a class="el" href="canvas_8h_source.html#l00126">126</a> of file <a class="el" href="canvas_8h_source.html">canvas.h</a>.</p> </div> </div> <a class="anchor" id="a1be66442953e6b59d259b6c1634c15d9"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gccv::Canvas::Invalidate </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"><em>x0</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"><em>y0</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"><em>x1</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">double </td> <td class="paramname"><em>y1</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">x0</td><td>the x coordinate for the top left of the invalidated rectangle. </td></tr> <tr><td class="paramname">y0</td><td>the y coordinate for the top left of the scrolling rectangle. </td></tr> <tr><td class="paramname">x1</td><td>the x coordinate for the bottom right of the scrolling rectangle. </td></tr> <tr><td class="paramname">y1</td><td>the y coordinate for the bottom right of the scrolling rectangle. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a7e2a0a56504b4b85e517de52cc45f60a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gccv::Canvas::Render </td> <td>(</td> <td class="paramtype">cairo_t * </td> <td class="paramname"><em>cr</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"><em>is_vector</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">cr</td><td>a cairo context. </td></tr> <tr><td class="paramname">is_vector</td><td>whether the cairo context is vectorial or raster.</td></tr> </table> </dd> </dl> <p>Renders the current canvas to the cairo context. </p> </div> </div> <a class="anchor" id="aaa03a591444f581f3ddc58f08d2fd46a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gccv::Canvas::SetBackgroundColor </td> <td>(</td> <td class="paramtype">GOColor </td> <td class="paramname"><em>color</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">color</td><td>a GOColor.</td></tr> </table> </dd> </dl> <p>Sets the background color for the canvas widget </p> </div> </div> <a class="anchor" id="a90d162834d7c7f44c4b18808322bbdff"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">gccv::Canvas::SetGap </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"><em>gap</em></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="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">gap</td><td>a distance at which an item might be from an event location to be selected for the event.</td></tr> </table> </dd> </dl> <p>Sets the maximum distance at which an item might be from an event location to be selected for the event. When an even as a mouse button click occurs, and if it occurs on an item, the appropriate method of the item client will be called; else if it occurs on the background, the nearest item will be used if its distance from the event location is less than <em>gap</em>. If no item can be used, the event will have no associated <a class="el" href="classgccv_1_1ItemClient.html" title="the base class for objects associated with a canvas item.">gccv::ItemClient</a> instance. </p> <p>Definition at line <a class="el" href="canvas_8h_source.html#l00148">148</a> of file <a class="el" href="canvas_8h_source.html">canvas.h</a>.</p> </div> </div> <a class="anchor" id="a822c294b145b0a080ce1b1d4ce5c8106"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gccv::Canvas::SetZoom </td> <td>(</td> <td class="paramtype">double </td> <td class="paramname"><em>zoom</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">zoom</td><td>the new zoom level.</td></tr> </table> </dd> </dl> <p>Sets the zoom level for the canvas. </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="canvas_8h_source.html">canvas.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>