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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

1

<!--

2

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

Steve Kondik

ae271bc

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

[diff] [blame^]

3

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

4

* *

5

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

6

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

7

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

8

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

9

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

10

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

11

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

12

* *

13

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

14

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

15

* *

16

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

17

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

18

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

19

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

20

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

21

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

22

* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *

23

* *

24

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

25

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

26

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

27

* authorization. *

28

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

Steve Kondik

ae271bc

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

[diff] [blame^]

29

* @Id: curs_get_wch.3x,v 1.8 2012/11/03 23:03:59 tom Exp @

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

30

-->

Steve Kondik

ae271bc

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

[diff] [blame^]

31

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

32

<HTML>

33

<HEAD>

Steve Kondik

ae271bc

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

[diff] [blame^]

34

35

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

</HEAD>

<BODY>

Steve Kondik

ae271bc

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

[diff] [blame^]

41

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

42

<PRE>

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame^]

49

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

50

get_wch, wget_wch, mvget_wch, mvwget_wch, unget_wch - get

51

(or push back) a wide character from curses terminal key-

board

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame^]

56

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

57

#include <curses.h>

58

59

int get_wch(wint_t *wch);

60

int wget_wch(WINDOW *win, wint_t *wch);

61

int mvget_wch(int y, int x, wint_t *wch);

62

int mvwget_wch(WINDOW *win, int y, int x, wint_t *wch);

63

int unget_wch(const wchar_t wch);

64

65

66

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame^]

67

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

68

The get_wch, wget_wch, mvget_wch, and mvwget_wch functions

69

read a character from the terminal associated with the

70

current or specified window. In no-delay mode, if no

71

input is waiting, the value ERR is returned. In delay

72

mode, the program waits until the system passes text

73

through to the program. Depending on the setting of

74

cbreak, this is after one character (cbreak mode), or

75

after the first newline (nocbreak mode). In half-delay

76

mode, the program waits until the user types a character

77

or the specified timeout interval has elapsed.

78

79

Unless noecho has been set, these routines echo the char-

80

acter into the designated window.

81

82

If the window is not a pad and has been moved or modified

83

since the last call to wrefresh, wrefresh will be called

84

before another character is read.

85

86

If keypad is enabled, these functions respond to the

87

pressing of a function key by setting the object pointed

88

to by wch to the corresponding KEY_ value defined in

89

<curses.h> and returning KEY_CODE_YES. If a character

90

(such as escape) that could be the beginning of a function

91

key is received, curses sets a timer. If the remainder of

92

the sequence does arrive within the designated time,

93

curses passes through the character; otherwise, curses

94

returns the function key value. For this reason, many

95

terminals experience a delay between the time a user

96

presses the escape key and the time the escape is returned

97

to the program.

98

99

The unget_wch function pushes the wide character wch back

100

onto the head of the input queue, so the wide character is

101

returned by the next call to get_wch. The pushback of one

102

character is guaranteed. If the program calls unget_wch

103

too many times without an intervening call to get_wch, the

operation may fail.

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame^]

108

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

109

The header file <curses.h> automatically includes the

110

header file <stdio.h>.

111

112

Applications should not define the escape key by itself as

113

a single-character function.

114

115

When using get_wch, wget_wch, mvget_wch, or mvwget_wch,

116

applications should not use nocbreak mode and echo mode at

117

the same time. Depending on the state of the tty driver

118

when each character is typed, the program may produce

119

undesirable results.

120

121

All functions except wget_wch and unget_wch may be macros.

122

123

124

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame^]

125

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

126

When get_wch, wget_wch, mvget_wch, and mvwget_wch func-

127

tions successfully report the pressing of a function key,

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

128

they return KEY_CODE_YES. When they successfully report a

Steve Kondik

ae271bc

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

[diff] [blame^]

129

wide character, they return OK. Otherwise, they return

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

130

ERR.

131

Steve Kondik

ae271bc

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

[diff] [blame^]

132

Upon successful completion, unget_wch returns OK. Other-

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

133

wise, the function returns ERR.

134

Steve Kondik

ae271bc

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

[diff] [blame^]

135

Functions with a "mv" prefix first perform a cursor move-

136

ment using wmove, and return an error if the position is

137

outside the window, or if the window pointer is null.

138

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

139

140

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame^]

141

142

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

143

<A HREF="curs_inopts.3x.html">curs_inopts(3x)</A>, <A HREF="curs_move.3x.html">curs_move(3x)</A>, <A HREF="curs_refresh.3x.html">curs_refresh(3x)</A>

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame^]

<ul>

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

153

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

154

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

155

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

156

157

</ul>

158

</div>

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

159

</BODY>

160

</HTML>