usr/src/man/man3xcurses/syncok.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH SYNCOK 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 syncok, wcursyncup, wsyncdown, wsyncup \- synchronize window with its parents
   9 or children
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  14 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  15
  16 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  17
  18 #include <curses.h>
  19
  20 \fBint\fR \fBsyncok\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBvoid\fR \fBwcursyncup\fR(\fBWINDOW *\fR\fIwin\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBvoid\fR \fBwsyncdown\fR(\fBWINDOW *\fR\fIwin\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBvoid\fR \fBwsyncup\fR(\fBWINDOW *\fR\fIwin\fR);
  36 .fi
  37
  38 .SH PARAMETERS
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIwin\fR\fR
  43 .ad
  44 .RS 7n
  45 Is a pointer to a window.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fIbf\fR\fR
  52 .ad
  53 .RS 7n
  54 Is a Boolean expression.
  55 .RE
  56
  57 .SH DESCRIPTION
  58 .sp
  59 .LP
  60 The \fBsyncok()\fR function uses the value of \fIbf\fR to determine  whether or
  61 not the window \fIwin\fR's ancestors are implicitly touched whenever there is a
  62 change to \fIwin\fR. If \fIbf\fR is \fBTRUE\fR, this touching occurs. If
  63 \fIbf\fR is \fBFALSE\fR, it does not occur. The initial value for \fIbf\fR is
  64 \fBFALSE\fR.
  65 .sp
  66 .LP
  67 The \fBwcursyncup()\fR function moves the cursor in \fIwin\fR's ancestors  to
  68 match its position in \fIwin\fR.
  69 .sp
  70 .LP
  71 The \fBwsyncdown()\fR function touches \fIwin\fR if any of its ancestors have
  72 been touched.
  73 .sp
  74 .LP
  75 The \fBwsyncup()\fR function touches all ancestors of \fIwin\fR.
  76 .SH RETURN VALUES
  77 .sp
  78 .LP
  79 On success, the \fBsyncok()\fR function returns \fBOK\fR. Otherwise, it returns
  80 \fBERR\fR.
  81 .sp
  82 .LP
  83 The other functions do not return a value.
  84 .SH ERRORS
  85 .sp
  86 .LP
  87 None.
  88 .SH ATTRIBUTES
  89 .sp
  90 .LP
  91 See \fBattributes\fR(5) for descriptions of the following attributes:
  92 .sp
  93
  94 .sp
  95 .TS
  96 box;
  97 c | c
  98 l | l .
  99 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 100 _
 101 Interface Stability     Standard
 102 _
 103 MT-Level        Unsafe
 104 .TE
 105
 106 .SH SEE ALSO
 107 .sp
 108 .LP
 109 \fBderwin\fR(3XCURSES), \fBdoupdate\fR(3XCURSES),
 110 \fBis_linetouched\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5),
 111 \fBstandards\fR(5)