<!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: gcu::Dialog 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="namespacegcu.html">gcu</a></li><li class="navelem"><a class="el" href="classgcu_1_1Dialog.html">Dialog</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="classgcu_1_1Dialog-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gcu::Dialog Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="dialog_8h_source.html">gcu/dialog.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gcu::Dialog:</div>
<div class="dyncontent">
<div class="center">
<img src="classgcu_1_1Dialog.png" usemap="#gcu::Dialog_map" alt=""/>
<map id="gcu::Dialog_map" name="gcu::Dialog_map">
<area href="classgcugtk_1_1Dialog.html" alt="gcugtk::Dialog" shape="rect" coords="0,56,134,80"/>
<area href="classgcp_1_1DocPropDlg.html" alt="gcp::DocPropDlg" shape="rect" coords="144,112,278,136"/>
<area href="classgcp_1_1HPosDlg.html" alt="gcp::HPosDlg" shape="rect" coords="144,168,278,192"/>
<area href="classgcp_1_1NewFileDlg.html" alt="gcp::NewFileDlg" shape="rect" coords="144,224,278,248"/>
<area href="classgcp_1_1PrefsDlg.html" title="GChemPaint preferences dialog class." alt="gcp::PrefsDlg" shape="rect" coords="144,280,278,304"/>
<area href="classgcp_1_1ReactionPropDlg.html" title="reaction properties dialog box class." alt="gcp::ReactionPropDlg" shape="rect" coords="144,336,278,360"/>
<area href="classgcp_1_1Tools.html" alt="gcp::Tools" shape="rect" coords="144,392,278,416"/>
<area href="classgcp_1_1ZoomDlg.html" alt="gcp::ZoomDlg" shape="rect" coords="144,448,278,472"/>
<area href="classgcr_1_1AtomsDlg.html" title="GCrystal atoms dialog class." alt="gcr::AtomsDlg" shape="rect" coords="144,504,278,528"/>
<area href="classgcr_1_1CellDlg.html" title="GCrystal cell dialog class." alt="gcr::CellDlg" shape="rect" coords="144,560,278,584"/>
<area href="classgcr_1_1CleavagesDlg.html" title="GCrystal cleavages dialog class." alt="gcr::CleavagesDlg" shape="rect" coords="144,616,278,640"/>
<area href="classgcr_1_1LinesDlg.html" title="GCrystal lines dialog class." alt="gcr::LinesDlg" shape="rect" coords="144,672,278,696"/>
<area href="classgcr_1_1PrefsDlg.html" title="Application preferences dialog class." alt="gcr::PrefsDlg" shape="rect" coords="144,728,278,752"/>
<area href="classgcr_1_1SizeDlg.html" title="GCrystal model size dialog class." alt="gcr::SizeDlg" shape="rect" coords="144,784,278,808"/>
<area href="classgcr_1_1ViewSettingsDlg.html" title="View settings dialog class." alt="gcr::ViewSettingsDlg" shape="rect" coords="144,840,278,864"/>
<area href="classgcugtk_1_1PrintSetupDlg.html" alt="gcugtk::PrintSetupDlg" shape="rect" coords="144,896,278,920"/>
<area href="classgcugtk_1_1StringDlg.html" alt="gcugtk::StringDlg" shape="rect" coords="144,952,278,976"/>
<area href="classgcugtk_1_1StringInputDlg.html" alt="gcugtk::StringInputDlg" shape="rect" coords="144,1008,278,1032"/>
</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:ada6264d1a6584f33295ee5fa4f7282c9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Dialog.html#ada6264d1a6584f33295ee5fa4f7282c9">Dialog</a> (<a class="el" href="classgcu_1_1Application.html">Application</a> *App, const char *windowname, <a class="el" href="classgcu_1_1DialogOwner.html">DialogOwner</a> *owner=NULL) throw (std::runtime_error)</td></tr>
<tr class="memitem:a1728b436f075412e8d3570de8940f0e5"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Dialog.html#a1728b436f075412e8d3570de8940f0e5">~Dialog</a> ()</td></tr>
<tr class="memitem:a4c981356bab3330c8c3ae2270baeb73c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Dialog.html#a4c981356bab3330c8c3ae2270baeb73c">SetRealName</a> (char const *name, <a class="el" href="classgcu_1_1DialogOwner.html">DialogOwner</a> *owner) throw (std::runtime_error)</td></tr>
<tr class="memitem:a9835f1febc85d3f3c810686e657906fc"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Dialog.html#a9835f1febc85d3f3c810686e657906fc">Present</a> ()=0</td></tr>
<tr class="memitem:a0711bbbacfeb8b6d7013dec1853bd98d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Dialog.html#a0711bbbacfeb8b6d7013dec1853bd98d">Destroy</a> ()=0</td></tr>
<tr class="memitem:af2a1c27e57e29d7fa098ee0d05d6daa9"><td class="memItemLeft" align="right" valign="top">std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Dialog.html#af2a1c27e57e29d7fa098ee0d05d6daa9">GetWindowName</a> ()</td></tr>
<tr class="memitem:ad71421595129a00f679402f41e2c53b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcu_1_1Application.html">Application</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Dialog.html#ad71421595129a00f679402f41e2c53b5">GetApp</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:a6b2a1f05117cfaab219ef51700bc0777"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcu_1_1Application.html">Application</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Dialog.html#a6b2a1f05117cfaab219ef51700bc0777">m_App</a></td></tr>
</table>
<a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This class is base class for dialog boxes. It provides some basic services. </p>
<p>Definition at line <a class="el" href="dialog_8h_source.html#l00041">41</a> of file <a class="el" href="dialog_8h_source.html">dialog.h</a>.</p>
</div><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ada6264d1a6584f33295ee5fa4f7282c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::Dialog::Dialog </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcu_1_1Application.html">Application</a> * </td>
<td class="paramname"><em>App</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>windowname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgcu_1_1DialogOwner.html">DialogOwner</a> * </td>
<td class="paramname"><em>owner</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throw (std::runtime_error)</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 <a class="el" href="classgcu_1_1Application.html">Application</a> which owns the dialog. </td></tr>
<tr><td class="paramname">windowname,:</td><td>the name of the top level GtkWidget of the dialog box in the glade file. This name should be unique for the application. It is used to access the contextual help and to ensure the uniqueness of the dialog (in some cases). </td></tr>
<tr><td class="paramname">owner,:</td><td>the address of an owner object, might be App or a document or NULL (the default). when owner is not NULL, the dialog will be unique for it. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1728b436f075412e8d3570de8940f0e5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual gcu::Dialog::~Dialog </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 in <a class="el" href="classgcugtk_1_1Dialog.html#a4c9bf859c445aa8294743de841ab2d0a">gcugtk::Dialog</a>.</p>
</div>
</div>
<h2>Member Function Documentation</h2>
<a class="anchor" id="a0711bbbacfeb8b6d7013dec1853bd98d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void gcu::Dialog::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys the dialog. This is a pure virtual function and derived classes must implement it. </p>
<p>Implemented in <a class="el" href="classgcugtk_1_1Dialog.html#a0f9d8173f33e488ca98a51abe8a1615a">gcugtk::Dialog</a>.</p>
</div>
</div>
<a class="anchor" id="ad71421595129a00f679402f41e2c53b5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gcu::Dialog::GetApp </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="classgcu_1_1Application.html">Application</a> instance owning the dialog. </dd></dl>
<p>Definition at line <a class="el" href="dialog_8h_source.html#l00102">102</a> of file <a class="el" href="dialog_8h_source.html">dialog.h</a>.</p>
</div>
</div>
<a class="anchor" id="af2a1c27e57e29d7fa098ee0d05d6daa9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::string& gcu::Dialog::GetWindowName </td>
<td>(</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">
<p>Dialogs are referenced by their <a class="el" href="classgcu_1_1DialogOwner.html">DialogOwner</a> through their name which must be unique. This makes possible to display a hidden dialog without having two instances of it. </p>
<dl class="section return"><dt>Returns</dt><dd>the dialog window name. </dd></dl>
<p>Definition at line <a class="el" href="dialog_8h_source.html#l00088">88</a> of file <a class="el" href="dialog_8h_source.html">dialog.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9835f1febc85d3f3c810686e657906fc"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void gcu::Dialog::Present </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Make sure the dialog is visible. This is a pure virtual function and derived classes must implement it. </p>
<p>Implemented in <a class="el" href="classgcugtk_1_1Dialog.html#ac96e08bd79829e1bd48a4ad607edd724">gcugtk::Dialog</a>.</p>
</div>
</div>
<a class="anchor" id="a4c981356bab3330c8c3ae2270baeb73c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcu::Dialog::SetRealName </td>
<td>(</td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classgcu_1_1DialogOwner.html">DialogOwner</a> * </td>
<td class="paramname"><em>owner</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> throw (std::runtime_error)</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>a new name for the window. </td></tr>
<tr><td class="paramname">owner</td><td>the address of an dialog owner object.</td></tr>
</table>
</dd>
</dl>
<p>Usually, the <a class="el" href="classgcu_1_1Dialog.html">Dialog</a> is registered using its window name as passed to the constructor. If several occurences of the same <a class="el" href="classgcu_1_1Dialog.html">Dialog</a> are acceptable, another unique name is needed. <em>owner</em> might be NULL if it has already been set in the constructor. The existence of a <a class="el" href="classgcu_1_1Dialog.html">Dialog</a> with the same name should be checked before calling this method, because that would throw an error. </p>
</div>
</div>
<h2>Member Data Documentation</h2>
<a class="anchor" id="a6b2a1f05117cfaab219ef51700bc0777"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">gcu::Dialog::m_App</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">Application</a> instance owning the dialog. </p>
<p>Definition at line <a class="el" href="dialog_8h_source.html#l00102">102</a> of file <a class="el" href="dialog_8h_source.html">dialog.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="dialog_8h_source.html">dialog.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 14 2013 17:34:31 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>
