usr/src/man/man3xcurses/getbegyx.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 GETBEGYX 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 getbegyx, getmaxyx, getparyx, getyx \- get cursor or window coordinates
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBvoid\fR \fBgetbegyx\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBvoid\fR \fBgetmaxyx\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
  25 .fi
  26
  27 .LP
  28 .nf
  29 \fBvoid\fR \fBgetparyx\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBvoid\fR \fBgetyx\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR);
  35 .fi
  36
  37 .SH DESCRIPTION
  38 .sp
  39 .LP
  40 The \fBgetyx()\fR macro stores the current cursor position of the  specified
  41 window in \fIx\fR and \fIy\fR.
  42 .sp
  43 .LP
  44 The \fBgetparyx()\fR macro stores the \fIx\fR and \fIy\fR coordinates (relative
  45 to the parent window) of the specified window's origin (upper-left  corner).
  46 If \fIwin\fR does not point to a subwindow, \fIx\fR and \fIy\fR are set to
  47 \(mi1.
  48 .sp
  49 .LP
  50 The \fBgetbegyx()\fR macro stores the \fIx\fR and \fIy\fR coordinates of the
  51 specified window's origin (upper-left corner).
  52 .sp
  53 .LP
  54 The \fBgetmaxyx()\fR macro stores the numbers of rows in the specified window
  55 in \fIy\fR and the number of columns in \fIx\fR.
  56 .SH PARAMETERS
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fIwin\fR\fR
  61 .ad
  62 .RS 7n
  63 Is a pointer to a window.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fIy\fR\fR
  70 .ad
  71 .RS 7n
  72 stores the \fIy\fR coordinate for the cursor or origin.  The \fBgetmaxyx()\fR
  73 macro uses it to store the number of rows in the  window.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fIx\fR\fR
  80 .ad
  81 .RS 7n
  82 stores the \fIx\fR coordinate for the cursor or origin.  The \fBgetmaxyx()\fR
  83 macro uses it to store the number of columns in the  window.
  84 .RE
  85
  86 .SH RETURN VALUES
  87 .sp
  88 .LP
  89 These macros do not return a value.
  90 .SH ERRORS
  91 .sp
  92 .LP
  93 None.
  94 .SH ATTRIBUTES
  95 .sp
  96 .LP
  97 See \fBattributes\fR(5) for descriptions of the following attributes:
  98 .sp
  99
 100 .sp
 101 .TS
 102 box;
 103 c | c
 104 l | l .
 105 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 106 _
 107 Interface Stability     Standard
 108 _
 109 MT-Level        Unsafe
 110 .TE
 111
 112 .SH SEE ALSO
 113 .sp
 114 .LP
 115 \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)