fe658b59eced1168e18fdf8b5d86404558bd3e0f
[framework/uifw/xorg/lib/libxaw.git] / include / X11 / Xaw / FormP.h
1 /***********************************************************
2
3 Copyright 1987, 1988, 1994, 1998  The Open Group
4
5 Permission to use, copy, modify, distribute, and sell this software and its
6 documentation for any purpose is hereby granted without fee, provided that
7 the above copyright notice appear in all copies and that both that
8 copyright notice and this permission notice appear in supporting
9 documentation.
10
11 The above copyright notice and this permission notice shall be included in
12 all copies or substantial portions of the Software.
13
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
17 OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
18 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20
21 Except as contained in this notice, the name of The Open Group shall not be
22 used in advertising or otherwise to promote the sale, use or other dealings
23 in this Software without prior written authorization from The Open Group.
24
25
26 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts.
27
28                         All Rights Reserved
29
30 Permission to use, copy, modify, and distribute this software and its 
31 documentation for any purpose and without fee is hereby granted, 
32 provided that the above copyright notice appear in all copies and that
33 both that copyright notice and this permission notice appear in 
34 supporting documentation, and that the name of Digital not be
35 used in advertising or publicity pertaining to distribution of the
36 software without specific, written prior permission.  
37
38 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
39 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
40 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
41 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
42 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
43 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
44 SOFTWARE.
45
46 ******************************************************************/
47
48 /* Form widget private definitions */
49
50 #ifndef _XawFormP_h
51 #define _XawFormP_h
52
53 #include <X11/Xfuncproto.h>
54
55 #include <X11/Xaw/Form.h>
56 #include <X11/Xaw/XawInit.h>
57
58 _XFUNCPROTOBEGIN
59
60 #define XtREdgeType "EdgeType"
61
62 typedef enum {
63     LayoutPending,
64     LayoutInProgress,
65     LayoutDone
66 } LayoutState;
67
68 #define XtInheritLayout                                                 \
69 ((Boolean (*)(FormWidget, unsigned int, unsigned int, Bool))_XtInherit)
70
71 typedef struct {
72     Boolean(*layout)(FormWidget, unsigned int, unsigned int, Bool);
73 #ifndef OLDXAW
74     XtPointer extension;
75 #endif
76 } FormClassPart;
77
78 typedef struct _FormClassRec {
79     CoreClassPart       core_class;
80     CompositeClassPart  composite_class;
81     ConstraintClassPart constraint_class;
82     FormClassPart       form_class;
83 } FormClassRec;
84
85 extern FormClassRec formClassRec;
86
87 typedef struct _FormPart {
88     /* resources */
89     int         default_spacing;    /* default distance between children */
90
91     /* private */
92     Dimension   old_width, old_height; /* reference value for *_virtual  */
93     int         no_refigure;        /* no re-layout while > 0            */
94     Boolean     needs_relayout;     /* next time no_refigure == 0        */
95     Boolean     resize_in_layout;   /* should layout() do geom request?  */
96     Dimension   preferred_width, preferred_height; /* cached from layout */
97     Boolean     resize_is_no_op;    /* Causes resize to take not action  */
98 #ifndef OLDXAW
99     XawDisplayList *display_list;
100     XtPointer pad[4];   /* for future use and keep binary compatability */
101 #endif
102 } FormPart;
103
104 typedef struct _FormRec {
105     CorePart            core;
106     CompositePart       composite;
107     ConstraintPart      constraint;
108     FormPart            form;
109 } FormRec;
110
111 typedef struct _FormConstraintsPart {
112     /* resources */
113     XtEdgeType top, bottom, left, right;/* where to drag edge on resize */
114     int         dx;             /* desired horiz offset                 */
115     int         dy;             /* desired vertical offset              */
116     Widget      horiz_base;     /* measure dx from here if non-null     */
117     Widget      vert_base;      /* measure dy from here if non-null     */
118     Boolean     allow_resize;   /* True if child may request resize     */
119
120     /* private */
121     short       virtual_width, virtual_height;
122     Position    new_x, new_y;
123     LayoutState layout_state;   /* temporary layout state               */
124     Boolean     deferred_resize;/* was resized while no_refigure is set */
125 #ifndef OLDXAW
126     short       virtual_x, virtual_y;
127     XtPointer   pad[2];         /* leave some space for further optimizations
128                                  * in the form widget geometry
129                                  */
130 #endif
131 } FormConstraintsPart;
132
133 typedef struct _FormConstraintsRec {
134     FormConstraintsPart form;
135 } FormConstraintsRec, *FormConstraints;
136
137 _XFUNCPROTOEND
138
139 #endif /* _XawFormP_h */