ncurses 6.1 - patch 20190309
[ncurses.git] / form / form.h
index 05a7861af887ab29fc180ba39c91d077105eb4b4..c34be75dc2701eabbd289a2050c53dccb151a63b 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998-2014,2015 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2018,2019 Free Software Foundation, Inc.              *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
@@ -30,7 +30,7 @@
  *   Author:  Juergen Pfeifer, 1995,1997                                    *
  ****************************************************************************/
 
-/* $Id: form.h,v 0.25 2015/11/28 20:13:39 Leon.Winter Exp $ */
+/* $Id: form.h,v 0.29 2019/01/19 21:26:13 Leon.Winter Exp $ */
 
 #ifndef FORM_H
 #define FORM_H
@@ -58,18 +58,24 @@ typedef int Field_Options;
        *  _PAGE  *
        **********/
 
-typedef struct {
+typedef struct pagenode
+#if !NCURSES_OPAQUE_FORM
+{
   short pmin;          /* index of first field on page                 */
   short pmax;          /* index of last field on page                  */
   short smin;          /* index of top leftmost field on page          */
   short smax;          /* index of bottom rightmost field on page      */
-} _PAGE;
+}
+#endif /* !NCURSES_OPAQUE_FORM */
+_PAGE;
 
        /**********
        *  FIELD  *
        **********/
 
-typedef struct fieldnode {
+typedef struct fieldnode
+#if 1                  /* not yet: !NCURSES_OPAQUE_FORM */
+{
   unsigned short       status;         /* flags                        */
   short                        rows;           /* size in rows                 */
   short                        cols;           /* size in cols                 */
@@ -98,20 +104,24 @@ typedef struct fieldnode {
   /*
    * The wide-character configuration requires extra information.  Because
    * there are existing applications that manipulate the members of FIELD
-   * directly, we cannot make the struct opaque.  Offsets of members up to
-   * this point are the same in the narrow- and wide-character configuration.
-   * But note that the type of buf depends on the configuration, and is made
-   * opaque for that reason.
+   * directly, we cannot make the struct opaque, except by changing the ABI. 
+   * Offsets of members up to this point are the same in the narrow- and
+   * wide-character configuration.  But note that the type of buf depends on
+   * the configuration, and is made opaque for that reason.
    */
   NCURSES_FIELD_INTERNALS
-} FIELD;
+}
+#endif /* NCURSES_OPAQUE_FORM */
+FIELD;
 
 
        /*********
        *  FORM  *
        *********/
 
-typedef struct formnode {
+typedef struct formnode
+#if 1                  /* not yet: !NCURSES_OPAQUE_FORM */
+{
   unsigned short       status;         /* flags                        */
   short                        rows;           /* size in rows                 */
   short                        cols;           /* size in cols                 */
@@ -136,14 +146,18 @@ typedef struct formnode {
   void                 (*fieldinit)(struct formnode *);
   void                 (*fieldterm)(struct formnode *);
 
-} FORM;
+}
+#endif /* !NCURSES_OPAQUE_FORM */
+FORM;
 
 
        /**************
        *  FIELDTYPE  *
        **************/
 
-typedef struct typenode {
+typedef struct typenode
+#if !NCURSES_OPAQUE_FORM
+{
   unsigned short       status;                 /* flags                    */
   long                 ref;                    /* reference count          */
   struct typenode *    left;                   /* ptr to operand for |     */
@@ -179,7 +193,9 @@ typedef struct typenode {
   bool (*next)(FIELD *,const void *);          /* enumerate next value */
   bool (*prev)(FIELD *,const void *);          /* enumerate prev value */
 #endif
-} FIELDTYPE;
+}
+#endif /* !NCURSES_OPAQUE_FORM */
+FIELDTYPE;
 
 typedef void (*Form_Hook)(FORM *);
 
@@ -206,6 +222,8 @@ typedef void (*Form_Hook)(FORM *);
 #define O_STATIC               (0x0200U)
 #define O_DYNAMIC_JUSTIFY      (0x0400U)       /* ncurses extension    */
 #define O_NO_LEFT_STRIP                (0x0800U)       /* ncurses extension    */
+#define O_EDGE_INSERT_STAY      (0x1000U)      /* ncurses extension    */
+#define O_INPUT_LIMIT           (0x2000U)      /* ncurses extension    */
 
 /* form options */
 #define O_NL_OVERLOAD          (0x0001U)
@@ -387,6 +405,7 @@ extern NCURSES_EXPORT(int)  field_count (const FORM *);
 extern NCURSES_EXPORT(int)     set_form_win (FORM *,WINDOW *);
 extern NCURSES_EXPORT(int)     set_form_sub (FORM *,WINDOW *);
 extern NCURSES_EXPORT(int)     set_current_field (FORM *,FIELD *);
+extern NCURSES_EXPORT(int)     unfocus_current_field (FORM *);
 extern NCURSES_EXPORT(int)     field_index (const FIELD *);
 extern NCURSES_EXPORT(int)     set_form_page (FORM *,int);
 extern NCURSES_EXPORT(int)     form_page (const FORM *);