Blame - doc/html/man/curs_termattrs.3x.html - android_external_libncurses

Amit Daniel Kachhap

e6a01f5

2011-07-20 11:45:59 +0530

[diff] [blame]

1

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">

2

<!--

3

****************************************************************************

4

5

* *

6

* Permission is hereby granted, free of charge, to any person obtaining a *

7

* copy of this software and associated documentation files (the *

8

* "Software"), to deal in the Software without restriction, including *

9

* without limitation the rights to use, copy, modify, merge, publish, *

10

* distribute, distribute with modifications, sublicense, and/or sell *

11

* copies of the Software, and to permit persons to whom the Software is *

12

* furnished to do so, subject to the following conditions: *

13

* *

14

* The above copyright notice and this permission notice shall be included *

15

* in all copies or substantial portions of the Software. *

16

* *

17

* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *

18

* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *

19

* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *

20

* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *

21

* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *

22

* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *

23

* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *

24

* *

25

* Except as contained in this notice, the name(s) of the above copyright *

26

* holders shall not be used in advertising or otherwise to promote the *

27

* sale, use or other dealings in this Software without prior written *

28

* authorization. *

29

****************************************************************************

30

* @Id: curs_termattrs.3x,v 1.10 2007/06/02 20:40:07 tom Exp @

-->

<HTML>

<HEAD>

<TITLE>curs_termattrs 3x</TITLE>

</HEAD>

<BODY>

<H1>curs_termattrs 3x</H1>

40

<HR>

41

<PRE>

42

43

<A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A> <A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A>

</PRE>

baudrate, erasechar, erasewchar, has_ic, has_il, killchar,

51

killwchar, longname, term_attrs, termattrs, termname -

52

curses environment query routines

</PRE>

<H2>SYNOPSIS</H2><PRE>

#include <curses.h>

int baudrate(void);

char erasechar(void);

61

int erasewchar(wchar_t *ch);

bool has_ic(void);

bool has_il(void);

char killchar(void);

int killwchar(wchar_t *ch);

66

char *longname(void);

67

attr_t term_attrs(void);

68

chtype termattrs(void);

69

char *termname(void);

</PRE>

<H2>DESCRIPTION</H2><PRE>

74

The baudrate routine returns the output speed of the ter-

75

minal. The number returned is in bits per second, for

76

example 9600, and is an integer.

77

78

The erasechar routine returns the user's current erase

79

character.

80

81

The erasewchar routine stores the current erase character

82

in the location referenced by ch. If no erase character

83

has been defined, the routine fails and the location ref-

84

erenced by ch is not changed.

85

86

The has_ic routine is true if the terminal has insert- and

87

delete- character capabilities.

88

89

The has_il routine is true if the terminal has insert- and

90

delete-line capabilities, or can simulate them using

91

scrolling regions. This might be used to determine if it

92

would be appropriate to turn on physical scrolling using

93

scrollok.

94

95

The killchar routine returns the user's current line kill

96

character.

97

98

The killwchar routine stores the current line-kill charac-

99

ter in the location referenced by ch. If no line-kill

100

character has been defined, the routine fails and the

101

location referenced by ch is not changed.

102

103

The longname routine returns a pointer to a static area

104

containing a verbose description of the current terminal.

105

The maximum length of a verbose description is 128 charac-

106

ters. It is defined only after the call to initscr or

107

newterm. The area is overwritten by each call to newterm

108

and is not restored by set_term, so the value should be

109

saved between calls to newterm if longname is going to be

110

used with multiple terminals.

111

112

If a given terminal does not support a video attribute

113

that an application program is trying to use, curses may

114

substitute a different video attribute for it. The

115

termattrs and term_attrs functions return a logical OR of

116

all video attributes supported by the terminal using A_

117

and WA_ constants respectively. This information is use-

118

ful when a curses program needs complete control over the

119

appearance of the screen.

120

121

The termname routine returns the terminal name used by

setupterm.

</PRE>

<H2>RETURN VALUE</H2><PRE>

127

longname and termname return NULL on error.

128

129

Routines that return an integer return ERR upon failure

130

and OK (SVr4 only specifies "an integer value other than

131

ERR") upon successful completion.

</PRE>

<H2>NOTES</H2><PRE>

Note that termattrs may be a macro.

</PRE>

<H2>PORTABILITY</H2><PRE>

141

The XSI Curses standard, Issue 4 describes these func-

142

tions. It changes the return type of termattrs to the new

143

type attr_t. Most versions of curses truncate the result

144

returned by termname to 14 characters.

</PRE>

<A HREF="ncurses.3x.html">curses(3x)</A>, <A HREF="curs_initscr.3x.html">curs_initscr(3x)</A>, <A HREF="curs_outopts.3x.html">curs_outopts(3x)</A>

<A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A>

</PRE>

<HR>

Man(1) output converted with

</ADDRESS>

</BODY>

</HTML>