X11/Xaw/Paned.h

0001 /***********************************************************
0002
0003 Copyright 1987, 1988, 1994, 1998  The Open Group
0004
0005 Permission to use, copy, modify, distribute, and sell this software and its
0006 documentation for any purpose is hereby granted without fee, provided that
0007 the above copyright notice appear in all copies and that both that
0008 copyright notice and this permission notice appear in supporting
0009 documentation.
0010
0011 The above copyright notice and this permission notice shall be included in
0012 all copies or substantial portions of the Software.
0013
0014 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
0015 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
0016 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
0017 OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
0018 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
0019 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0020
0021 Except as contained in this notice, the name of The Open Group shall not be
0022 used in advertising or otherwise to promote the sale, use or other dealings
0023 in this Software without prior written authorization from The Open Group.
0024
0025
0026 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts.
0027
0028                         All Rights Reserved
0029
0030 Permission to use, copy, modify, and distribute this software and its
0031 documentation for any purpose and without fee is hereby granted,
0032 provided that the above copyright notice appear in all copies and that
0033 both that copyright notice and this permission notice appear in
0034 supporting documentation, and that the name of Digital not be
0035 used in advertising or publicity pertaining to distribution of the
0036 software without specific, written prior permission.
0037
0038 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
0039 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
0040 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
0041 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
0042 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
0043 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
0044 SOFTWARE.
0045
0046 ******************************************************************/
0047
0048 /*
0049  * Paned.h - Paned Composite Widget's public header file.
0050  *
0051  * Updated and significantly modifided from the Athena VPaned Widget.
0052  *
0053  * Date:    March 1, 1989
0054  *
0055  * By:      Chris D. Peterson
0056  *          MIT X Consortium
0057  *          kit@expo.lcs.mit.edu
0058  */
0059
0060 #ifndef _XawPaned_h
0061 #define _XawPaned_h
0062
0063 #include <X11/Intrinsic.h>
0064 #include <X11/Xmu/Converters.h>
0065
0066 /* RESOURCES:
0067
0068  Name                Class         RepType      Default Value
0069  ----                -----         -------      -------------
0070  background          Background    Pixel        XtDefaultBackground
0071  betweenCursor           Cursor            Cursor       **
0072  border              BorderColor       Pixel        XtDefaultForeground
0073  borderWidth             BorderWidth       Dimension        1
0074  cursor              Cursor            Cursor       None
0075  destroyCallback         Callback      Pointer      NULL
0076  height              Height            Dimension        0
0077  gripIndent          GripIndent    Position     16
0078  gripCursor          Cursor            Cursor       **
0079  horizontalGripCursol    Cursor            Cursor       sb_h_double_arrow
0080  horizontalBetweencursor Cursor            Cursor       sb_up_arrow
0081  internalBorderColor     BorderColor       Pixel        XtDefaultForeground
0082  internalBorderWidth     BorderWidth       Position     1
0083  leftCursor          Cursor            Cursor       sb_left_arrow
0084  lowerCursor             Cursor            Cursor       sb_down_arrow
0085  mappedWhenManaged       MappedWhenManaged Boolean      True
0086  orientation             Orientation       XtOrientation    XtorientVertical
0087  refigureMode            Boolean       Boolean      On
0088  rightCursor             Cursor            Cursor           sb_right_arrow
0089  sensitive           Sensitive     Boolean      True
0090  upperCursor             Cursor            Cursor       sb_up_arrow
0091  verticalBetweenCursor   Cursor            Cursor           sb_left_arrow
0092  verticalGripCursor      Cursor            Cursor           sb_v_double_arrow
0093  width               Width             Dimension        0
0094  x               Position      Position     0
0095  y               Position      Position     0
0096
0097 ** These resources now are set to the vertical or horizontal cursor
0098    depending upon orientation, by default.  If a value is specified here
0099    then that cursor will be used regardless of orientation.
0100
0101
0102 CONSTRAINT RESOURCES:
0103
0104  Name             Class     RepType     Default Value
0105  ----             -----     -------     -------------
0106  allowResize          Boolean           Boolean         False
0107  max              Max           Dimension   unlimited
0108  min              Min       Dimension   Grip Size
0109  preferredPaneSize    PreferredPaneSize Dimension   PANED_ASK_CHILD
0110  resizeToPreferred    Boolean       Boolean     False
0111  showGrip         ShowGrip      Boolean     True
0112  skipAdjust       Boolean           Boolean         False
0113
0114 */
0115
0116 #define PANED_ASK_CHILD 0
0117 #define PANED_GRIP_SIZE 0
0118
0119 #define XtNallowResize "allowResize"
0120 #define XtNbetweenCursor "betweenCursor"
0121 #define XtNverticalBetweenCursor "verticalBetweenCursor"
0122 #define XtNhorizontalBetweenCursor "horizontalBetweenCursor"
0123 #define XtNgripCursor "gripCursor"
0124 #define XtNgripIndent "gripIndent"
0125 #define XtNhorizontalGripCursor "horizontalGripCursor"
0126 #define XtNinternalBorderColor "internalBorderColor"
0127 #define XtNinternalBorderWidth "internalBorderWidth"
0128 #define XtNleftCursor "leftCursor"
0129 #define XtNlowerCursor "lowerCursor"
0130 #define XtNrefigureMode "refigureMode"
0131 #define XtNposition "position"
0132 #define XtNmin "min"
0133 #define XtNmax "max"
0134 #define XtNpreferredPaneSize "preferredPaneSize"
0135 #define XtNresizeToPreferred "resizeToPreferred"
0136 #define XtNrightCursor "rightCursor"
0137 #define XtNshowGrip "showGrip"
0138 #define XtNskipAdjust "skipAdjust"
0139 #define XtNupperCursor "upperCursor"
0140 #define XtNverticalGripCursor "verticalGripCursor"
0141
0142 #define XtCGripIndent "GripIndent"
0143 #define XtCMin "Min"
0144 #define XtCMax "Max"
0145 #define XtCPreferredPaneSize "PreferredPaneSize"
0146 #define XtCShowGrip "ShowGrip"
0147
0148 /* Class record constant */
0149 extern WidgetClass panedWidgetClass;
0150
0151 typedef struct _PanedClassRec   *PanedWidgetClass;
0152 typedef struct _PanedRec    *PanedWidget;
0153
0154 /*
0155  *  Public Procedures
0156  */
0157
0158 _XFUNCPROTOBEGIN
0159
0160 /*
0161  * Function:
0162  *  XawPanedSetMinMax
0163  *
0164  * Parameters:
0165  *  widget - widget that is a child of the Paned widget
0166  *  min    - new min and max size for the pane
0167  *  max    - ""
0168  *
0169  * Description:
0170  *  Sets the min and max size for a pane.
0171  */
0172 void XawPanedSetMinMax
0173 (
0174  Widget         w,
0175  int            min,
0176  int            max
0177  );
0178
0179 /*
0180  * Function:
0181  *  XawPanedGetMinMax
0182  *
0183  * Parameters:
0184  *  widget - widget that is a child of the Paned widget
0185  *  min    - return the current min and max size for the pane
0186  *  max    - ""
0187  *
0188  * Description:
0189  *  Gets the min and max size for a pane.
0190  */
0191 void XawPanedGetMinMax
0192 (
0193  Widget         w,
0194  int            *min_return,
0195  int            *max_return
0196  );
0197
0198 /*
0199  * Function:
0200  *  XawPanedSetRefigureMode
0201  *
0202  * Parameters:
0203  *  w    - paned widget
0204  *  mode - if False then inhibit refigure
0205  *
0206  * Description:
0207  *    Allows a flag to be set the will inhibit  the paned widgets
0208  *  relayout routine.
0209  */
0210 void XawPanedSetRefigureMode
0211 (
0212  Widget         w,
0213 #if NeedWidePrototypes
0214  int            mode
0215 #else
0216  Boolean        mode
0217 #endif
0218  );
0219
0220 /*
0221  * Function:
0222  *  XawPanedGetNumSub
0223  *
0224  * Parameters:
0225  *  w - paned widget
0226  *
0227  * Returns:
0228  *  Number of panes in the paned widget.
0229  */
0230 int XawPanedGetNumSub
0231 (
0232  Widget         w
0233  );
0234
0235 /*
0236  * Function:
0237  *  XawPanedAllowResize
0238  *
0239  * Parameters:
0240  *  widget - child of the paned widget
0241  *
0242  * Description:
0243  *    Allows a flag to be set that determines if the paned widget will
0244  *  allow geometry requests from this child
0245  */
0246 void XawPanedAllowResize
0247 (
0248  Widget         w,
0249 #if NeedWidePrototypes
0250  int            allow_resize
0251 #else
0252  Boolean        allow_resize
0253 #endif
0254  );
0255
0256 _XFUNCPROTOEND
0257
0258 #endif /* _XawPaned_h */