pydoc > _curses_panel

man perldoc info pydoc3 ri search

📛 NAME

_curses_panel — Python interface to the curses panel library.

🚀 Quick Reference

Use Case	Command	Description
Create a panel	new_panel(win)	Associate a curses window with a new panel and return the panel object.
Get top/bottom panel	top_panel() / bottom_panel()	Return the panel at the top or bottom of the stack.
Move panel	panel.move(y, x)	Move the panel to screen coordinates (y, x).
Show/hide panel	panel.show() / panel.hide()	Display or hide the panel on the screen.
Stack manipulation	panel.top() / panel.bottom()	Push panel to the top or bottom of the stack.
Get adjacent panel	panel.above() / panel.below()	Return the panel above or below the current panel.
Replace window	panel.replace(win)	Change the associated window of the panel.
Set/get user pointer	panel.set_userptr(obj) / panel.userptr()	Attach/retrieve arbitrary data to the panel.
Check visibility	panel.hidden()	Return True if the panel is hidden (not visible).
Update virtual screen	update_panels()	Synchronize the virtual screen with panel stack changes; call curses.doupdate() afterward.

📚 Module Reference

https://docs.python.org/3.10/library/_curses_panel.html

The following documentation is automatically generated from the Python source files. It may be incomplete, incorrect or include features that are considered implementation detail and may vary between Python implementations. When in doubt, consult the module reference at the location listed above.

📦 Classes

🔴 error

Inherits from builtins.Exception.

Method resolution order:
error → builtins.Exception → builtins.BaseException → builtins.object

Data descriptors defined here:

• __weakref__ — list of weak references to the object (if defined)

Methods inherited from builtins.Exception:

• __init__(self, /, *args, **kwargs) — Initialize self. See help(type(self)) for accurate signature.

Static methods inherited from builtins.Exception:

• __new__(*args, **kwargs) from builtins.type — Create and return a new object. See help(type) for accurate signature.

Methods inherited from builtins.BaseException:

• __delattr__(self, name, /) — Implement delattr(self, name).
• __getattribute__(self, name, /) — Return getattr(self, name).
• __reduce__(...) — Helper for pickle.
• __repr__(self, /) — Return repr(self).
• __setattr__(self, name, value, /) — Implement setattr(self, name, value).
• __setstate__(...)
• __str__(self, /) — Return str(self).
• with_traceback(...) — Exception.with_traceback(tb) — set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:

• __cause__ — exception cause
• __context__ — exception context
• __dict__
• __suppress_context__
• __traceback__
• args

🖼️ panel

Inherits from builtins.object.

Methods defined here:

• above(self, /) — Return the panel above the current panel.
• below(self, /) — Return the panel below the current panel.
• bottom(self, /) — Push the panel to the bottom of the stack.
• hidden(self, /) — Return True if the panel is hidden (not visible), False otherwise.
• hide(self, /) — Hide the panel. This does not delete the object, it just makes the window on screen invisible.
• move(self, y, x, /) — Move the panel to the screen coordinates (y, x).
• replace(self, win, /) — Change the window associated with the panel to the window win.
• set_userptr(self, obj, /) — Set the panel's user pointer to obj.
• show(self, /) — Display the panel (which might have been hidden).
• top(self, /) — Push panel to the top of the stack.
• userptr(self, /) — Return the user pointer for the panel.
• window(self, /) — Return the window object associated with the panel.

🔧 Functions

• bottom_panel() — Return the bottom panel in the panel stack.
• new_panel(win, /) — Return a panel object, associating it with the given window win.
• top_panel() — Return the top panel in the panel stack.
• update_panels() — Updates the virtual screen after changes in the panel stack. This does not call curses.doupdate(), so you'll have to do this yourself.

📊 Data

version = '2.1'

📄 Version

2.1

📁 File

/usr/lib/python3.10/lib-dynload/_curses_panel.cpython-310-x86_64-linux-gnu.so

📛 NAME 🚀 Quick Reference 📚 Module Reference 📦 Classes 🔧 Functions 📊 Data 📄 Version 📁 File