GED 2006 (C++)
File detail
Source code
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>GED 2006: AppWnd Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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>
<h1>AppWnd Class Reference</h1><!-- doxytag: class="AppWnd" --><code>#include <<a class="el" href="appwnd_8h-source.html">appwnd.h</a>></code>
<p>
<a href="classAppWnd-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppWnd.html#536832d1cf7d7f7fda0e7dbd76871936">~AppWnd</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppWnd.html#da85775d81c7c0890685bf5af57350f4">closeAll</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppWnd.html#54ff7a2d3b522eac9a8cc785a5ac6760">exit</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppWnd.html#03a68c18c861deef921af0f80a5669b0">isDocument</a> (Fl_Window *wnd)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structDrawContext.html">DrawContext</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppWnd.html#0e78b64de1dffa915264e96bf225a3d6">drawContext</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppWnd.html#3c071fef2e706f1145d762f229b6078c">selectTool</a> (<a class="el" href="draw_8h.html#a5f199db1342f423e3f9ec6c82128504">EDrawTool</a> et)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classAppWnd.html">AppWnd</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppWnd.html#35b7da12b0af3a5b53db2904aab0c5bb">ptr</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppWnd.html#8f643a7e9652561eaf7abfc9ab42f785">destroy</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppWnd.html#aa9dcb82768a36e651ec2fafbfcbafa6">newDocName</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppWnd.html#7bc49679fb102f6cf503dc9551ad7e12">AppWnd</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppWnd.html#c821da88c675c584f1d8bf3f3a52b7f1">addDoc</a> (<a class="el" href="classDocument.html">Document</a> *doc)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppWnd.html#3e01fdce9a6d9e25e7d98e87d0318fdf">remDoc</a> (<a class="el" href="classDocument.html">Document</a> *doc)</td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classAppWnd.html#c1a32a3b21d6a6d44979e3158b4d05ce">Document</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Application window (singleton)
<p>
<p>
Definition at line <a class="el" href="appwnd_8h-source.html#l00032">32</a> of file <a class="el" href="appwnd_8h-source.html">appwnd.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="536832d1cf7d7f7fda0e7dbd76871936"></a><!-- doxytag: member="AppWnd::~AppWnd" ref="536832d1cf7d7f7fda0e7dbd76871936" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AppWnd::~AppWnd </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="7bc49679fb102f6cf503dc9551ad7e12"></a><!-- doxytag: member="AppWnd::AppWnd" ref="7bc49679fb102f6cf503dc9551ad7e12" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AppWnd::AppWnd </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Singleton can not be allocated static. Use method <a class="el" href="classAppWnd.html#35b7da12b0af3a5b53db2904aab0c5bb">AppWnd::ptr()</a> method to obtain singleton address.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="35b7da12b0af3a5b53db2904aab0c5bb"></a><!-- doxytag: member="AppWnd::ptr" ref="35b7da12b0af3a5b53db2904aab0c5bb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classAppWnd.html">AppWnd</a>* AppWnd::ptr </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Access point to singleton <a class="el" href="classAppWnd.html">AppWnd</a>. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Return pointer to singleton. </dd></dl>
<p>
Referenced by <a class="el" href="appwnd_8h-source.html#l00127">Document::Document()</a>, and <a class="el" href="appwnd_8h-source.html#l00131">Document::~Document()</a>.
</div>
</div><p>
<a class="anchor" name="8f643a7e9652561eaf7abfc9ab42f785"></a><!-- doxytag: member="AppWnd::destroy" ref="8f643a7e9652561eaf7abfc9ab42f785" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void AppWnd::destroy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroy singleton <a class="el" href="classAppWnd.html">AppWnd</a>. It has no effect if object is not allocated.
</div>
</div><p>
<a class="anchor" name="da85775d81c7c0890685bf5af57350f4"></a><!-- doxytag: member="AppWnd::closeAll" ref="da85775d81c7c0890685bf5af57350f4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AppWnd::closeAll </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Try to close all documents attached to <a class="el" href="classAppWnd.html">AppWnd</a> singleton. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Return true if all documents are closed. </dd></dl>
</div>
</div><p>
<a class="anchor" name="54ff7a2d3b522eac9a8cc785a5ac6760"></a><!-- doxytag: member="AppWnd::exit" ref="54ff7a2d3b522eac9a8cc785a5ac6760" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AppWnd::exit </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Try to close all documents. If success, close <a class="el" href="classHelpBrowser.html">HelpBrowser</a> singleton and <a class="el" href="classAppWnd.html">AppWnd</a> singleton.
</div>
</div><p>
<a class="anchor" name="03a68c18c861deef921af0f80a5669b0"></a><!-- doxytag: member="AppWnd::isDocument" ref="03a68c18c861deef921af0f80a5669b0" args="(Fl_Window *wnd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AppWnd::isDocument </td>
<td>(</td>
<td class="paramtype">Fl_Window * </td>
<td class="paramname"> <em>wnd</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Search pointer to window in document list. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>wnd</em> </td><td>Pointer to window. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return true if pointer points to <a class="el" href="classDocument.html">Document</a> object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="0e78b64de1dffa915264e96bf225a3d6"></a><!-- doxytag: member="AppWnd::drawContext" ref="0e78b64de1dffa915264e96bf225a3d6" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structDrawContext.html">DrawContext</a> AppWnd::drawContext </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return <a class="el" href="structDrawContext.html">DrawContext</a> structure containing current draw tool properties. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3c071fef2e706f1145d762f229b6078c"></a><!-- doxytag: member="AppWnd::selectTool" ref="3c071fef2e706f1145d762f229b6078c" args="(EDrawTool et)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AppWnd::selectTool </td>
<td>(</td>
<td class="paramtype"><a class="el" href="draw_8h.html#a5f199db1342f423e3f9ec6c82128504">EDrawTool</a> </td>
<td class="paramname"> <em>et</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set current draw tool. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>et</em> </td><td>Draw tool enumeration. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="aa9dcb82768a36e651ec2fafbfcbafa6"></a><!-- doxytag: member="AppWnd::newDocName" ref="aa9dcb82768a36e651ec2fafbfcbafa6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static std::string AppWnd::newDocName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return unique file name for new document. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c821da88c675c584f1d8bf3f3a52b7f1"></a><!-- doxytag: member="AppWnd::addDoc" ref="c821da88c675c584f1d8bf3f3a52b7f1" args="(Document *doc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AppWnd::addDoc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDocument.html">Document</a> * </td>
<td class="paramname"> <em>doc</em> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add pointer to <a class="el" href="classDocument.html">Document</a> object to document list. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>doc</em> </td><td>Pointer to document to add. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="3e01fdce9a6d9e25e7d98e87d0318fdf"></a><!-- doxytag: member="AppWnd::remDoc" ref="3e01fdce9a6d9e25e7d98e87d0318fdf" args="(Document *doc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AppWnd::remDoc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classDocument.html">Document</a> * </td>
<td class="paramname"> <em>doc</em> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove pointer to <a class="el" href="classDocument.html">Document</a> object from document list. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>doc</em> </td><td>Pointer to document to remove. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="c1a32a3b21d6a6d44979e3158b4d05ce"></a><!-- doxytag: member="AppWnd::Document" ref="c1a32a3b21d6a6d44979e3158b4d05ce" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classDocument.html">Document</a><code> [friend]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Needed to add/remove documents automatically.
<p>
Definition at line <a class="el" href="appwnd_8h-source.html#l00102">102</a> of file <a class="el" href="appwnd_8h-source.html">appwnd.h</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="appwnd_8h-source.html">appwnd.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 29 00:01:04 2007 for GED 2006 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>
Back to main page
classAppWnd.html [Download]