xref: /netbsd-src/lib/libpanel/move_panel.3 (revision ed8dd388368ba2a90492987cbff26238e7a4b6f1)
1.\"	$NetBSD: move_panel.3,v 1.4 2015/10/28 10:22:40 wiz Exp $
2.\"
3.\" Copyright (c) 2015 Valery Ushakov
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd October 28, 2015
27.Dt MOVE_PANEL 3
28.Os
29.Sh NAME
30.Nm move_panel
31.Nd change panel position
32.Sh LIBRARY
33.Lb libpanel
34.Sh SYNOPSIS
35.In panel.h
36.\"
37.Ft int
38.Fn move_panel "PANEL *p" "int y" "int x"
39.\"
40.Sh DESCRIPTION
41A panel can be moved to a new position by calling the
42.Fn move_panel
43function.
44The
45.Fa y
46and
47.Fa x
48positions are the new origin of the panel on the screen.
49.Pp
50This function is the panel library counterpart of the curses
51.Xr mvwin 3
52function.
53Curses
54.Fn mvwin
55must never be directly used on a window associated with a panel.
56.Sh RETURN VALUES
57The
58.Fn move_panel
59function will return one of the following
60values:
61.Pp
62.Bl -tag -width ".Dv ERR" -compact
63.It Dv OK
64The function completed successfully.
65.It Dv ERR
66An error occurred in the function.
67.El
68.Sh SEE ALSO
69.Xr mvwin 3 ,
70.Xr panel 3
71