1*ed8dd388Swiz.\" $NetBSD: panel_hidden.3,v 1.3 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 PANEL_HIDDEN 3 28fe186541Suwe.Os 29fe186541Suwe.Sh NAME 30fe186541Suwe.Nm hide_panel , 31fe186541Suwe.Nm show_panel , 32fe186541Suwe.Nm panel_hidden 33fe186541Suwe.Nd visibility of panels 34fe186541Suwe.Sh LIBRARY 35fe186541Suwe.Lb libpanel 36fe186541Suwe.Sh SYNOPSIS 37fe186541Suwe.In panel.h 38fe186541Suwe.\" 39fe186541Suwe.Ft int 40fe186541Suwe.Fn hide_panel "PANEL *p" 41fe186541Suwe.\" 42fe186541Suwe.Ft int 43fe186541Suwe.Fn show_panel "PANEL *p" 44fe186541Suwe.\" 45fe186541Suwe.Ft int 46fe186541Suwe.Fn panel_hidden "PANEL *p" 47fe186541Suwe.\" 48fe186541Suwe.Sh DESCRIPTION 49*ed8dd388SwizPanels are initially created visible. 500c624ce4SuweThe function 510c624ce4Suwe.Fn hide_panel 520c624ce4Suwecan be used to hide a panel. 530c624ce4SuweThe panel is removed from the deck. 540c624ce4Suwe.Pp 550c624ce4SuweA panel can be made visible again with a call to 560c624ce4Suwe.Fn show_panel . 570c624ce4SuweThe panel is returned to the top of the deck. 580c624ce4Suwe.Pp 59*ed8dd388SwizThe current visibility status of a panel can be queried with 600c624ce4Suwe.Fn panel_hidden . 610c624ce4Suwe.Sh IMPLEMENTATION NOTES 620c624ce4SuweThe 630c624ce4Suwe.Fn show_panel 640c624ce4Suwefunction will return an error if the panel is already visible. 650c624ce4SuweUse 660c624ce4Suwe.Xr top_panel 3 670c624ce4Suweto change z-order of an already visible panel. 680c624ce4SuweThis is the behaviour specified by the original 690c624ce4Suwe.At V 700c624ce4Suwepanel library. 710c624ce4Suwe.Pp 720c624ce4SuweIn the ncurses implementation of the panel library 730c624ce4Suwe.Fn show_panel 740c624ce4Suweand 750c624ce4Suwe.Fn top_panel 760c624ce4Suweare identical and handle both visible and hidden panels. 770c624ce4SuweThis may be a source of bugs in programs tested only against ncurses. 780c624ce4Suwe.Sh RETURN VALUES 790c624ce4SuweThe 800c624ce4Suwe.Fn panel_hidden 810c624ce4Suwefunction returns 820c624ce4Suwe.Dv TRUE 830c624ce4Suweor 840c624ce4Suwe.Dv FALSE . 850c624ce4SuweIt will return 860c624ce4Suwe.Dv ERR 870c624ce4Suweif passed a null pointer. 880c624ce4Suwe.Pp 890c624ce4SuweOther functions will return one of the following values: 900c624ce4Suwe.Pp 910c624ce4Suwe.Bl -tag -width ".Dv ERR" -compact 920c624ce4Suwe.It Dv OK 930c624ce4SuweThe function completed successfully. 940c624ce4Suwe.It Dv ERR 950c624ce4SuweAn error occurred in the function. 960c624ce4Suwe.El 97fe186541Suwe.Sh SEE ALSO 98fe186541Suwe.Xr panel 3 99