components/x11/libXaw5/src/X11/Paned.h

   1 /*
   2 * $XConsortium: Paned.h,v 1.15 94/04/17 20:12:29 kaleb Exp $
   3 */
   4
   5
   6 /***********************************************************
   7
   8 Copyright (c) 1987, 1988, 1994  X Consortium
   9
  10 Permission is hereby granted, free of charge, to any person obtaining a copy
  11 of this software and associated documentation files (the "Software"), to deal
  12 in the Software without restriction, including without limitation the rights
  13 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14 copies of the Software, and to permit persons to whom the Software is
  15 furnished to do so, subject to the following conditions:
  16
  17 The above copyright notice and this permission notice shall be included in
  18 all copies or substantial portions of the Software.
  19
  20 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  23 X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  24 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  25 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  26
  27 Except as contained in this notice, the name of the X Consortium shall not be
  28 used in advertising or otherwise to promote the sale, use or other dealings
  29 in this Software without prior written authorization from the X Consortium.
  30
  31
  32 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts.
  33
  34                         All Rights Reserved
  35
  36 Permission to use, copy, modify, and distribute this software and its
  37 documentation for any purpose and without fee is hereby granted,
  38 provided that the above copyright notice appear in all copies and that
  39 both that copyright notice and this permission notice appear in
  40 supporting documentation, and that the name of Digital not be
  41 used in advertising or publicity pertaining to distribution of the
  42 software without specific, written prior permission.
  43
  44 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  45 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  46 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  47 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  48 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  49 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  50 SOFTWARE.
  51
  52 ******************************************************************/
  53
  54 /*
  55  * Paned.h - Paned Composite Widget's public header file.
  56  *
  57  * Updated and significantly modifided from the Athena VPaned Widget.
  58  *
  59  * Date:    March 1, 1989
  60  *
  61  * By:      Chris D. Peterson
  62  *          MIT X Consortium
  63  *          kit@expo.lcs.mit.edu
  64  */
  65
  66 #ifndef _XawPaned_h
  67 #define _XawPaned_h
  68
  69 #include <X11/Constraint.h>
  70 #include <X11/Xmu/Converters.h>
  71
  72 /****************************************************************
  73  *
  74  * Vertical Paned Widget (SubClass of CompositeClass)
  75  *
  76  ****************************************************************/
  77
  78 /* RESOURCES:
  79
  80  Name                    Class             RepType          Default Value
  81  ----                    -----             -------          -------------
  82  background              Background        Pixel            XtDefaultBackground
  83  betweenCursor           Cursor            Cursor           **
  84  border                  BorderColor       Pixel            XtDefaultForeground
  85  borderWidth             BorderWidth       Dimension        1
  86  cursor                  Cursor            Cursor           None
  87  destroyCallback         Callback          Pointer          NULL
  88  height                  Height            Dimension        0
  89  gripIndent              GripIndent        Position         16
  90  gripCursor              Cursor            Cursor           **
  91  horizontalGripCursol    Cursor            Cursor           sb_h_double_arrow
  92  horizontalBetweencursor Cursor            Cursor           sb_up_arrow
  93  internalBorderColor     BorderColor       Pixel            XtDefaultForeground
  94  internalBorderWidth     BorderWidth       Position         1
  95  leftCursor              Cursor            Cursor           sb_left_arrow
  96  lowerCursor             Cursor            Cursor           sb_down_arrow
  97  mappedWhenManaged       MappedWhenManaged Boolean          True
  98  orientation             Orientation       XtOrientation    XtorientVertical
  99  refigureMode            Boolean           Boolean          On
 100  rightCursor             Cursor            Cursor           sb_right_arrow
 101  sensitive               Sensitive         Boolean          True
 102  upperCursor             Cursor            Cursor           sb_up_arrow
 103  verticalBetweenCursor   Cursor            Cursor           sb_left_arrow
 104  verticalGripCursor      Cursor            Cursor           sb_v_double_arrow
 105  width                   Width             Dimension        0
 106  x                       Position          Position         0
 107  y                       Position          Position         0
 108
 109 ** These resources now are set to the vertical or horizontal cursor
 110    depending upon orientation, by default.  If a value is specified here
 111    then that cursor will be used reguardless of orientation.
 112
 113
 114 CONSTRAINT RESOURCES:
 115
 116  Name                 Class             RepType         Default Value
 117  ----                 -----             -------         -------------
 118  allowResize          Boolean           Boolean         False
 119  max                  Max               Dimension       unlimited
 120  min                  Min               Dimension       Grip Size
 121  preferredPaneSize    PerferredPaneSize Dimension       PANED_ASK_CHILD
 122  resizeToPreferred    Boolean           Boolean         False
 123  showGrip             ShowGrip          Boolean         True
 124  skipAdjust           Boolean           Boolean         False
 125
 126 */
 127
 128 #define PANED_ASK_CHILD 0
 129 #define PANED_GRIP_SIZE 0
 130
 131 /* New Fields */
 132 #define XtNallowResize "allowResize"
 133 #define XtNbetweenCursor "betweenCursor"
 134 #define XtNverticalBetweenCursor "verticalBetweenCursor"
 135 #define XtNhorizontalBetweenCursor "horizontalBetweenCursor"
 136 #define XtNgripCursor "gripCursor"
 137 #define XtNgripIndent "gripIndent"
 138 #define XtNhorizontalGripCursor "horizontalGripCursor"
 139 #define XtNinternalBorderColor "internalBorderColor"
 140 #define XtNinternalBorderWidth "internalBorderWidth"
 141 #define XtNleftCursor "leftCursor"
 142 #define XtNlowerCursor "lowerCursor"
 143 #define XtNrefigureMode "refigureMode"
 144 #define XtNposition "position"
 145 #define XtNmin "min"
 146 #define XtNmax "max"
 147 #define XtNpreferredPaneSize "preferredPaneSize"
 148 #define XtNresizeToPreferred "resizeToPreferred"
 149 #define XtNrightCursor "rightCursor"
 150 #define XtNshowGrip "showGrip"
 151 #define XtNskipAdjust "skipAdjust"
 152 #define XtNupperCursor "upperCursor"
 153 #define XtNverticalGripCursor "verticalGripCursor"
 154
 155 #define XtCGripIndent "GripIndent"
 156 #define XtCMin "Min"
 157 #define XtCMax "Max"
 158 #define XtCPreferredPaneSize "PreferredPaneSize"
 159 #define XtCShowGrip "ShowGrip"
 160
 161 /* Class record constant */
 162 extern WidgetClass panedWidgetClass;
 163
 164 typedef struct _PanedClassRec   *PanedWidgetClass;
 165 typedef struct _PanedRec        *PanedWidget;
 166
 167 /************************************************************
 168  *
 169  *  Public Procedures
 170  *
 171  ************************************************************/
 172
 173 _XFUNCPROTOBEGIN
 174
 175 /*      Function Name: XawPanedSetMinMax
 176  *      Description: Sets the min and max size for a pane.
 177  *      Arguments: widget - the widget that is a child of the Paned widget.
 178  *                 min, max - the new min and max size for the pane.
 179  *      Returns: none.
 180  */
 181
 182 extern void XawPanedSetMinMax(
 183 #if NeedFunctionPrototypes
 184     Widget              /* w */,
 185     int                 /* min */,
 186     int                 /* max */
 187 #endif
 188 );
 189
 190 /*      Function Name: XawPanedGetMinMax
 191  *      Description: Gets the min and max size for a pane.
 192  *      Arguments: widget - the widget that is a child of the Paned widget.
 193  ** RETURNED **    min, max - the current min and max size for the pane.
 194  *      Returns: none.
 195  */
 196
 197 extern void XawPanedGetMinMax(
 198 #if NeedFunctionPrototypes
 199     Widget              /* w */,
 200     int *               /* min_return */,
 201     int *               /* max_return */
 202 #endif
 203 );
 204
 205 /*      Function Name: XawPanedSetRefigureMode
 206  *      Description: Allows a flag to be set the will inhibit
 207  *                   the paned widgets relayout routine.
 208  *      Arguments: w - the paned widget.
 209  *                 mode - if FALSE then inhibit refigure.
 210  *      Returns: none.
 211  */
 212
 213 extern void XawPanedSetRefigureMode(
 214 #if NeedFunctionPrototypes
 215     Widget              /* w */,
 216 #if NeedWidePrototypes
 217     /* Boolean */ int   /* mode */
 218 #else
 219     Boolean             /* mode */
 220 #endif
 221 #endif
 222 );
 223
 224 /*      Function Name: XawPanedGetNumSub
 225  *      Description: Returns the number of panes in the paned widget.
 226  *      Arguments: w - the paned widget.
 227  *      Returns: the number of panes in the paned widget.
 228  */
 229
 230 extern int XawPanedGetNumSub(
 231 #if NeedFunctionPrototypes
 232     Widget              /* w */
 233 #endif
 234 );
 235
 236 /*      Function Name: XawPanedAllowResize
 237  *      Description: Allows a flag to be set that determines if the paned
 238  *                   widget will allow geometry requests from this child
 239  *      Arguments: widget - a child of the paned widget.
 240  *      Returns: none.
 241  */
 242
 243 extern void XawPanedAllowResize(
 244 #if NeedFunctionPrototypes
 245     Widget              /* w */,
 246 #if NeedWidePrototypes
 247     /* Boolean */ int   /* allow_resize */
 248 #else
 249     Boolean             /* allow_resize */
 250 #endif
 251 #endif
 252 );
 253
 254 _XFUNCPROTOEND
 255
 256 #endif /* _XawPaned_h */