Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
is_linetouched(3XCURSES)X/Open Curses Library Functionis_linetouched(3XCURSES)

NAME
       is_linetouched,	 is_wintouched,	  touchline,   touchwin,   untouchwin,
       wtouchln	- control window refresh

SYNOPSIS
       cc [ flag... ] file... -I /usr/xpg4/include -L /usr/xpg4/lib \
       -R /usr/xpg4/lib	-lcurses [ library... ]

       c89 [ flag... ] file... -lcurses	[ library... ]

       #include	<curses.h>

       bool is_linetouched(WINDOW *win,	int line);

       bool is_wintouched(WINDOW *win);

       int touchline(WINDOW *win, int start, int count);

       int touchwin(WINDOW *win);

       int untouchwin(WINDOW *win);

       int wtouchln(WINDOW *win, int y,	int n, int changed);

PARAMETERS
       win		       Is a pointer to the window in which the refresh
			       is to be	controlled or monitored.

       line		       Is  the line to be checked for change since re-
			       fresh.

       start		       Is the starting line number of the  portion  of
			       the window to make appear changed.

       count		       Is the number of	lines in the window to mark as
			       changed.

       y		       Is the starting line number of the  portion  of
			       the  window  to	make  appear  changed  or  not
			       changed.

       n		       Is the number of	lines in the window to mark as
			       changed.

       changed		       Is a flag indicating whether to make lines look
			       changed (0) or not changed (1).

DESCRIPTION
       The touchwin() function marks the entire	window as dirty. This makes it
       appear  to  X/Open Curses as if the whole window	has been changed, thus
       causing the entire window to be rewritten with the  next	 call  to  re-
       fresh(3XCURSES).	 This  is  sometimes  necessary	when using overlapping
       windows;	the change to one window will not be reflected	in  the	 other
       and, hence will not be recorded.

       The  touchline()	function marks as dirty	a portion of the window	start-
       ing at line start and continuing	for count lines	instead	of the	entire
       window.	Consequently,  that  portion of	the window is updated with the
       next call to refresh().

       The untouchwin()	function marks all lines in the	 window	 as  unchanged
       since the last refresh, ensuring	that it	is not updated.

       The  wtouchln()	function  marks	 n  lines starting at line y as	either
       changed (changed=1) or unchanged	(changed=0) since the last refresh.

       To find out which lines or windows have been changed since the last re-
       fresh,  use the is_linetouched()	and is_wintouched() functions, respec-
       tively. These return TRUE if the	specified line	or  window  have  been
       changed	since  the  last call to refresh() or FALSE if no changes have
       been made.

RETURN VALUES
       On success, these functions return OK. Otherwise, they return ERR.

ERRORS
       None.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE	TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       doupdate(3XCURSES), libcurses(3XCURSES),	attributes(5), standards(5)

SunOS 5.10			  5 Jun	2002	      is_linetouched(3XCURSES)

NAME | SYNOPSIS | PARAMETERS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=touchwin&sektion=3xcurses&manpath=SunOS+5.10>

home | help