← Back to branch summary

~ubuntu-branches/ubuntu/natty/ncurses/natty

« back to all changes in this revision

Viewing changes to man/curs_getyx.3x

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2007-05-17 09:00:42 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070517090042-86fgxrr6j5jzagot
Tags: 5.6-0ubuntu1
* New upstream version.
  - Remove patches applied upstream: ncurses.upstream, signed-chars.
  - Update patches: debian-backspace.
* Build-depend on g++-multilib instead of lib{32,64}c*-dev-*.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/curs_getyx.3x
1
1
.\"***************************************************************************
2
 
.\" Copyright (c) 1998-2002,2003 Free Software Foundation, Inc.              *
 
2
.\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc.              *
3
3
.\"                                                                          *
4
4
.\" Permission is hereby granted, free of charge, to any person obtaining a  *
5
5
.\" copy of this software and associated documentation files (the            *
26
26
.\" authorization.                                                           *
27
27
.\"***************************************************************************
28
28
.\"
29
 
.\" $Id: curs_getyx.3x,v 1.10 2003/05/10 20:33:49 jmc Exp $
 
29
.\" $Id: curs_getyx.3x,v 1.13 2006/05/27 20:28:05 tom Exp $
30
30
.TH curs_getyx 3X ""
31
31
.SH NAME
32
32
\fBgetyx\fR,
35
35
\fBgetmaxyx\fR - get \fBcurses\fR cursor and window coordinates
36
36
.SH SYNOPSIS
37
37
\fB#include <curses.h>\fR
38
 
 
 
38
.sp
39
39
\fBvoid getyx(WINDOW *win, int y, int x);\fR
40
40
.br
41
41
\fBvoid getparyx(WINDOW *win, int y, int x);\fR
47
47
.SH DESCRIPTION
48
48
The \fBgetyx\fR macro places the current cursor position of the given window in
49
49
the two integer variables \fIy\fR and \fIx\fR.
50
 
 
 
50
.PP
51
51
If \fIwin\fR is a subwindow, the \fBgetparyx\fR macro places the beginning
52
52
coordinates of the subwindow relative to the parent window into two integer
53
53
variables \fIy\fR and \fIx\fR.
54
54
Otherwise, \fB-1\fR is placed into \fIy\fR and \fIx\fR.
55
 
 
 
55
.PP
56
56
Like \fBgetyx\fR, the \fBgetbegyx\fR and \fBgetmaxyx\fR macros store
57
57
the current beginning coordinates and size of the specified window.
58
58
.SH RETURN VALUE
67
67
\fBgetparyx\fR,
68
68
\fBgetbegyx\fR and
69
69
\fBgetmaxyx\fR
70
 
functions are described in the XSI Curses standard, Issue 4.
 
70
macros are described in the XSI Curses standard, Issue 4.
71
71
.PP
72
72
This implementation also provides
73
73
\fBgetbegx\fR,
79
79
\fBgetparx\fR and
80
80
\fBgetpary\fR
81
81
for compatibility with older versions of curses.
 
82
X/Open does not define a corresponding \fBgetcuryx\fP function,
 
83
though that would be needed to make references to the WINDOW structure opaque.
82
84
.SH SEE ALSO
83
85
\fBcurses\fR(3X)
84
86
.\"#