<!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>GG: GG::ZList 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">GG
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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="namespaceGG.html">GG</a></li><li class="navelem"><a class="el" href="classGG_1_1ZList.html">ZList</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">GG::ZList Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="ZList_8h_source.html">ZList.h</a>></code></p>
<p><a href="classGG_1_1ZList-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Accessors</h2></td></tr>
<tr class="memitem:ab01fe59b4a2bba7fab5fa494761aaa68"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGG_1_1Wnd.html">Wnd</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1ZList.html#ab01fe59b4a2bba7fab5fa494761aaa68">Pick</a> (const <a class="el" href="structGG_1_1Pt.html">Pt</a> &pt, <a class="el" href="classGG_1_1Wnd.html">Wnd</a> *modal, const std::set< <a class="el" href="classGG_1_1Wnd.html">Wnd</a> * > *ignore=0) const </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Mutators</h2></td></tr>
<tr class="memitem:a9a9301216c990348b7c04af16a473145"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1ZList.html#a9a9301216c990348b7c04af16a473145">Add</a> (<a class="el" href="classGG_1_1Wnd.html">Wnd</a> *wnd)</td></tr>
<tr class="memitem:a052ccd1d29c6660fef3b971ffd6249d9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a052ccd1d29c6660fef3b971ffd6249d9"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1ZList.html#a052ccd1d29c6660fef3b971ffd6249d9">Remove</a> (<a class="el" href="classGG_1_1Wnd.html">Wnd</a> *wnd)</td></tr>
<tr class="memitem:a3b61f87b3776407983039150ce2b5223"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1ZList.html#a3b61f87b3776407983039150ce2b5223">MoveUp</a> (<a class="el" href="classGG_1_1Wnd.html">Wnd</a> *wnd)</td></tr>
<tr class="memitem:a41d418c42bed74f862116a15808037a1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1ZList.html#a41d418c42bed74f862116a15808037a1">MoveDown</a> (<a class="el" href="classGG_1_1Wnd.html">Wnd</a> *wnd)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A Z-ordering (depth-ordering) of the windows in the <a class="el" href="classGG_1_1GUI.html" title="An abstract base for an GUI framework class to drive the GG GUI.">GUI</a>. </p>
<p>Windows being moved up, inserted, or added to the top of the list are checked against other windows at the insertion point and after; if any of these windows are modal or on-top windows, the inserted window is placed after them if it is not also modal or on-top. Z-values decrease into the screen. Windows in the z-list are kept in front-to-back order. No windows may share the same z-value. Add, Remove, MoveUp, and MoveDown all also add/remove/move all descendent windows. </p>
<p>Definition at line <a class="el" href="ZList_8h_source.html#l00050">50</a> of file <a class="el" href="ZList_8h_source.html">ZList.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab01fe59b4a2bba7fab5fa494761aaa68"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGG_1_1Wnd.html">Wnd</a>* GG::ZList::Pick </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structGG_1_1Pt.html">Pt</a> & </td>
<td class="paramname"><em>pt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classGG_1_1Wnd.html">Wnd</a> * </td>
<td class="paramname"><em>modal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::set< <a class="el" href="classGG_1_1Wnd.html">Wnd</a> * > * </td>
<td class="paramname"><em>ignore</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns pointer to the window under the point pt; constrains pick to modal if nonzero, and ignores <em>ignore</em> if nonzero. </p>
</div>
</div>
<a class="anchor" id="a9a9301216c990348b7c04af16a473145"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GG::ZList::Add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGG_1_1Wnd.html">Wnd</a> * </td>
<td class="paramname"><em>wnd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classGG_1_1ZList.html#a9a9301216c990348b7c04af16a473145">Add()</a> places <em>wnd</em> in the list in front of the first entry with z-value <= wnd->ZOrder(), or at the end of the list, whichever comes first. If wnd->ZOrder() == 0, <a class="el" href="classGG_1_1ZList.html#a9a9301216c990348b7c04af16a473145">Add()</a> inserts <em>wnd</em> at the front of the list, and updates <em>wnd's</em> z-value. </p>
</div>
</div>
<a class="anchor" id="a3b61f87b3776407983039150ce2b5223"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool GG::ZList::MoveUp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGG_1_1Wnd.html">Wnd</a> * </td>
<td class="paramname"><em>wnd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Moves <em>wnd</em> from its current position to the beginning of list; updates wnd's z-value. </p>
</div>
</div>
<a class="anchor" id="a41d418c42bed74f862116a15808037a1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool GG::ZList::MoveDown </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGG_1_1Wnd.html">Wnd</a> * </td>
<td class="paramname"><em>wnd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Moves <em>wnd</em> from its current position to the end of list; updates wnd's z-value. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="ZList_8h_source.html">ZList.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 15 2012 15:13:32 for GG by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1
</small></address>
</body>
</html>
