| 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 2 | <html> |
| 3 | <head> |
| 4 | <link rel="STYLESHEET" href="lib.css" type='text/css' /> |
| 5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> |
| 6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> |
| 7 | <link rel="first" href="lib.html" title='Python Library Reference' /> |
| 8 | <link rel='contents' href='contents.html' title="Contents" /> |
| 9 | <link rel='index' href='genindex.html' title='Index' /> |
| 10 | <link rel='last' href='about.html' title='About this document...' /> |
| 11 | <link rel='help' href='about.html' title='About this document...' /> |
| 12 | <link rel="prev" href="cursespanel-functions.html" /> |
| 13 | <link rel="parent" href="module-curses.panel.html" /> |
| 14 | <link rel="next" href="module-getopt.html" /> |
| 15 | <meta name='aesop' content='information' /> |
| 16 | <title>6.19.2 Panel Objects </title> |
| 17 | </head> |
| 18 | <body> |
| 19 | <DIV CLASS="navigation"> |
| 20 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> |
| 21 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> |
| 22 | <tr> |
| 23 | <td class='online-navigation'><a rel="prev" title="6.19.1 Functions" |
| 24 | href="cursespanel-functions.html"><img src='../icons/previous.png' |
| 25 | border='0' height='32' alt='Previous Page' width='32' /></A></td> |
| 26 | <td class='online-navigation'><a rel="parent" title="6.19 curses.panel " |
| 27 | href="module-curses.panel.html"><img src='../icons/up.png' |
| 28 | border='0' height='32' alt='Up One Level' width='32' /></A></td> |
| 29 | <td class='online-navigation'><a rel="next" title="6.20 getopt " |
| 30 | href="module-getopt.html"><img src='../icons/next.png' |
| 31 | border='0' height='32' alt='Next Page' width='32' /></A></td> |
| 32 | <td align="center" width="100%">Python Library Reference</td> |
| 33 | <td class='online-navigation'><a rel="contents" title="Table of Contents" |
| 34 | href="contents.html"><img src='../icons/contents.png' |
| 35 | border='0' height='32' alt='Contents' width='32' /></A></td> |
| 36 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' |
| 37 | border='0' height='32' alt='Module Index' width='32' /></a></td> |
| 38 | <td class='online-navigation'><a rel="index" title="Index" |
| 39 | href="genindex.html"><img src='../icons/index.png' |
| 40 | border='0' height='32' alt='Index' width='32' /></A></td> |
| 41 | </tr></table> |
| 42 | <div class='online-navigation'> |
| 43 | <b class="navlabel">Previous:</b> |
| 44 | <a class="sectref" rel="prev" href="cursespanel-functions.html">6.19.1 Functions</A> |
| 45 | <b class="navlabel">Up:</b> |
| 46 | <a class="sectref" rel="parent" href="module-curses.panel.html">6.19 curses.panel </A> |
| 47 | <b class="navlabel">Next:</b> |
| 48 | <a class="sectref" rel="next" href="module-getopt.html">6.20 getopt </A> |
| 49 | </div> |
| 50 | <hr /></div> |
| 51 | </DIV> |
| 52 | <!--End of Navigation Panel--> |
| 53 | |
| 54 | <H2><A NAME="SECTION0081920000000000000000"></A><A NAME="curses-panel-objects"></A> |
| 55 | <BR> |
| 56 | 6.19.2 Panel Objects |
| 57 | </H2> |
| 58 | |
| 59 | <P> |
| 60 | Panel objects, as returned by <tt class="function">new_panel()</tt> above, are windows |
| 61 | with a stacking order. There's always a window associated with a |
| 62 | panel which determines the content, while the panel methods are |
| 63 | responsible for the window's depth in the panel stack. |
| 64 | |
| 65 | <P> |
| 66 | Panel objects have the following methods: |
| 67 | |
| 68 | <P> |
| 69 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> |
| 70 | <td><nobr><b><tt id='l2h-2180' xml:id='l2h-2180' class="method">above</tt></b>(</nobr></td> |
| 71 | <td><var></var>)</td></tr></table></dt> |
| 72 | <dd> |
| 73 | Returns the panel above the current panel. |
| 74 | </dl> |
| 75 | |
| 76 | <P> |
| 77 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> |
| 78 | <td><nobr><b><tt id='l2h-2181' xml:id='l2h-2181' class="method">below</tt></b>(</nobr></td> |
| 79 | <td><var></var>)</td></tr></table></dt> |
| 80 | <dd> |
| 81 | Returns the panel below the current panel. |
| 82 | </dl> |
| 83 | |
| 84 | <P> |
| 85 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> |
| 86 | <td><nobr><b><tt id='l2h-2182' xml:id='l2h-2182' class="method">bottom</tt></b>(</nobr></td> |
| 87 | <td><var></var>)</td></tr></table></dt> |
| 88 | <dd> |
| 89 | Push the panel to the bottom of the stack. |
| 90 | </dl> |
| 91 | |
| 92 | <P> |
| 93 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> |
| 94 | <td><nobr><b><tt id='l2h-2183' xml:id='l2h-2183' class="method">hidden</tt></b>(</nobr></td> |
| 95 | <td><var></var>)</td></tr></table></dt> |
| 96 | <dd> |
| 97 | Returns true if the panel is hidden (not visible), false otherwise. |
| 98 | </dl> |
| 99 | |
| 100 | <P> |
| 101 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> |
| 102 | <td><nobr><b><tt id='l2h-2184' xml:id='l2h-2184' class="method">hide</tt></b>(</nobr></td> |
| 103 | <td><var></var>)</td></tr></table></dt> |
| 104 | <dd> |
| 105 | Hide the panel. This does not delete the object, it just makes the |
| 106 | window on screen invisible. |
| 107 | </dl> |
| 108 | |
| 109 | <P> |
| 110 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> |
| 111 | <td><nobr><b><tt id='l2h-2185' xml:id='l2h-2185' class="method">move</tt></b>(</nobr></td> |
| 112 | <td><var>y, x</var>)</td></tr></table></dt> |
| 113 | <dd> |
| 114 | Move the panel to the screen coordinates <code>(<var>y</var>, <var>x</var>)</code>. |
| 115 | </dl> |
| 116 | |
| 117 | <P> |
| 118 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> |
| 119 | <td><nobr><b><tt id='l2h-2186' xml:id='l2h-2186' class="method">replace</tt></b>(</nobr></td> |
| 120 | <td><var>win</var>)</td></tr></table></dt> |
| 121 | <dd> |
| 122 | Change the window associated with the panel to the window <var>win</var>. |
| 123 | </dl> |
| 124 | |
| 125 | <P> |
| 126 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> |
| 127 | <td><nobr><b><tt id='l2h-2187' xml:id='l2h-2187' class="method">set_userptr</tt></b>(</nobr></td> |
| 128 | <td><var>obj</var>)</td></tr></table></dt> |
| 129 | <dd> |
| 130 | Set the panel's user pointer to <var>obj</var>. This is used to associate an |
| 131 | arbitrary piece of data with the panel, and can be any Python object. |
| 132 | </dl> |
| 133 | |
| 134 | <P> |
| 135 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> |
| 136 | <td><nobr><b><tt id='l2h-2188' xml:id='l2h-2188' class="method">show</tt></b>(</nobr></td> |
| 137 | <td><var></var>)</td></tr></table></dt> |
| 138 | <dd> |
| 139 | Display the panel (which might have been hidden). |
| 140 | </dl> |
| 141 | |
| 142 | <P> |
| 143 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> |
| 144 | <td><nobr><b><tt id='l2h-2189' xml:id='l2h-2189' class="method">top</tt></b>(</nobr></td> |
| 145 | <td><var></var>)</td></tr></table></dt> |
| 146 | <dd> |
| 147 | Push panel to the top of the stack. |
| 148 | </dl> |
| 149 | |
| 150 | <P> |
| 151 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> |
| 152 | <td><nobr><b><tt id='l2h-2190' xml:id='l2h-2190' class="method">userptr</tt></b>(</nobr></td> |
| 153 | <td><var></var>)</td></tr></table></dt> |
| 154 | <dd> |
| 155 | Returns the user pointer for the panel. This might be any Python object. |
| 156 | </dl> |
| 157 | |
| 158 | <P> |
| 159 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> |
| 160 | <td><nobr><b><tt id='l2h-2191' xml:id='l2h-2191' class="method">window</tt></b>(</nobr></td> |
| 161 | <td><var></var>)</td></tr></table></dt> |
| 162 | <dd> |
| 163 | Returns the window object associated with the panel. |
| 164 | </dl> |
| 165 | |
| 166 | <DIV CLASS="navigation"> |
| 167 | <div class='online-navigation'> |
| 168 | <p></p><hr /> |
| 169 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> |
| 170 | <tr> |
| 171 | <td class='online-navigation'><a rel="prev" title="6.19.1 Functions" |
| 172 | href="cursespanel-functions.html"><img src='../icons/previous.png' |
| 173 | border='0' height='32' alt='Previous Page' width='32' /></A></td> |
| 174 | <td class='online-navigation'><a rel="parent" title="6.19 curses.panel " |
| 175 | href="module-curses.panel.html"><img src='../icons/up.png' |
| 176 | border='0' height='32' alt='Up One Level' width='32' /></A></td> |
| 177 | <td class='online-navigation'><a rel="next" title="6.20 getopt " |
| 178 | href="module-getopt.html"><img src='../icons/next.png' |
| 179 | border='0' height='32' alt='Next Page' width='32' /></A></td> |
| 180 | <td align="center" width="100%">Python Library Reference</td> |
| 181 | <td class='online-navigation'><a rel="contents" title="Table of Contents" |
| 182 | href="contents.html"><img src='../icons/contents.png' |
| 183 | border='0' height='32' alt='Contents' width='32' /></A></td> |
| 184 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' |
| 185 | border='0' height='32' alt='Module Index' width='32' /></a></td> |
| 186 | <td class='online-navigation'><a rel="index" title="Index" |
| 187 | href="genindex.html"><img src='../icons/index.png' |
| 188 | border='0' height='32' alt='Index' width='32' /></A></td> |
| 189 | </tr></table> |
| 190 | <div class='online-navigation'> |
| 191 | <b class="navlabel">Previous:</b> |
| 192 | <a class="sectref" rel="prev" href="cursespanel-functions.html">6.19.1 Functions</A> |
| 193 | <b class="navlabel">Up:</b> |
| 194 | <a class="sectref" rel="parent" href="module-curses.panel.html">6.19 curses.panel </A> |
| 195 | <b class="navlabel">Next:</b> |
| 196 | <a class="sectref" rel="next" href="module-getopt.html">6.20 getopt </A> |
| 197 | </div> |
| 198 | </div> |
| 199 | <hr /> |
| 200 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> |
| 201 | </DIV> |
| 202 | <!--End of Navigation Panel--> |
| 203 | <ADDRESS> |
| 204 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. |
| 205 | </ADDRESS> |
| 206 | </BODY> |
| 207 | </HTML> |