Blame - doc/html/man/curs_ins_wstr.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_ins_wstr.3x,v 1.4 2005/05/15 17:02:54 tom Exp @

-->

<HTML>

<HEAD>

</HEAD>

<BODY>

<HR>

<PRE>

</PRE>

ins_wstr, ins_nwstr, wins_wstr, wins_nwstr, mvins_wstr,

51

mvins_nwstr, mvwins_wstr, mvwins_nwstr - insert a wide-

52

character string into a curses window

</PRE>

<H2>SYNOPSIS</H2><PRE>

57

#include <curses.h>

58

59

int ins_wstr(const wchar_t *wstr);

60

int ins_nwstr(const wchar_t *wstr, int n);

61

int wins_wstr(WINDOW *win, const wchar_t *wstr);

62

int wins_nwstr(WINDOW *win, const wchar_t *wstr, int n);

63

int mvins_wstr(int y, int x, const wchar_t *wstr);

64

int mvins_nwstr(int y, int x, const wchar_t *wstr, int n);

65

int mvwins_wstr(WINDOW *win, int y, int x, const wchar_t *wstr);

66

int mvwins_nwstr(WINDOW *win, int y, int x, const wchar_t *wstr, int n);

</PRE>

<H2>DESCRIPTION</H2><PRE>

71

These routines insert a wchar_t character string (as many

72

characters as will fit on the line) before the character

73

under the cursor. All characters to the right of the cur-

74

sor are shifted right, with the possibility of the right-

75

most characters on the line being lost. No wrapping is

76

performed. The cursor position does not change (after

77

moving to y, x, if specified). The four routines with n

78

as the last argument insert a leading substring of at most

79

n wchar_t characters. If n is less than 1, the entire

80

string is inserted.

81

82

If a character in wstr is a tab, newline, carriage return

83

or backspace, the cursor is moved appropriately within the

84

window. A newline also does a clrtoeol before moving.

85

Tabs are considered to be at every eighth column. If a

86

character in wstr is another control character, it is

87

drawn in the ^X notation. Calling win_wch after adding a

88

control character (and moving to it, if necessary) does

89

not return the control character, but instead returns a

90

character in the ^-representation of the control charac-

ter.

</PRE>

<H2>NOTES</H2><PRE>

Note that all but wins_nwstr may be macros.

97

98

If the first character in the string is a nonspacing char-

99

acter, these functions will fail. XSI does not define

100

what will happen if a nonspacing character follows a con-

trol character.

</PRE>

<H2>RETURN VALUES</H2><PRE>

106

Upon successful completion, these functions return OK.

107

Otherwise, they return ERR.

</PRE>

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

113

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

</PRE>

<HR>

Man(1) output converted with

</ADDRESS>

</BODY>

</HTML>