1*e47dc51aSuwe.\" $NetBSD: new_panel.3,v 1.4 2015/10/29 02:33:46 uwe 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 NEW_PANEL 3 28fe186541Suwe.Os 29fe186541Suwe.Sh NAME 30fe186541Suwe.Nm new_panel , 31fe186541Suwe.Nm panel_window , 32fe186541Suwe.Nm replace_panel , 33fe186541Suwe.Nm del_panel 34fe186541Suwe.Nd panel routines 35fe186541Suwe.Sh LIBRARY 36fe186541Suwe.Lb libpanel 37fe186541Suwe.Sh SYNOPSIS 38fe186541Suwe.In panel.h 39fe186541Suwe.\" 40fe186541Suwe.Ft PANEL * 41fe186541Suwe.Fn new_panel "WINDOW *win" 42fe186541Suwe.\" 43fe186541Suwe.Ft WINDOW * 44fe186541Suwe.Fn panel_window "PANEL *p" 45fe186541Suwe.\" 46fe186541Suwe.Ft int 47fe186541Suwe.Fn replace_panel "PANEL *p" "WINDOW *win" 48fe186541Suwe.\" 49fe186541Suwe.Ft int 50fe186541Suwe.Fn del_panel "PANEL *p" 51fe186541Suwe.\" 52fe186541Suwe.Sh DESCRIPTION 53*e47dc51aSuweThe function 540c624ce4Suwe.Fn new_panel 550c624ce4Suwecreates a new panel associated with the curses window 560c624ce4Suwe.Fa win . 570c624ce4SuweThe new panel is visible and is placed at the top of the deck. 580c624ce4Suwe.Pp 59ed8dd388SwizThe curses window associated with a panel may be obtained with 600c624ce4Suwe.Fn panel_window 610c624ce4Suweand changed with 620c624ce4Suwe.Fn replace_panel . 630c624ce4Suwe.Pp 64ed8dd388SwizThe function 650c624ce4Suwe.Fn del_panel 660c624ce4Suwehides the panel and deletes it. 67ed8dd388SwizNote that the curses window associated with the panel is not deleted. 680c624ce4Suwe.Sh RETURN VALUES 690c624ce4SuweFunctions returning pointers will return 700c624ce4Suwe.Dv NULL 710c624ce4Suweif an error is detected. 720c624ce4SuweThe functions that return an int will return one of the following 730c624ce4Suwevalues: 740c624ce4Suwe.Pp 750c624ce4Suwe.Bl -tag -width ".Dv ERR" -compact 760c624ce4Suwe.It Dv OK 770c624ce4SuweThe function completed successfully. 780c624ce4Suwe.It Dv ERR 790c624ce4SuweAn error occurred in the function. 800c624ce4Suwe.El 81fe186541Suwe.Sh SEE ALSO 82fe186541Suwe.Xr panel 3 83