~ubuntu-branches/debian/sid/ncurses/sid

« back to all changes in this revision

Viewing changes to man/curs_bkgrnd.3x

  • Committer: Package Import Robot
  • Author(s): Sven Joachim
  • Date: 2015-08-17 18:01:53 UTC
  • mfrom: (1.32.11)
  • Revision ID: package-import@ubuntu.com-20150817180153-ywf02awpkuzvqwdv
Tags: 6.0+20150810-1
* New upstream release.
  - Fix comparison against "/usr/include" in misc/gen-pkgconfig.in
    (Closes: #790548).
* Configure with "--with-abi-version=5", upstream defaults to abi 6 now.
* Configure with "--with-versioned-syms" (Closes: #788610).
  - Bump minimal versions of all symbols as well as shlibs to 6.
* After building the wide library, install it into a temporary
  scratchdir so that test/configure can find the necessary auxiliary
  files (see #786436).
* Drop the libncursesw5-dev build-dependency.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
.\"***************************************************************************
2
 
.\" Copyright (c) 2002-2010,2012 Free Software Foundation, Inc.              *
 
2
.\" Copyright (c) 2002-2012,2015 Free Software Foundation, Inc.              *
3
3
.\"                                                                          *
4
4
.\" Permission is hereby granted, free of charge, to any person obtaining a  *
5
5
.\" copy of this software and associated documentation files (the            *
26
26
.\" authorization.                                                           *
27
27
.\"***************************************************************************
28
28
.\"
29
 
.\" $Id: curs_bkgrnd.3x,v 1.5 2012/11/03 23:03:59 tom Exp $
 
29
.\" $Id: curs_bkgrnd.3x,v 1.6 2015/07/21 00:18:42 tom Exp $
 
30
.de bP
 
31
.IP \(bu 4
 
32
..
30
33
.TH curs_bkgrnd 3X ""
31
34
.SH NAME
32
35
\fBbkgrnd\fR,
52
55
\fBint wgetbkgrnd(WINDOW *\fR\fIwin\fR\fB, cchar_t *\fR\fIwch\fR\fB);\fR
53
56
.br
54
57
.SH DESCRIPTION
 
58
.SS bkgrndset
 
59
.PP
55
60
The \fBbkgrndset\fR and \fBwbkgrndset\fR routines manipulate the
56
61
background of the named window.
57
62
The window background is a \fBcchar_t\fR consisting of
67
72
To the extent possible on a
68
73
particular terminal, the attribute part of the background is displayed
69
74
as the graphic rendition of the character put on the screen.
 
75
.SS bkgrnd
70
76
.PP
71
77
The \fBbkgrnd\fR and \fBwbkgrnd\fR functions
72
78
set the background property of the current or specified window
73
79
and then apply this setting to every character position in that window:
74
 
.RS
75
 
.PP
 
80
.bP
76
81
The rendition of every character on the screen is changed to
77
82
the new background rendition.
78
 
.PP
 
83
.bP
79
84
Wherever the former background character
80
85
appears, it is changed to the new background character.
81
 
.RE
 
86
.SS getbkgrnd
82
87
.PP
83
88
The \fBgetbkgrnd\fR function returns the given window's current background
84
89
character/attribute pair via the \fBwch\fR pointer.
85
 
.
86
90
.SH NOTES
87
91
Note that
88
92
\fBbkgrnd\fR,
90
94
\fBgetbkgrnd\fR
91
95
may be macros.
92
96
.SH RETURN VALUE
 
97
.PP
93
98
The \fBbkgrndset\fR and \fBwbkgrndset\fR routines do not return a value.
94
99
.PP
95
100
Upon successful completion, the other functions return \fBOK\fR.