sam-t2/devtools/v9/html/python/lib/curses-panel-objects.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="prev" href="cursespanel-functions.html" />
<link rel="parent" href="module-curses.panel.html" />
<link rel="next" href="module-getopt.html" />
<meta name='aesop' content='information' />
<title>6.19.2 Panel Objects </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="6.19.1 Functions"
  href="cursespanel-functions.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="6.19 curses.panel  "
  href="module-curses.panel.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="6.20 getopt  "
  href="module-getopt.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="cursespanel-functions.html">6.19.1 Functions</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-curses.panel.html">6.19 curses.panel  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-getopt.html">6.20 getopt  </A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION0081920000000000000000"></A><A NAME="curses-panel-objects"></A>
<BR>
6.19.2 Panel Objects
</H2>

<P>
Panel objects, as returned by <tt class="function">new_panel()</tt> above, are windows
with a stacking order. There's always a window associated with a
panel which determines the content, while the panel methods are
responsible for the window's depth in the panel stack.

<P>
Panel objects have the following methods:

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2180' xml:id='l2h-2180' class="method">above</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns the panel above the current panel.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2181' xml:id='l2h-2181' class="method">below</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns the panel below the current panel.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2182' xml:id='l2h-2182' class="method">bottom</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Push the panel to the bottom of the stack.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2183' xml:id='l2h-2183' class="method">hidden</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns true if the panel is hidden (not visible), false otherwise.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2184' xml:id='l2h-2184' class="method">hide</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Hide the panel. This does not delete the object, it just makes the
window on screen invisible.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2185' xml:id='l2h-2185' class="method">move</tt></b>(</nobr></td>
  <td><var>y, x</var>)</td></tr></table></dt>
<dd>
Move the panel to the screen coordinates <code>(<var>y</var>, <var>x</var>)</code>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2186' xml:id='l2h-2186' class="method">replace</tt></b>(</nobr></td>
  <td><var>win</var>)</td></tr></table></dt>
<dd>
Change the window associated with the panel to the window <var>win</var>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2187' xml:id='l2h-2187' class="method">set_userptr</tt></b>(</nobr></td>
  <td><var>obj</var>)</td></tr></table></dt>
<dd>
Set the panel's user pointer to <var>obj</var>. This is used to associate an
arbitrary piece of data with the panel, and can be any Python object.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2188' xml:id='l2h-2188' class="method">show</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Display the panel (which might have been hidden).
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2189' xml:id='l2h-2189' class="method">top</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Push panel to the top of the stack.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2190' xml:id='l2h-2190' class="method">userptr</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns the user pointer for the panel.  This might be any Python object.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-2191' xml:id='l2h-2191' class="method">window</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
Returns the window object associated with the panel.
</dl>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="6.19.1 Functions"
  href="cursespanel-functions.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="6.19 curses.panel  "
  href="module-curses.panel.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="6.20 getopt  "
  href="module-getopt.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="cursespanel-functions.html">6.19.1 Functions</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-curses.panel.html">6.19 curses.panel  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="module-getopt.html">6.20 getopt  </A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>