File: xosd_hide.3

package info (click to toggle)
xosd 2.2.14-2.1
  • links: PTS
  • area: main
  • in suites: bullseye, buster, jessie, jessie-kfreebsd, sid, stretch
  • size: 2,320 kB
  • ctags: 409
  • sloc: sh: 10,748; ansic: 3,875; makefile: 77
file content (35 lines) | stat: -rw-r--r-- 730 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
.\" Hey Emacs! This file is -*- nroff -*- source.
.TH xosd_hide 3 "2002-06-25" "X OSD Library"
.SH NAME
xosd_hide \- hide the XOSD window
.SH SYNOPSIS
.B #include <xosd.h>
.sp
.BI "int xosd_hide (xosd* " osd );
.fi
.SH DESCRIPTION
.B xosd_hide
hides (unmaps) the
.I xosd
window.
Call 
.BR xosd_show (3)
to make the window visible again.

When 
.BI xosd_display (3)
is called data will be shown until the pre-set time has
elapsed.
By calling
.B xosd_hide
the window is prematurely removed from the display.
.SH ARGUMENTS
.IP \fIosd\fP 1i
The on-screen display object to act on.
.SH "RETURN VALUE"
On success, a zero is returned.
On error, \-1 is returned.
.SH "SEE ALSO"
.BR xosd_init (3),
.BR xosd_display (3),
.BR xosd_show (3).