File: xosd_set_bar_length.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 (73 lines) | stat: -rw-r--r-- 1,715 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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "XOSD_SET_BAR_LENGTH" 3 "" "" ""
.SH NAME
xosd_set_bar_length \- Change the length of the percentage bar or slider
.SH "SYNOPSIS"
.ad l
.hy 0

#include <xosd.h>
.sp
.HP 25
int\ \fBxosd_set_bar_length\fR\ (xosd\ *\fIosd\fR, int\ \fIdisplayPercentage\fR);
.ad
.hy

.SH "DESCRIPTION"

.PP
\fBxosd_set_bar_length\fR changes the percentage of the display used by a slider or percentage bar. Normally the XOSD choses a sensible length for the bar, but you may wish to change the default behavior if there are only a small number of possible values to be displayed.

.SH "ARGUMENTS"

.TP
\fIosd\fR
The XOSD window to alter.

.TP
\fIdisplayPercentage\fR
The percentage of the display to be used up by the slider or percentage bar, as an interger between 0 and 100. Setting \fIdisplayPercentage\fR to \-1 reverts to the default behaviour.

.SH "RETURN VALUE"

.PP
On success, a zero is returned. On error, \-1 is returned and \fIxosd_error\fR is set to indicate the reason for the error.

.SH "ENVIRONMENT"

.TP
\fIchar *xosd_error\fR
A string describing the error, if one occurred.

.SH "BUGS"

.PP
There are no known bugs with \fBxosd_set_bar_length\fR. Bug reports can be sent to <xosd@ignavus.net>.

.SH "AUTHORS"

.PP
The XOSD library was originally written by Andr´┐Ż Renaud, and is currently maintained by Tim Wright. This document was written by Michael JasonSmith.

.SH "SEE ALSO"

.PP
 \fBxosd_create\fR(3), \fBxosd_display\fR(3).