form_field_attributes.3x.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  1. <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
  2. <!--
  3. * t
  4. ****************************************************************************
  5. * Copyright (c) 1998-2002,2006 Free Software Foundation, Inc. *
  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. ****************************************************************************
  31. * @Id: form_field_attributes.3x,v 1.10 2006/11/04 18:51:26 tom Exp @
  32. -->
  33. <HTML>
  34. <HEAD>
  35. <TITLE>form_field_attributes 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>form_field_attributes 3x</H1>
  41. <HR>
  42. <PRE>
  43. <!-- Manpage converted by man2html 3.0.1 -->
  44. <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG> <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
  45. </PRE>
  46. <H2>NAME</H2><PRE>
  47. <STRONG>form_field_attributes</STRONG> - color and attribute control for
  48. form fields
  49. </PRE>
  50. <H2>SYNOPSIS</H2><PRE>
  51. <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  52. int set_field_fore(FIELD *field, chtype attr);
  53. chtype field_fore(const FIELD *field);
  54. int set_field_back(FIELD *field, chtype attr);
  55. chtype field_back(const FIELD *field);
  56. int set_field_pad(FIELD *field, int pad);
  57. int field_pad(const FIELD *field);
  58. </PRE>
  59. <H2>DESCRIPTION</H2><PRE>
  60. The function <STRONG>set_field_fore</STRONG> sets the foreground attribute
  61. of <EM>field</EM>. This is the highlight used to display the field
  62. contents. The function <STRONG>field_fore</STRONG> returns the foreground
  63. attribute. The default is <STRONG>A_STANDOUT</STRONG>.
  64. The function <STRONG>set_field_back</STRONG> sets the background attribute
  65. of <EM>form</EM>. This is the highlight used to display the extent
  66. fields in the form. The function <STRONG>field_back</STRONG> returns the
  67. background attribute. The default is <STRONG>A_NORMAL</STRONG>.
  68. The function <STRONG>set_field_pad</STRONG> sets the character used to fill
  69. the field. The function <STRONG>field_pad</STRONG> returns the given
  70. form's pad character. The default is a blank.
  71. </PRE>
  72. <H2>RETURN VALUE</H2><PRE>
  73. These routines return one of the following:
  74. <STRONG>E_OK</STRONG> The routine succeeded.
  75. <STRONG>E_BAD_ARGUMENT</STRONG>
  76. Routine detected an incorrect or out-of-range argu-
  77. ment.
  78. <STRONG>E_SYSTEM_ERROR</STRONG>
  79. System error occurred (see <STRONG>errno</STRONG>).
  80. </PRE>
  81. <H2>SEE ALSO</H2><PRE>
  82. <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
  83. detailed descriptions of the entry points.
  84. </PRE>
  85. <H2>NOTES</H2><PRE>
  86. The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
  87. file <STRONG>&lt;curses.h&gt;</STRONG>.
  88. </PRE>
  89. <H2>PORTABILITY</H2><PRE>
  90. These routines emulate the System V forms library. They
  91. were not supported on Version 7 or BSD versions.
  92. </PRE>
  93. <H2>AUTHORS</H2><PRE>
  94. Juergen Pfeifer. Manual pages and adaptation for new
  95. curses by Eric S. Raymond.
  96. <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
  97. </PRE>
  98. <HR>
  99. <ADDRESS>
  100. Man(1) output converted with
  101. <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
  102. </ADDRESS>
  103. </BODY>
  104. </HTML>