xref: /netbsd-src/lib/libpanel/move_panel.3 (revision ed8dd388368ba2a90492987cbff26238e7a4b6f1)
1*ed8dd388Swiz.\"	$NetBSD: move_panel.3,v 1.4 2015/10/28 10:22:40 wiz Exp $
2fe186541Suwe.\"
3fe186541Suwe.\" Copyright (c) 2015 Valery Ushakov
4fe186541Suwe.\" All rights reserved.
5fe186541Suwe.\"
6fe186541Suwe.\" Redistribution and use in source and binary forms, with or without
7fe186541Suwe.\" modification, are permitted provided that the following conditions
8fe186541Suwe.\" are met:
9fe186541Suwe.\" 1. Redistributions of source code must retain the above copyright
10fe186541Suwe.\"    notice, this list of conditions and the following disclaimer.
11fe186541Suwe.\" 2. Redistributions in binary form must reproduce the above copyright
12fe186541Suwe.\"    notice, this list of conditions and the following disclaimer in the
13fe186541Suwe.\"    documentation and/or other materials provided with the distribution.
14fe186541Suwe.\"
15fe186541Suwe.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16fe186541Suwe.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17fe186541Suwe.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18fe186541Suwe.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19fe186541Suwe.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20fe186541Suwe.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21fe186541Suwe.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22fe186541Suwe.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23fe186541Suwe.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24fe186541Suwe.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25fe186541Suwe.\"
26fe186541Suwe.Dd October 28, 2015
27fe186541Suwe.Dt MOVE_PANEL 3
28fe186541Suwe.Os
29fe186541Suwe.Sh NAME
30fe186541Suwe.Nm move_panel
31fe186541Suwe.Nd change panel position
32fe186541Suwe.Sh LIBRARY
33fe186541Suwe.Lb libpanel
34fe186541Suwe.Sh SYNOPSIS
35fe186541Suwe.In panel.h
36fe186541Suwe.\"
37fe186541Suwe.Ft int
38fe186541Suwe.Fn move_panel "PANEL *p" "int y" "int x"
39fe186541Suwe.\"
40fe186541Suwe.Sh DESCRIPTION
410c624ce4SuweA panel can be moved to a new position by calling the
420c624ce4Suwe.Fn move_panel
430c624ce4Suwefunction.
440c624ce4SuweThe
450c624ce4Suwe.Fa y
460c624ce4Suweand
470c624ce4Suwe.Fa x
480c624ce4Suwepositions are the new origin of the panel on the screen.
490c624ce4Suwe.Pp
50*ed8dd388SwizThis function is the panel library counterpart of the curses
51*ed8dd388Swiz.Xr mvwin 3
52*ed8dd388Swizfunction.
530c624ce4SuweCurses
540c624ce4Suwe.Fn mvwin
550c624ce4Suwemust never be directly used on a window associated with a panel.
560c624ce4Suwe.Sh RETURN VALUES
570c624ce4SuweThe
580c624ce4Suwe.Fn move_panel
590c624ce4Suwefunction will return one of the following
600c624ce4Suwevalues:
610c624ce4Suwe.Pp
620c624ce4Suwe.Bl -tag -width ".Dv ERR" -compact
630c624ce4Suwe.It Dv OK
640c624ce4SuweThe function completed successfully.
650c624ce4Suwe.It Dv ERR
660c624ce4SuweAn error occurred in the function.
670c624ce4Suwe.El
68fe186541Suwe.Sh SEE ALSO
690c624ce4Suwe.Xr mvwin 3 ,
70fe186541Suwe.Xr panel 3
71