X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_field_buffer.3x.html;h=995f4620a94dde4f4a5161c31e21e734e01652d2;hp=8e99806ddbf31890f6f2e176c747c7f0f4ab09db;hb=71c0306f0824ef2b10c4c5813fb003db48f3012e;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/doc/html/man/form_field_buffer.3x.html b/doc/html/man/form_field_buffer.3x.html index 8e99806d..995f4620 100644 --- a/doc/html/man/form_field_buffer.3x.html +++ b/doc/html/man/form_field_buffer.3x.html @@ -2,7 +2,7 @@ @@ -65,21 +65,41 @@

DESCRIPTION

        The function set_field_buffer sets the numbered buffer  of
-       the  given  field  to contain a given string.  Buffer 0 is
-       the displayed value of the field; other  numbered  buffers
-       may be allocated by applications through the nbuf argument
-       of (see form_field_new(3x)) but are not manipulated by the
-       forms  library.   The  function  field_buffer  returns the
-       address of the buffer.  Please note that this  buffer  has
-       always  the  length  of the buffer, that means that it may
-       typically contain trailing spaces. If you entered  leading
-       spaces  the  buffer may also contain them. If you want the
-       raw data, you must write your own routine that copies  the
-       value out of the buffer and removes the leading and trail-
-       ing spaces. Please note also, that  subsequent  operations
-       on  the  form  will  probably  change  the  content of the
-       buffer. So do not use it for  long  term  storage  of  the
-       entered form data.
+       the given field to contain a given string:
+
+          -  Buffer 0 is the displayed value of the field.
+
+          -  Other  numbered buffers may be allocated by applica-
+             tions   through   the   nbuf   argument   of    (see
+             form_field_new(3x))  but  are not manipulated by the
+             forms library.
+
+       The function field_buffer returns a pointer  to  the  con-
+       tents of the given numbered buffer:
+
+          -  The buffer contents always have the same length, and
+             are padded with trailing spaces as needed to  ensure
+             this length is the same.
+
+          -  The  buffer may contain leading spaces, depending on
+             how it was set.
+
+          -  The buffer contents are set  with  set_field_buffer,
+             or as a side effect of any editing operations on the
+             corresponding field.
+
+          -  Editing operations are based  on  the  window  which
+             displays  the field, rather than a string.  The win-
+             dow  contains  only  printable  characters,  and  is
+             filled  with  blanks.  If you want the raw data, you
+             must write your own routine that  copies  the  value
+             out of the buffer and removes the leading and trail-
+             ing spaces.
+
+          -  Because editing operations change the content of the
+             buffer  to  correspond to the window, you should not
+             rely on using buffers for long-term storage of  form
+             data.
 
        The  function  set_field_status sets the associated status
        flag of field; field_status gets the current  value.   The
@@ -130,8 +150,8 @@
        When  configured for wide-characters, field_buffer returns
        a pointer to temporary storage (allocated and freed by the
        library).   The  application  should not attempt to modify
-       the  data.   It  will  be  freed  on  the  next  call   to
-       field_buffer to return the same buffer.  <curses.h>.
+       the data.  It will be freed on the next call to field_buf-
+       fer to return the same buffer.  <curses.h>.