<!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.gif" /> <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 http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <meta name='aesop' content='information' /> <META name="description" content="Panel Objects "> <META name="keywords" content="lib"> <META name="resource-type" content="document"> <META name="distribution" content="global"> <title>6.18.2 Panel Objects </title> </head> <body> <DIV CLASS="navigation"> <div id='top-navigation-panel'> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td class='online-navigation'><a rel="prev" title="6.18.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.18 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.19 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.18.1 Functions</A> <b class="navlabel">Up:</b> <a class="sectref" rel="parent" href="module-curses.panel.html">6.18 curses.panel </A> <b class="navlabel">Next:</b> <a class="sectref" rel="next" href="module-getopt.html">6.19 getopt </A> </div> <hr /></div> </DIV> <!--End of Navigation Panel--> <H2><A NAME="SECTION0081820000000000000000"><!--x--></A><A NAME="curses-panel-objects"><!--z--></A> <BR> 6.18.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-1989' class="method">above</tt></b>(</nobr></td> <td>)</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-1990' class="method">below</tt></b>(</nobr></td> <td>)</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-1991' class="method">bottom</tt></b>(</nobr></td> <td>)</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-1992' class="method">hidden</tt></b>(</nobr></td> <td>)</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-1993' class="method">hide</tt></b>(</nobr></td> <td>)</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-1994' 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-1995' 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-1996' 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-1997' class="method">show</tt></b>(</nobr></td> <td>)</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-1998' class="method">top</tt></b>(</nobr></td> <td>)</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-1999' class="method">userptr</tt></b>(</nobr></td> <td>)</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-2000' class="method">window</tt></b>(</nobr></td> <td>)</td></tr></table></dt> <dd> Returns the window object associated with the panel. </dl> <DIV CLASS="navigation"> <div class='online-navigation'><hr /> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td class='online-navigation'><a rel="prev" title="6.18.1 Functions" rel="prev" title="6.18.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.18 curses.panel " rel="parent" title="6.18 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.19 getopt " rel="next" title="6.19 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" 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" 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.18.1 Functions</A> <b class="navlabel">Up:</b> <a class="sectref" rel="parent" href="module-curses.panel.html">6.18 curses.panel </A> <b class="navlabel">Next:</b> <a class="sectref" rel="next" href="module-getopt.html">6.19 getopt </A> </div> </div> <hr /> <span class="release-info">Release 2.3.4, documentation updated on May 20, 2004.</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>
