X11/Xaw/Toggle.h

0001 /*
0002  *
0003 Copyright 1989, 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 /*
0027  * ToggleP.h - Private definitions for Toggle widget
0028  *
0029  * Author: Chris D. Peterson
0030  *         MIT X Consortium
0031  *         kit@expo.lcs.mit.edu
0032  *
0033  * Date:   January 12, 1989
0034  */
0035
0036 #ifndef _XawToggle_h
0037 #define _XawToggle_h
0038
0039 #include <X11/Xaw/Command.h>
0040
0041 /* Resources:
0042
0043  Name            Class      RepType     Default Value
0044  ----            -----      -------     -------------
0045  radioGroup          RadioGroup         Widget          NULL              +
0046  radioData           RadioData          Pointer         (XPointer) Widget  ++
0047  state               State              Boolean         Off
0048
0049  background      Background     Pixel       XtDefaultBackground
0050  bitmap          Pixmap     Pixmap      None
0051  border          BorderColor    Pixel       XtDefaultForeground
0052  borderWidth         BorderWidth    Dimension   1
0053  callback        Callback       Pointer     NULL
0054  cursor          Cursor     Cursor      None
0055  destroyCallback     Callback       Pointer     NULL
0056  displayList         DisplayList    XawDisplayList* NULL
0057  font            Font       XFontStructx*   XtDefaultFont
0058  foreground      Foreground     Pixel       XtDefaultForeground
0059  height          Height     Dimension   text height
0060  highlightThickness  Thickness      Dimension   2
0061  insensitiveBorder   Insensitive    Pixmap      Gray
0062  internalHeight      Height     Dimension   2
0063  internalWidth       Width      Dimension   4
0064  justify         Justify        XtJustify   XtJustifyCenter
0065  label           Label      String      NULL
0066  mappedWhenManaged   MappedWhenManaged  Boolean     True
0067  resize          Resize     Boolean     True
0068  sensitive       Sensitive      Boolean     True
0069  width           Width      Dimension   text width
0070  x           Position       Position    0
0071  y           Position       Position    0
0072
0073 + To use the toggle as a radio toggle button, set this resource to point to
0074   any other widget in the radio group.
0075
0076 ++ This is the data returned from a call to XtToggleGetCurrent, by default
0077    this is set to the name of toggle widget.
0078
0079 */
0080
0081 /*
0082  * These should be in StringDefs.h but aren't so we will define
0083  * them here if they are needed
0084  */
0085 #define XtCWidget "Widget"
0086 #define XtCState "State"
0087 #define XtCRadioGroup "RadioGroup"
0088 #define XtCRadioData "RadioData"
0089
0090 #ifndef _XtStringDefs_h_
0091 #define XtRWidget "Widget"
0092 #endif
0093
0094 #define XtNstate "state"
0095 #define XtNradioGroup "radioGroup"
0096 #define XtNradioData "radioData"
0097
0098 extern WidgetClass               toggleWidgetClass;
0099
0100 typedef struct _ToggleClassRec   *ToggleWidgetClass;
0101 typedef struct _ToggleRec        *ToggleWidget;
0102
0103 /*
0104  * Public Functions
0105  */
0106
0107 _XFUNCPROTOBEGIN
0108
0109 /*
0110  * Function:
0111  *  XawToggleChangeRadioGroup
0112  *
0113  * Parameters:
0114  *  w       - toggle widget to change lists
0115  *  radio_group - any widget in the new list
0116  *
0117  * Description:
0118  *  Allows a toggle widget to change radio lists.
0119  */
0120 void XawToggleChangeRadioGroup
0121 (
0122  Widget     w,
0123  Widget     radio_group
0124  );
0125
0126 /*
0127  * Function:
0128  *  XawToggleGetCurrent
0129  *
0130  * Parameters:
0131  *  radio_group - any toggle widget in the toggle list
0132  *
0133  * Description:
0134  *    Returns the RadioData associated with the toggle
0135  *                   widget that is currently active in a toggle list.
0136  * Returns:
0137  *  The XtNradioData associated with the toggle widget
0138  */
0139
0140 XtPointer XawToggleGetCurrent
0141 (
0142  Widget     radio_group
0143  );
0144
0145 /*
0146  * Function:
0147  *  XawToggleSetCurrent
0148  *
0149  * Parameters:
0150  *  radio_group - any toggle widget in the toggle list
0151  *  radio_data - radio data of the toggle widget to set
0152  *
0153  * Description:
0154  *  Sets the Toggle widget associated with the radio_data specified.
0155  */
0156 void XawToggleSetCurrent
0157 (
0158  Widget     radio_group,
0159  XtPointer  radio_data
0160  );
0161
0162 /*
0163  * Function:
0164  *  XawToggleUnsetCurrent
0165  *
0166  * Parameters:
0167  *  radio_group - any toggle widget in the toggle list
0168  *
0169  * Description:
0170  *  Unsets all Toggles in the radio_group specified.
0171  */
0172 void XawToggleUnsetCurrent
0173 (
0174  Widget     radio_group
0175  );
0176
0177 _XFUNCPROTOEND
0178
0179 #endif /* _XawToggle_h */