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

2025-07-08 18:04:53 -0400

[diff] [blame^]

1

<!--

Amit Daniel Kachhap

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

[diff] [blame]

2

* t

3

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

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

4

5

Amit Daniel Kachhap

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

[diff] [blame]

6

* *

7

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

8

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

9

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

10

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

11

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

12

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

13

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

14

* *

15

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

16

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

17

* *

18

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

19

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

20

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

21

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

22

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

23

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

24

* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *

25

* *

26

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

27

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

28

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

29

* authorization. *

30

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

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

31

* @Id: curs_inch.3x,v 1.51 2024/04/20 21:20:07 tom Exp @

Amit Daniel Kachhap

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

[diff] [blame]

32

-->

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

33

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">

Amit Daniel Kachhap

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

[diff] [blame]

34

<HTML>

35

<HEAD>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

36

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

37

38

<TITLE>curs_inch 3x 2024-04-20 ncurses 6.5 Library calls</TITLE>

39

40

Amit Daniel Kachhap

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

[diff] [blame]

41

</HEAD>

42

<BODY>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

43

<H1 class="no-header">curs_inch 3x 2024-04-20 ncurses 6.5 Library calls</H1>

Amit Daniel Kachhap

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

[diff] [blame]

44

<PRE>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

45

<A HREF="curs_inch.3x.html">curs_inch(3x)</A> Library calls <A HREF="curs_inch.3x.html">curs_inch(3x)</A>

Amit Daniel Kachhap

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

[diff] [blame]

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

50

</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>

51

inch, winch, mvinch, mvwinch - get a curses character from a window

Amit Daniel Kachhap

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

[diff] [blame]

52

53

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

54

</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>

Amit Daniel Kachhap

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

[diff] [blame]

55

#include <curses.h>

56

57

chtype inch(void);

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

58

chtype winch(WINDOW *win);

59

60

chtype mvinch(int y, int x);

61

chtype mvwinch(WINDOW *win, int y, int x);

Amit Daniel Kachhap

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

[diff] [blame]

62

63

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

64

</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>

65

These routines return the character, of type chtype, at the current

66

position in the named window. If any attributes are set for that

67

position, their values are OR'ed into the value returned. Constants

68

defined in <curses.h> can be used with the & (logical AND) operator to

69

extract the character or attributes alone.

Amit Daniel Kachhap

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

[diff] [blame]

70

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

71

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

72

</PRE><H3><a name="h3-Attributes">Attributes</a></H3><PRE>

73

The following bit masks may be AND-ed with characters returned by

74

winch.

Amit Daniel Kachhap

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

[diff] [blame]

75

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

76

Name Description

77

------------------------------------------------------------------------

78

A_CHARTEXT Extract character

79

A_ATTRIBUTES Extract attributes

80

A_COLOR Extract color pair information

Amit Daniel Kachhap

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

[diff] [blame]

81

82

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

83

</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>

84

Functions prefixed with "mv" first perform cursor movement and fail if

85

the position (y, x) is outside the window boundaries.

86

87

The winch function does not return an error if the window contains

88

characters larger than 8-bits (255). Only the low-order 8 bits of the

89

character are used by winch.

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

90

91

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

92

</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>

Amit Daniel Kachhap

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

[diff] [blame]

93

Note that all of these routines may be macros.

94

95

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

96

</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>

97

These functions are described in X/Open Curses, Issue 4.

98

99

Very old systems (before standardization) provide a different function

100

with the same name:

101

102

o The winch function was part of the original BSD curses library,

103

which stored a 7-bit character combined with the standout

104

attribute.

105

106

In BSD curses, winch returned only the character (as an integer)

107

with the standout attribute removed.

108

109

o System V curses added support for several video attributes which

110

could be combined with characters in the window.

111

112

Reflecting this improvement, the function was altered to return the

113

character combined with all video attributes in a chtype value.

114

115

X/Open Curses does not specify the size and layout of attributes, color

116

and character values in chtype; it is implementation-dependent. This

117

implementation uses 8 bits for character values. An application using

118

more bits, e.g., a Unicode value, should use the wide-character

119

equivalents to these functions.

Amit Daniel Kachhap

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

[diff] [blame]

120

121

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

122

</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>

123

<A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A> describes comparable functions of the ncurses library

124

in its wide-character configuration (ncursesw).

Amit Daniel Kachhap

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

[diff] [blame]

125

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

126

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

Amit Daniel Kachhap

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

[diff] [blame]

micky387

2025-07-08 18:04:53 -0400

[diff] [blame^]

130

ncurses 6.5 2024-04-20 <A HREF="curs_inch.3x.html">curs_inch(3x)</A>

Amit Daniel Kachhap

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

[diff] [blame]

131

</PRE>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

<ul>

<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>

136

<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>

137

<ul>

138

<li><a href="#h3-Attributes">Attributes</a></li>

139

</ul>

140

</li>

141

<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>

142

<li><a href="#h2-NOTES">NOTES</a></li>

143

<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>

144

145

</ul>

146

</div>

Amit Daniel Kachhap