<!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"/> <meta name="generator" content="Doxygen 1.8.6"/> <title>The Gnome Chemistry Utils: gcr::Window 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.8</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.6 --> <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="namespacegcr.html">gcr</a></li><li class="navelem"><a class="el" href="classgcr_1_1Window.html">Window</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> | <a href="classgcr_1_1Window-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">gcr::Window Class Reference</div> </div> </div><!--header--> <div class="contents"> <p><a class="el" href="classgcr_1_1Window.html" title="Window class. ">Window</a> class. <a href="classgcr_1_1Window.html#details">More...</a></p> <p><code>#include <<a class="el" href="gcr_2window_8h_source.html">gcr/window.h</a>></code></p> <p>Inherits gcugtk::Window.</p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:ac9b1985a51a810f2657deb608bc66399"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Window.html#ac9b1985a51a810f2657deb608bc66399">Window</a> (<a class="el" href="classgcu_1_1Application.html">gcu::Application</a> *app, <a class="el" href="classgcr_1_1Document.html">Document</a> *doc, char const *extra_ui=NULL)</td></tr> <tr class="separator:ac9b1985a51a810f2657deb608bc66399"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab4b17448f82d44a8592ea3c0d4ac1170"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Window.html#ab4b17448f82d44a8592ea3c0d4ac1170">~Window</a> ()</td></tr> <tr class="separator:ab4b17448f82d44a8592ea3c0d4ac1170"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aca4f6528aaed9fad70dc9763229ed46c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Window.html#aca4f6528aaed9fad70dc9763229ed46c">Destroy</a> ()</td></tr> <tr class="separator:aca4f6528aaed9fad70dc9763229ed46c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6d1d32e66f6041c2003961e2778541e7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Window.html#a6d1d32e66f6041c2003961e2778541e7">ClearStatus</a> ()</td></tr> <tr class="separator:a6d1d32e66f6041c2003961e2778541e7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a245cab920a0e84c81069557062671b1f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Window.html#a245cab920a0e84c81069557062671b1f">SetStatusText</a> (const char *text)</td></tr> <tr class="separator:a245cab920a0e84c81069557062671b1f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acffc2c6d67380dd8ab4df04749d4b391"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcr_1_1Application.html">gcr::Application</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Window.html#acffc2c6d67380dd8ab4df04749d4b391">GetApplication</a> (void)</td></tr> <tr class="separator:acffc2c6d67380dd8ab4df04749d4b391"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae4089af505fe3804b98b08e36d030a9f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcr_1_1View.html">View</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Window.html#ae4089af505fe3804b98b08e36d030a9f">GetView</a> (void) const </td></tr> <tr class="separator:ae4089af505fe3804b98b08e36d030a9f"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:ac9fa675d2429b83fb9e9154640c206ea"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Window.html#ac9fa675d2429b83fb9e9154640c206ea">OnSave</a> ()</td></tr> <tr class="separator:ac9fa675d2429b83fb9e9154640c206ea"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr class="memitem:a1e199ee3481995f06c75542708a0ab1a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcr_1_1Document.html">Document</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Window.html#a1e199ee3481995f06c75542708a0ab1a">m_Document</a></td></tr> <tr class="separator:a1e199ee3481995f06c75542708a0ab1a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1305004cca287d1090931200c208a30c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcr_1_1Application.html">gcr::Application</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcr_1_1Window.html#a1305004cca287d1090931200c208a30c">m_Application</a></td></tr> <tr class="separator:a1305004cca287d1090931200c208a30c"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p><a class="el" href="classgcr_1_1Window.html" title="Window class. ">Window</a> class. </p> <p>This class wraps the window used to display a view. </p> <p>Definition at line <a class="el" href="gcr_2window_8h_source.html#l00045">45</a> of file <a class="el" href="gcr_2window_8h_source.html">gcr/window.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="ac9b1985a51a810f2657deb608bc66399"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gcr::Window::Window </td> <td>(</td> <td class="paramtype"><a class="el" href="classgcu_1_1Application.html">gcu::Application</a> * </td> <td class="paramname"><em>app</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classgcr_1_1Document.html">Document</a> * </td> <td class="paramname"><em>doc</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">char const * </td> <td class="paramname"><em>extra_ui</em> = <code>NULL</code> </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">app</td><td>the application. </td></tr> <tr><td class="paramname">doc</td><td>the document. </td></tr> <tr><td class="paramname">extra_ui</td><td>a string describing the menu items to add.</td></tr> </table> </dd> </dl> <p>Contructs the new window. Default menus do not have a File/Quit item or a Windows menu. <em>extra_ui</em> can be used to add them. GCrystal uses: </p> <div class="fragment"><div class="line"><span class="stringliteral">"<ui>"</span></div> <div class="line"><span class="stringliteral">" <menubar name='MainMenu'>"</span></div> <div class="line"><span class="stringliteral">" <menu action='FileMenu'>"</span></div> <div class="line"><span class="stringliteral">" <placeholder name='file1'>"</span></div> <div class="line"><span class="stringliteral">" <menuitem action='Quit'/>"</span></div> <div class="line"><span class="stringliteral">" </placeholder>"</span></div> <div class="line"><span class="stringliteral">" </menu>"</span></div> <div class="line"><span class="stringliteral">" <placeholder name='menu1'>"</span></div> <div class="line"><span class="stringliteral">" <menu action='WindowsMenu'>"</span></div> <div class="line"><span class="stringliteral">" <menuitem action='NewView'/>"</span></div> <div class="line"><span class="stringliteral">" <menuitem action='CloseView'/>"</span></div> <div class="line"><span class="stringliteral">" </menu>"</span></div> <div class="line"><span class="stringliteral">" </placeholder>"</span></div> <div class="line"><span class="stringliteral">" </menubar>"</span></div> <div class="line"><span class="stringliteral">"</ui>"</span>;</div> </div><!-- fragment --> </div> </div> <a class="anchor" id="ab4b17448f82d44a8592ea3c0d4ac1170"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual gcr::Window::~Window </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> <p>Reimplemented from <a class="el" href="classgcu_1_1Window.html#a1a2f39872d6ef5c0f7a7c947f55503fb">gcu::Window</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a6d1d32e66f6041c2003961e2778541e7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gcr::Window::ClearStatus </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Clears the status bar message. </p> </div> </div> <a class="anchor" id="aca4f6528aaed9fad70dc9763229ed46c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void gcr::Window::Destroy </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>Destroys the window. </p> <p>Reimplemented from <a class="el" href="classgcu_1_1Window.html#a7f5384a9bb88e7b0666fee33d6fad9c5">gcu::Window</a>.</p> </div> </div> <a class="anchor" id="acffc2c6d67380dd8ab4df04749d4b391"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">gcr::Window::GetApplication </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 <a class="el" href="classgcr_1_1Document.html">gcr::Document</a> displayed in this window.</dd> <dd> the <a class="el" href="classgcu_1_1Application.html">gcu::Application</a> owning this window. </dd></dl> <p>Definition at line <a class="el" href="gcr_2window_8h_source.html#l00121">121</a> of file <a class="el" href="gcr_2window_8h_source.html">gcr/window.h</a>.</p> </div> </div> <a class="anchor" id="ae4089af505fe3804b98b08e36d030a9f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">gcr::Window::GetView </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 <a class="el" href="classgcr_1_1View.html">View</a> displayed by this window. </dd></dl> <p>Definition at line <a class="el" href="gcr_2window_8h_source.html#l00125">125</a> of file <a class="el" href="gcr_2window_8h_source.html">gcr/window.h</a>.</p> </div> </div> <a class="anchor" id="ac9fa675d2429b83fb9e9154640c206ea"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void gcr::Window::OnSave </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Saves the document. </p> </div> </div> <a class="anchor" id="a245cab920a0e84c81069557062671b1f"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void gcr::Window::SetStatusText </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>text</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">text</td><td>the text to display in the status bar.</td></tr> </table> </dd> </dl> <p>Sets the status bar message. </p> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a class="anchor" id="a1305004cca287d1090931200c208a30c"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">gcr::Window::m_Application</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 <a class="el" href="classgcu_1_1Application.html">gcu::Application</a> owning this window. </p> <p>Definition at line <a class="el" href="gcr_2window_8h_source.html#l00121">121</a> of file <a class="el" href="gcr_2window_8h_source.html">gcr/window.h</a>.</p> </div> </div> <a class="anchor" id="a1e199ee3481995f06c75542708a0ab1a"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">gcr::Window::m_Document</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 <a class="el" href="classgcr_1_1Document.html">gcr::Document</a> displayed in this window. </p> <p>Definition at line <a class="el" href="gcr_2window_8h_source.html#l00114">114</a> of file <a class="el" href="gcr_2window_8h_source.html">gcr/window.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="gcr_2window_8h_source.html">gcr/window.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu May 8 2014 09:55:06 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.6 </small></address> </body> </html>