usr/src/man/man3curses/panel_move.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH PANEL_MOVE 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 panel_move, move_panel \- move a panels window on the virtual screen
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lpanel\fR \fB -lcurses \fR [ \fIlibrary\fR .. ]
  14 #include <panel.h>
  15
  16
  17
  18 \fBint\fR \fBmove_panel\fR(\fBPANEL *\fR\fIpanel\fR, \fBint\fR \fIstarty\fR, \fBint\fR \fIstartx\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 \fBmove_panel()\fR moves the \fBcurses\fR window associated with \fIpanel\fR so
  25 that its upper left-hand corner is at \fIstarty\fR, \fIstartx\fR. See usage
  26 note, below.
  27 .SH RETURN VALUES
  28 .sp
  29 .LP
  30 \fBOK\fR is returned if the routine completes successfully, otherwise \fBERR\fR
  31 is returned.
  32 .SH ATTRIBUTES
  33 .sp
  34 .LP
  35 See \fBattributes\fR(5) for descriptions of the following attributes:
  36 .sp
  37
  38 .sp
  39 .TS
  40 box;
  41 c | c
  42 l | l .
  43 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  44 _
  45 MT-Level        Unsafe
  46 .TE
  47
  48 .SH SEE ALSO
  49 .sp
  50 .LP
  51 \fBcurses\fR(3CURSES), \fBpanel_update\fR(3CURSES), \fBpanels\fR(3CURSES),
  52 \fBattributes\fR(5)
  53 .SH NOTES
  54 .sp
  55 .LP
  56 For \fBpanels\fR windows, use \fBmove_panel()\fR instead of the \fBmvwin()\fR
  57 \fBcurses\fR routine. Otherwise, \fBupdate_panels()\fR will not properly update
  58 the virtual screen.
  59 .sp
  60 .LP
  61 The header \fB<panel.h>\fR automatically includes the header
  62 \fB<curses.h>\fR\&.