X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fpanel.3x.html;h=216839e31574f6a3b8a4f9914fedd035aec5d4d7;hb=9776951416d7fb862b9dca1f4c9f8031a5c9059b;hp=f6e275054d50ddea69b7dc5492d3b5f6e7ca6d05;hpb=82a087c4c47679fcfa59bb6d7bdbe587355ba3f6;p=ncurses.git diff --git a/doc/html/man/panel.3x.html b/doc/html/man/panel.3x.html index f6e27505..216839e3 100644 --- a/doc/html/man/panel.3x.html +++ b/doc/html/man/panel.3x.html @@ -1,7 +1,7 @@
@@ -102,32 +102,37 @@ (causes it to be displayed above any other panel) and returns a pointer to the new panel. - void 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. - update_panels() may be called more than once before - a call to doupdate(), but doupdate() is the func- - tion responsible for updating 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 + responsible for updating the physical screen. del_panel(pan) removes the given panel from the stack and deallo- - cates the PANEL structure (but not its associated + cates the PANEL structure (but not its associated window). hide_panel(pan) - removes the given panel from the panel stack and + 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. + panel_hidden(pan) + 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) - makes a hidden panel visible by placing it on top + makes a hidden panel visible by placing it on top of the panels in the panel stack. See COMPATIBILITY below. top_panel(pan) - puts the given visible panel on top of all panels + puts the given visible panel on top of all panels in the stack. See COMPATIBILITY below. bottom_panel(pan) @@ -135,26 +140,26 @@ move_panel(pan,starty,startx) moves the given panel window so that its upper-left - corner is at starty, startx. It does not change + 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 + use this function, not mvwin(), to move a panel window. replace_panel(pan,window) - replaces the current window of panel with window + 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 + on the output of wresize(3x)). It does not change the position of the panel in the stack. panel_above(pan) - returns a pointer to the panel above pan. If the - panel argument is (PANEL *)0, it returns a pointer + returns a pointer to the panel above pan. If the + panel argument is (PANEL *)0, it returns a pointer to the bottom panel in the stack. panel_below(pan) - returns a pointer to the panel just below pan. If - the panel argument is (PANEL *)0, it returns a + returns a pointer to the panel just below pan. If + the panel argument is (PANEL *)0, it returns a pointer to the top panel in the stack. set_panel_userptr(pan,ptr) @@ -169,35 +174,35 @@- Each routine that returns a pointer returns NULL if an - error occurs. Each routine that returns an int value + 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.
- 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- - ming interface is unchanged). The PANEL data structures - 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- + 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 + programming interface is unchanged). The PANEL data + structures are merely similar. The programmer is cau- + tioned 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 + 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.
- In your library list, libpanel.a should be before libn- - curses.a; that is, you want to say `-lpanel -lncurses', + 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). @@ -211,16 +216,16 @@
- curses(3x) + curses(3x), curs_variables(3x), - This describes ncurses version 5.6 (patch 20070303). + This describes ncurses version 5.8 (patch 20110226).
- 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 + 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.