X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_scroll.3x.html;h=4d885e512b1635e8936986aa79e8e15b213e70c3;hb=8890c8f28a1db5995ef17f52a7d8c0b9cf574210;hp=375205d99ad70655c1d56eb29fe089a89f25fd78;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8;p=ncurses.git diff --git a/doc/html/man/curs_scroll.3x.html b/doc/html/man/curs_scroll.3x.html index 375205d9..4d885e51 100644 --- a/doc/html/man/curs_scroll.3x.html +++ b/doc/html/man/curs_scroll.3x.html @@ -1,7 +1,6 @@ - +
+ +- -curs_scroll(3x) curs_scroll(3x) +curs_scroll(3x) curs_scroll(3x) --
+
scroll, scrl, wscrl - scroll a curses window --
+
#include <curses.h> int scroll(WINDOW *win); @@ -59,73 +57,65 @@ int wscrl(WINDOW *win, int n); --
- The scroll routine scrolls the window up one line. This - involves moving the lines in the window data structure. - As an optimization, if the scrolling region of the window - is the entire screen, the physical screen may be scrolled - at the same time. +
+ The scroll routine scrolls the window up one line. This involves mov- + ing the lines in the window data structure. As an optimization, if the + scrolling region of the window is the entire screen, the physical + screen may be scrolled at the same time. - For positive n, the scrl and wscrl routines scroll the - window up n lines (line i+n becomes i); otherwise scroll - the window down n lines. This involves moving the lines - in the window character image structure. The current cur- - sor position is not changed. + For positive n, the scrl and wscrl routines scroll the window up n + lines (line i+n becomes i); otherwise scroll the window down n lines. + This involves moving the lines in the window character image structure. + The current cursor position is not changed. - For these functions to work, scrolling must be enabled via - scrollok. + For these functions to work, scrolling must be enabled via scrollok. --
- These routines return ERR upon failure, and OK (SVr4 only - specifies "an integer value other than ERR") upon success- - ful completion. +
+ These routines return ERR upon failure, and OK (SVr4 only specifies "an + integer value other than ERR") upon successful completion. X/Open defines no error conditions. - This implementation returns an error if the window pointer - is null, or if scrolling is not enabled in the window, - e.g., with scrollok. + This implementation returns an error if the window pointer is null, or + if scrolling is not enabled in the window, e.g., with scrollok. --
+
Note that scrl and scroll may be macros. - The SVr4 documentation says that the optimization of phys- - ically scrolling immediately if the scroll region is the - entire screen "is" performed, not "may be" performed. - This implementation deliberately does not guarantee that - this will occur, to leave open the possibility of smarter - optimization of multiple scroll actions on the next up- - date. + The SVr4 documentation says that the optimization of physically + scrolling immediately if the scroll region is the entire screen "is" + performed, not "may be" performed. This implementation deliberately + does not guarantee that this will occur, to leave open the possibility + of smarter optimization of multiple scroll actions on the next update. - Neither the SVr4 nor the XSI documentation specify whether - the current attribute or current color-pair of blanks gen- - erated by the scroll function is zeroed. Under this im- - plementation it is. + Neither the SVr4 nor the XSI documentation specify whether the current + attribute or current color-pair of blanks generated by the scroll func- + tion is zeroed. Under this implementation it is. --
- The XSI Curses standard, Issue 4 describes these func- - tions. +
+ The XSI Curses standard, Issue 4 describes these functions. --
+
curses(3x), curs_outopts(3x) - curs_scroll(3x) + curs_scroll(3x)-