X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fpanel.3x.html;h=5867e5019425e6f25b41efbc08b1fb5a71b67f98;hp=ae39a4aae2cc4775215eca73e0b67f63b8671d89;hb=ce4803687b821efbc5fb2c5a5f06d69cd4dc2656;hpb=70322aa06a4a97ebff76d2869ad923cdf51ee0a9 diff --git a/doc/html/man/panel.3x.html b/doc/html/man/panel.3x.html index ae39a4aa..5867e501 100644 --- a/doc/html/man/panel.3x.html +++ b/doc/html/man/panel.3x.html @@ -1,7 +1,6 @@ - + + + panel 3x -

panel 3x

-
+

panel 3x

-
 panel(3x)                                                     panel(3x)
 
 
 
 
-
-

NAME

+

NAME

        panel - panel stack extension for curses
 
 
-
-

SYNOPSIS

+

SYNOPSIS

        #include <panel.h>
 
        cc [flags] sourcefiles -lpanel -lncurses
 
-       PANEL *new_panel(WINDOW *win)
-       int bottom_panel(PANEL *pan)
-       int top_panel(PANEL *pan)
-       int show_panel(PANEL *pan)
+       PANEL *new_panel(WINDOW *win);
+       int bottom_panel(PANEL *pan);
+       int top_panel(PANEL *pan);
+       int show_panel(PANEL *pan);
        void update_panels();
-       int hide_panel(PANEL *pan)
-       WINDOW *panel_window(const PANEL *pan)
-       int replace_panel(PANEL *pan, WINDOW *window)
-       int move_panel(PANEL *pan, int starty, int startx)
-       int panel_hidden(const PANEL *pan)
-       PANEL *panel_above(const PANEL *pan)
-       PANEL *panel_below(const PANEL *pan)
-       int set_panel_userptr(PANEL *pan, const void *ptr)
-       const void *panel_userptr(const PANEL *pan)
-       int del_panel(PANEL *pan)
-
-
-
-

DESCRIPTION

+       int hide_panel(PANEL *pan);
+       WINDOW *panel_window(const PANEL *pan);
+       int replace_panel(PANEL *pan, WINDOW *window);
+       int move_panel(PANEL *pan, int starty, int startx);
+       int panel_hidden(const PANEL *pan);
+       PANEL *panel_above(const PANEL *pan);
+       PANEL *panel_below(const PANEL *pan);
+       int set_panel_userptr(PANEL *pan, const void *ptr);
+       const void *panel_userptr(const PANEL *pan);
+       int del_panel(PANEL *pan);
+
+
+

DESCRIPTION

        Panels  are  curses(3x)  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
@@ -94,21 +91,20 @@
        minfo curses does.
 
 
-
-

FUNCTIONS

+

FUNCTIONS

        new_panel(win)
               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.
 
-       update_panels()
+       update_panels
               refreshes the virtual screen to reflect  the  rela-
               tions between the panels in the stack, but does not
-              call doupdate() to  refresh  the  physical  screen.
-              Use this function and not wrefresh or wnoutrefresh.
+              call doupdate to refresh the physical screen.   Use
+              this  function  and  not  wrefresh or wnoutrefresh.
               update_panels may be called more than once before a
-              call  to doupdate(), but doupdate() is the function
+              call  to  doupdate,  but  doupdate  is the function
               responsible for updating the physical screen.
 
        del_panel(pan)
@@ -122,8 +118,8 @@
               lost, merely removed from the stack.
 
        panel_hidden(pan)
-              returns TRUE if the panel is in  the  panel  stack,
-              FALSE  if  it  is  not.   If  the  panel  is a null
+              returns TRUE if the panel is in  the  panel  stack,
+              FALSE  if  it  is  not.   If  the  panel  is a null
               pointer, return ERR.
 
        show_panel(pan)
@@ -142,8 +138,8 @@
               moves the given panel window so that its upper-left
               corner is at starty, startx.  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.
+              use this function, not mvwin, to move a panel  win-
+              dow.
 
        replace_panel(pan,window)
               replaces  the  current  window of panel with window
@@ -172,15 +168,13 @@
               returns a pointer to the window of the given panel.
 
 
-
-

DIAGNOSTICS

+

DIAGNOSTICS

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

COMPATIBILITY

+

COMPATIBILITY

        Reasonable  care  has been taken to  ensure  compatibility
        with  the  native  panel  facility  introduced  in  SVr3.2
        (inspection of the SVr4 manual pages suggests the program-
@@ -188,54 +182,58 @@
        are  merely   similar. The  programmer is cautioned not to
        directly use PANEL fields.
 
-       The functions show_panel() and top_panel()  are  identical
-       in  this  implementation,  and work equally well with dis-
-       played or hidden panels.  In the native System V implemen-
-       tation, show_panel() is intended for making a hidden panel
-       visible (at the top  of  the  stack)  and  top_panel()  is
-       intended  for  making an already-visible panel move to the
-       top of the stack. You are cautioned  to  use  the  correct
-       function   to   ensure  compatibility  with  native  panel
-       libraries.
+       The functions show_panel and top_panel  are  identical  in
+       this  implementation, and work equally well with displayed
+       or hidden panels.  In the native System V  implementation,
+       show_panel  is  intended for making a hidden panel visible
+       (at the top of the stack) and top_panel  is  intended  for
+       making  an  already-visible  panel  move to the top of the
+       stack. You are cautioned to use the  correct  function  to
+       ensure compatibility with native panel libraries.
 
 
-
-

NOTE

-       In your library list, libpanel.a should  be  before  libn-
-       curses.a;  that  is,  you want to say `-lpanel -lncurses',
-       not the other way around (which would usually give a link-
-       error).
+

NOTE

+       In  your  library  list, libpanel.a should be before libn-
+       curses.a; that is, you should say "-lpanel -lncurses", not
+       the  other  way around (which would give a link-error with
+       static libraries).
 
 
-
-

FILES

+

FILES

        panel.h interface for the panels library
 
        libpanel.a the panels library itself
 
 
-
-

SEE ALSO

+

SEE ALSO

        curses(3x), curs_variables(3x),
 
-       This describes ncurses version 5.7 (patch 20110122).
+       This describes ncurses version 6.0 (patch 20170218).
 
 
-
-

AUTHOR

-       Originally   written   by   Warren  Tucker  <wht@n4hgf.mt-
-       park.ga.us>, primarily to assist  in  porting  u386mon  to
-       systems  without  a native panels library.  Repackaged for
+

AUTHOR

+       Originally  written  by   Warren   Tucker   <wht@n4hgf.mt-
+       park.ga.us>,  primarily  to  assist  in porting u386mon to
+       systems without a native panels library.   Repackaged  for
        ncurses by Zeyd ben-Halim.
 
 
 
                                                               panel(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +