Museum

     PANEL(S)                  UNIX System V                  PANEL(S)



     Name
          panel - PANEL library routines

     Syntax
          #include <panel.h>

          cc [ flags ] files -lpanel -lcurses [ libraries ]
          PANEL *new_panel(win)
          WINDOW *win;

          WINDOW  *panel_window(panel)
          PANEL *panel;

          int replace_panel(panel, window)
          PANEL *panel;
          WINDOW *window;

          int move_panel(panel, starty, startx)
          PANEL *panel;
          int starty, startx;

          int bottom_panel(panel)
          PANEL *panel;

          int top_panel(panel)
          PANEL *panel;

          void update_panels()

          int hide_panel(panel)
          PANEL *panel;

          int panel_hidden(panel)
          PANEL *panel;

          int show_panel(panel)
          PANEL *panel;

          PANEL *panel_above(panel)
          PANEL *panel;

          PANEL *panel_below(panel)
          PANEL *panel;

          int *set_panel_userptr(panel,ptr)
          PANEL *panel;
          char *ptr;

          char *panel_userptr(panel)
          PANEL *panel;

          int del_panel(panel)
          PANEL *panel;

     Description
          Panels are rectangles of text with depth.  They enable your
          windows to overlap without having hidden portions of
          underlying windows be mistakenly visible.  stdscr lies
          beneath all panels.  The set of currently visible panels is
          the deck of panels.

          A window is associated with every panel.  The panel routines
          enable you to create panels, fetch their associated windows,
          shuffle panels in the deck, and manipulate panels in other
          ways.

          PANEL routines run on any terminal supported by curses(S),
          the low-level Extended Terminal Interface (ETI) library.
          Once you compile your ETI program #includeing the PANEL
          header file panel.h, you should link it with the panel and
          curses library routines.

     Functions
          For a complete description of each panel routine, see the
          Programmer's Guide.

          new_panel (win) returns a pointer to a new panel associated
          with win.  The new panel is placed on top of the panel deck.

          panel_window (panel) returns a pointer to the window of
          panel.

          replace_panel (panel, window) replaces the current window of
          panel with window.

          move_panel (panel, starty,  startx) moves the given panel
          window so that its upper-left corner is at starty, startx.
          Be sure to use this function, not mvwin(), to move a panel
          window.

          bottom_panel (panel) puts panel at the bottom of all panels.
          It leaves the size and contents of its associated window,
          and its relations to other panels, wholly intact.

          top_panel (panel) puts the given visible panel on top of all
          panels in the deck.

          void update_panels() refreshes the virtual screen to reflect
          the relations between the panels in the deck, but does not
          call doupdate() to refresh the physical screen.

          hide_panel (panel) removes the panel from the panel deck and
          thus hides it from view.  The panel's internal data
          structure, however, is retained.
          panel_hidden (panel) returns a boolean value indicating
          whether or not the given panel has been removed from the
          panel deck.

          show_panel (panel) makes a hidden panel visible by placing
          it on top of the panels in the panel deck.

          panel_above (panel) returns a pointer to the panel just
          above panel.  If the panel argument is NULL, i.e., (panel *)
          0, it returns a pointer to the bottom panel in the deck.

          panel_below (panel) returns a pointer to the panel just
          below panel.  If the panel argument is NULL, it returns a
          pointer to the top panel in the deck.

          set_panel_userptr (panel ,ptr) sets the panel's user
          pointer.

          panel_userptr (panel) returns the user pointer for a given
          panel.

          del_panel (panel) deletes the panel, but not its associated
          window.

     See Also
          curses(S), field(S), fieldtype(S), form(S), item(S),
          menu(S), tam(S)

     Diagnostics
          Each panel routine that returns a pointer to an object
          returns NULL if an error occurs.  Each panel routine that
          returns an int value returns OK if it executes successfully
          and ERR if not.

                                             (printed 6/20/89)