[−][src]Module ncursesw::panels
NCurses Panels module
Panels are NCurses windows with the added feature of depth. Panel functions allow
the use of stacked windows and ensure the proper portions of each window and the
NCurses stdscr() window are hidden or displayed when panels are added, moved,
modified or removed. The set of currently visible panels is the stack of panels.
The stdscr() window is beneath all panels, and is not considered part of the stack.
A window is associated with every panel. The panel routines enable you to create, move, hide, and show panels, as well as position a panel at any desired location in the stack.
Panel routines are a functional layer added to NCurses, make only high-level NCurses calls, and work anywhere terminfo NCurses does.
Enums
| NCurseswPanelsError | NCursesw panels errors. |
Functions
| bottom_panel | Puts panel at the bottom of all panels. |
| ceiling_panel | Screen function, returns a pointer to the topmost panel in the given screen. |
| del_panel | Removes the given panel from the stack and deallocates the PANEL structure (but not its associated window). |
| ground_panel | Screen function, returns a pointer to the lowest panel in the given screen. |
| hide_panel | Removes the given panel from the panel stack and thus hides it from view. The PANEL structure is not lost, merely removed from the stack. |
| move_panel | Moves the given panel window so that its upper-left corner is at origin.y, origin.x. It does not change the position of the panel in the stack. Be sure to use this function, not mvwin(), to move a panel window. |
| new_panel | Allocates a PANEL structure, associates it with win, places the panel on the top of the stack (causes it to be displayed above any other panel) and returns a pointer to the new panel. |
| panel_above | Returns a pointer to the panel above pan. If the panel argument is None, it returns a pointer to the bottom panel in the stack. |
| panel_below | Returns a pointer to the panel just below pan. If the panel argument is None, it returns a pointer to the top panel in the stack. |
| panel_hidden | Returns true if the panel is in the panel stack, false if it is not. |
| panel_userptr | Returns the user pointer for a given panel. |
| panel_window | Returns a pointer to the window of the given panel. |
| replace_panel | Replaces the current window of panel with window (useful, for example if you want to resize a panel; if you're using ncurses, you can call replace_panel() on the output of wresize(3x)). It does not change the position of the panel in the stack. |
| set_panel_userptr | Sets the panel's user pointer. |
| show_panel | Makes a hidden panel visible by placing it on top of the panels in the panel stack. |
| top_panel | Puts the given visible panel on top of all panels in the stack. |
| update_panels | Refreshes the virtual screen to reflect the relations between the panels in the stack. |
| update_panels_sp | Screen function of |
Type Definitions
| PANEL | |
| PanelUserPtr |