1panels(3CURSES)            Curses Library Functions            panels(3CURSES)
2
3
4

NAME

6       panels - character based panels package
7

SYNOPSIS

9       #include <panel.h>
10
11

DESCRIPTION

13       The  panel  library  is built using the curses library, and any program
14       using panels routines must call one of the curses  initialization  rou‐
15       tines  such as initscr. A program using these routines must be compiled
16       with -lpanel and -lcurses on the cc command line.
17
18
19       The panels package gives the applications  programmer  a  way  to  have
20       depth  relationships between curses windows; a curses window is associ‐
21       ated with every panel. The panels  routines  allow  curses  windows  to
22       overlap  without  making  visible the overlapped portions of underlying
23       windows. The initial curses window, stdscr, lies  beneath  all  panels.
24       The set of currently visible panels is the deck of panels.
25
26
27       The panels package allows the applications programmer to create panels,
28       fetch and set their associated windows, shuffle panels in the deck, and
29       manipulate panels in other ways.
30
31   Routine Name Index
32       The  following table lists each panels routine and the name of the man‐
33       ual page on which it is described.
34
35
36
37
38           panels Routine Name             Manual Page Name
39       bottom_panel                  panel_top(3CURSES)
40       del_panel                     panel_new(3CURSES)
41       hide_panel                    panel_show(3CURSES)
42       move_panel                    panel_move(3CURSES)
43       new_panel                     panel_new(3CURSES)
44       panel_above                   panel_above(3CURSES)
45       panel_below                   panel_above(3CURSES)
46       panel_hidden                  panel_show(3CURSES)
47       panel_userptr                 panel_userptr(3CURSES)
48       panel_window                  panel_window(3CURSES)
49       replace_panel                 panel_window(3CURSES)
50       set_panel_userptr             panel_userptr(3CURSES)
51       show_panel                    panel_show(3CURSES)
52       top_panel                     panel_top(3CURSES)
53       update_panels                 panel_update(3CURSES)
54
55

RETURN VALUES

57       Each panels routine that returns a pointer to an object returns NULL if
58       an error occurs. Each panel routine that returns an integer, returns OK
59       if it executes successfully and ERR if it does not.
60

ATTRIBUTES

62       See attributes(5) for descriptions of the following attributes:
63
64
65
66
67       ┌─────────────────────────────┬─────────────────────────────┐
68       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
69       ├─────────────────────────────┼─────────────────────────────┤
70       │MT-Level                     │Unsafe                       │
71       └─────────────────────────────┴─────────────────────────────┘
72

SEE ALSO

74       curses(3CURSES), attributes(5) and 3X pages whose names begin  "panel_"
75       for detailed routine descriptions.
76

NOTES

78       The header <panel.h> automatically includes the header <curses.h>.
79
80
81
82SunOS 5.11                        31 Dec 1996                  panels(3CURSES)
Impressum