diff options
author | Georg Brandl <georg@python.org> | 2007-08-15 14:27:07 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2007-08-15 14:27:07 (GMT) |
commit | 739c01d47b9118d04e5722333f0e6b4d0c8bdd9e (patch) | |
tree | f82b450d291927fc1758b96d981aa0610947b529 /Doc/lib/libcursespanel.tex | |
parent | 2d1649094402ef393ea2b128ba2c08c3937e6b93 (diff) | |
download | cpython-739c01d47b9118d04e5722333f0e6b4d0c8bdd9e.zip cpython-739c01d47b9118d04e5722333f0e6b4d0c8bdd9e.tar.gz cpython-739c01d47b9118d04e5722333f0e6b4d0c8bdd9e.tar.bz2 |
Delete the LaTeX doc tree.
Diffstat (limited to 'Doc/lib/libcursespanel.tex')
-rw-r--r-- | Doc/lib/libcursespanel.tex | 96 |
1 files changed, 0 insertions, 96 deletions
diff --git a/Doc/lib/libcursespanel.tex b/Doc/lib/libcursespanel.tex deleted file mode 100644 index 14d83e3..0000000 --- a/Doc/lib/libcursespanel.tex +++ /dev/null @@ -1,96 +0,0 @@ -\section{\module{curses.panel} --- - A panel stack extension for curses.} - -\declaremodule{standard}{curses.panel} -\sectionauthor{A.M. Kuchling}{amk@amk.ca} -\modulesynopsis{A panel stack extension that adds depth to - curses windows.} - -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. - -\subsection{Functions \label{cursespanel-functions}} - -The module \module{curses.panel} defines the following functions: - - -\begin{funcdesc}{bottom_panel}{} -Returns the bottom panel in the panel stack. -\end{funcdesc} - -\begin{funcdesc}{new_panel}{win} -Returns a panel object, associating it with the given window \var{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. -\end{funcdesc} - -\begin{funcdesc}{top_panel}{} -Returns the top panel in the panel stack. -\end{funcdesc} - -\begin{funcdesc}{update_panels}{} -Updates the virtual screen after changes in the panel stack. This does -not call \function{curses.doupdate()}, so you'll have to do this yourself. -\end{funcdesc} - -\subsection{Panel Objects \label{curses-panel-objects}} - -Panel objects, as returned by \function{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: - -\begin{methoddesc}[Panel]{above}{} -Returns the panel above the current panel. -\end{methoddesc} - -\begin{methoddesc}[Panel]{below}{} -Returns the panel below the current panel. -\end{methoddesc} - -\begin{methoddesc}[Panel]{bottom}{} -Push the panel to the bottom of the stack. -\end{methoddesc} - -\begin{methoddesc}[Panel]{hidden}{} -Returns true if the panel is hidden (not visible), false otherwise. -\end{methoddesc} - -\begin{methoddesc}[Panel]{hide}{} -Hide the panel. This does not delete the object, it just makes the -window on screen invisible. -\end{methoddesc} - -\begin{methoddesc}[Panel]{move}{y, x} -Move the panel to the screen coordinates \code{(\var{y}, \var{x})}. -\end{methoddesc} - -\begin{methoddesc}[Panel]{replace}{win} -Change the window associated with the panel to the window \var{win}. -\end{methoddesc} - -\begin{methoddesc}[Panel]{set_userptr}{obj} -Set the panel's user pointer to \var{obj}. This is used to associate an -arbitrary piece of data with the panel, and can be any Python object. -\end{methoddesc} - -\begin{methoddesc}[Panel]{show}{} -Display the panel (which might have been hidden). -\end{methoddesc} - -\begin{methoddesc}[Panel]{top}{} -Push panel to the top of the stack. -\end{methoddesc} - -\begin{methoddesc}[Panel]{userptr}{} -Returns the user pointer for the panel. This might be any Python object. -\end{methoddesc} - -\begin{methoddesc}[Panel]{window}{} -Returns the window object associated with the panel. -\end{methoddesc} |