legacy_coding.3x.html 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
  2. <!--
  3. ****************************************************************************
  4. * Copyright (c) 2005,2006 Free Software Foundation, Inc. *
  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. * Author: Thomas E. Dickey
  31. * @Id: legacy_coding.3x,v 1.3 2006/12/24 15:12:55 tom Exp @
  32. -->
  33. <HTML>
  34. <HEAD>
  35. <TITLE>legacy_coding 3x</TITLE>
  36. <link rev=made href="mailto:bug-ncurses@gnu.org">
  37. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  38. </HEAD>
  39. <BODY>
  40. <H1>legacy_coding 3x</H1>
  41. <HR>
  42. <PRE>
  43. <!-- Manpage converted by man2html 3.0.1 -->
  44. <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG> <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>
  45. </PRE>
  46. <H2>NAME</H2><PRE>
  47. <STRONG>use_legacy_coding</STRONG> - use terminal's default colors
  48. </PRE>
  49. <H2>SYNOPSIS</H2><PRE>
  50. <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  51. <STRONG>int</STRONG> <STRONG>use_legacy_coding(int</STRONG> <STRONG>level);</STRONG>
  52. </PRE>
  53. <H2>DESCRIPTION</H2><PRE>
  54. The <EM>use</EM><STRONG>_</STRONG><EM>legacy</EM><STRONG>_</STRONG><EM>coding()</EM> function is an extension to the
  55. curses library. It allows the caller to change the result
  56. of <STRONG>unctrl</STRONG>, and suppress related checks within the library
  57. that would normally cause nonprinting characters to be
  58. rendered in visible form. This affects only 8-bit charac-
  59. ters.
  60. The <EM>level</EM> parameter controls the result:
  61. 0 the library functions normally, rendering non-
  62. printing characters as described in <STRONG>unctrl</STRONG>.
  63. 1 the library ignores <STRONG>isprintf</STRONG> for codes in the
  64. range 160-255.
  65. 2 the library ignores <STRONG>isprintf</STRONG> for codes in the
  66. range 128-255. It also modifies the output of
  67. <STRONG>unctrl</STRONG>, showing codes in the range 128-159 as
  68. is.
  69. </PRE>
  70. <H2>RETURN VALUE</H2><PRE>
  71. If the screen has not been initialized, or the <EM>level</EM>
  72. parameter is out of range, the function returns <STRONG>ERR</STRONG>. Oth-
  73. erwise, it returns the previous level: <STRONG>0</STRONG>, <STRONG>1</STRONG> or <STRONG>2</STRONG>.
  74. </PRE>
  75. <H2>PORTABILITY</H2><PRE>
  76. This routine is specific to ncurses. It was not supported
  77. on Version 7, BSD or System V implementations. It is rec-
  78. ommended that any code depending on ncurses extensions be
  79. conditioned using NCURSES_VERSION.
  80. </PRE>
  81. <H2>SEE ALSO</H2><PRE>
  82. <STRONG>unctrl</STRONG>.
  83. </PRE>
  84. <H2>AUTHOR</H2><PRE>
  85. Thomas Dickey (to support lynx's font-switching feature).
  86. <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>
  87. </PRE>
  88. <HR>
  89. <ADDRESS>
  90. Man(1) output converted with
  91. <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
  92. </ADDRESS>
  93. </BODY>
  94. </HTML>