mirror of
https://github.com/python/cpython.git
synced 2025-08-17 23:31:09 +00:00
f18d5cea53
svn+ssh://pythondev@svn.python.org/python/trunk ........ r73286 | georg.brandl | 2009-06-08 09:57:35 +0200 (Mo, 08 Jun 2009) | 1 line Remove period from end of headings. ........ r73294 | georg.brandl | 2009-06-08 15:34:52 +0200 (Mo, 08 Jun 2009) | 1 line #6194: O_SHLOCK/O_EXLOCK are not really more platform independent than lockf(). ........ r73296 | georg.brandl | 2009-06-08 18:03:41 +0200 (Mo, 08 Jun 2009) | 1 line #6238: add fillchar to string.just function family. ........ r73459 | raymond.hettinger | 2009-06-17 03:43:47 +0200 (Mi, 17 Jun 2009) | 1 line Add usage note. ........ r73462 | georg.brandl | 2009-06-17 11:36:21 +0200 (Mi, 17 Jun 2009) | 1 line #6295: clarify blocking behavior of getch(). ........ r73463 | georg.brandl | 2009-06-17 11:43:31 +0200 (Mi, 17 Jun 2009) | 1 line #6255: document PyInt_FromSize_t. ........ r73544 | georg.brandl | 2009-06-24 08:41:19 +0200 (Mi, 24 Jun 2009) | 1 line #6332: fix word dupes throughout the source. ........ r73576 | benjamin.peterson | 2009-06-27 01:37:06 +0200 (Sa, 27 Jun 2009) | 1 line document is_declared_global() ........ r73577 | benjamin.peterson | 2009-06-27 16:16:23 +0200 (Sa, 27 Jun 2009) | 1 line link to extensive generator docs in the reference manual ........ r73595 | ezio.melotti | 2009-06-28 01:45:39 +0200 (So, 28 Jun 2009) | 1 line stmt and setup can contain multiple statements, see #5896 ........ r73596 | ezio.melotti | 2009-06-28 02:07:45 +0200 (So, 28 Jun 2009) | 1 line Fixed a wrong apostrophe ........ r73693 | jesse.noller | 2009-06-29 20:20:34 +0200 (Mo, 29 Jun 2009) | 1 line Bug 5906: add a documentation note for unix daemons vs. multiprocessing daemons ........ r73694 | jesse.noller | 2009-06-29 20:24:26 +0200 (Mo, 29 Jun 2009) | 1 line Issue 5740: multiprocessing.connection.* authkey fixes ........ r73704 | georg.brandl | 2009-06-30 18:15:43 +0200 (Di, 30 Jun 2009) | 1 line #6376: fix copy-n-paste oversight. ........ r73705 | georg.brandl | 2009-06-30 18:17:28 +0200 (Di, 30 Jun 2009) | 1 line #6374: add a bit of explanation about shell=True on Windows. ........ r73707 | georg.brandl | 2009-06-30 18:35:11 +0200 (Di, 30 Jun 2009) | 1 line #6371: fix link targets. ........ r73713 | ezio.melotti | 2009-07-01 00:56:16 +0200 (Mi, 01 Jul 2009) | 1 line Fixed a backslash that was not supposed to be there ........ r73937 | georg.brandl | 2009-07-11 12:12:36 +0200 (Sa, 11 Jul 2009) | 1 line Fix style. ........ r73938 | georg.brandl | 2009-07-11 12:14:54 +0200 (Sa, 11 Jul 2009) | 1 line #6446: fix import_spam() function to use correct error and reference handling. ........ r73939 | georg.brandl | 2009-07-11 12:18:10 +0200 (Sa, 11 Jul 2009) | 1 line #6448: clarify docs for find_module(). ........ r73940 | georg.brandl | 2009-07-11 12:37:38 +0200 (Sa, 11 Jul 2009) | 1 line #6430: add note about size of "u" type. ........ r73945 | georg.brandl | 2009-07-11 12:51:31 +0200 (Sa, 11 Jul 2009) | 1 line #6456: clarify the meaning of constants used as arguments to nl_langinfo(). ........ r73951 | georg.brandl | 2009-07-11 16:23:38 +0200 (Sa, 11 Jul 2009) | 2 lines array.array is actually a class. ........ r73979 | benjamin.peterson | 2009-07-12 18:56:54 +0200 (So, 12 Jul 2009) | 1 line add versionadded ........
118 lines
2.7 KiB
ReStructuredText
118 lines
2.7 KiB
ReStructuredText
:mod:`curses.panel` --- A panel stack extension for curses
|
|
==========================================================
|
|
|
|
.. module:: curses.panel
|
|
:synopsis: A panel stack extension that adds depth to curses windows.
|
|
.. sectionauthor:: A.M. Kuchling <amk@amk.ca>
|
|
|
|
|
|
Panels are windows with the added feature of depth, so they can be stacked on
|
|
top of each other, and only the visible portions of each window will be
|
|
displayed. Panels can be added, moved up or down in the stack, and removed.
|
|
|
|
|
|
.. _cursespanel-functions:
|
|
|
|
Functions
|
|
---------
|
|
|
|
The module :mod:`curses.panel` defines the following functions:
|
|
|
|
|
|
.. function:: bottom_panel()
|
|
|
|
Returns the bottom panel in the panel stack.
|
|
|
|
|
|
.. function:: new_panel(win)
|
|
|
|
Returns a panel object, associating it with the given window *win*. Be aware
|
|
that you need to keep the returned panel object referenced explicitly. If you
|
|
don't, the panel object is garbage collected and removed from the panel stack.
|
|
|
|
|
|
.. function:: top_panel()
|
|
|
|
Returns the top panel in the panel stack.
|
|
|
|
|
|
.. function:: update_panels()
|
|
|
|
Updates the virtual screen after changes in the panel stack. This does not call
|
|
:func:`curses.doupdate`, so you'll have to do this yourself.
|
|
|
|
|
|
.. _curses-panel-objects:
|
|
|
|
Panel Objects
|
|
-------------
|
|
|
|
Panel objects, as returned by :func:`new_panel` 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.
|
|
|
|
Panel objects have the following methods:
|
|
|
|
|
|
.. method:: Panel.above()
|
|
|
|
Returns the panel above the current panel.
|
|
|
|
|
|
.. method:: Panel.below()
|
|
|
|
Returns the panel below the current panel.
|
|
|
|
|
|
.. method:: Panel.bottom()
|
|
|
|
Push the panel to the bottom of the stack.
|
|
|
|
|
|
.. method:: Panel.hidden()
|
|
|
|
Returns true if the panel is hidden (not visible), false otherwise.
|
|
|
|
|
|
.. method:: Panel.hide()
|
|
|
|
Hide the panel. This does not delete the object, it just makes the window on
|
|
screen invisible.
|
|
|
|
|
|
.. method:: Panel.move(y, x)
|
|
|
|
Move the panel to the screen coordinates ``(y, x)``.
|
|
|
|
|
|
.. method:: Panel.replace(win)
|
|
|
|
Change the window associated with the panel to the window *win*.
|
|
|
|
|
|
.. method:: Panel.set_userptr(obj)
|
|
|
|
Set the panel's user pointer to *obj*. This is used to associate an arbitrary
|
|
piece of data with the panel, and can be any Python object.
|
|
|
|
|
|
.. method:: Panel.show()
|
|
|
|
Display the panel (which might have been hidden).
|
|
|
|
|
|
.. method:: Panel.top()
|
|
|
|
Push panel to the top of the stack.
|
|
|
|
|
|
.. method:: Panel.userptr()
|
|
|
|
Returns the user pointer for the panel. This might be any Python object.
|
|
|
|
|
|
.. method:: Panel.window()
|
|
|
|
Returns the window object associated with the panel.
|
|
|