X11/Xaw/Tip.h

0001 /*
0002  * Copyright (c) 1999 by The XFree86 Project, Inc.
0003  *
0004  * Permission is hereby granted, free of charge, to any person obtaining a
0005  * copy of this software and associated documentation files (the "Software"),
0006  * to deal in the Software without restriction, including without limitation
0007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
0008  * and/or sell copies of the Software, and to permit persons to whom the
0009  * Software is furnished to do so, subject to the following conditions:
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
0017  * THE XFREE86 PROJECT BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
0018  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
0019  * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
0020  * SOFTWARE.
0021  *
0022  * Except as contained in this notice, the name of the XFree86 Project shall
0023  * not be used in advertising or otherwise to promote the sale, use or other
0024  * dealings in this Software without prior written authorization from the
0025  * XFree86 Project.
0026  *
0027  * Author: Paulo César Pereira de Andrade
0028  */
0029
0030 #ifndef _XawTip_h
0031 #define _XawTip_h
0032
0033 /*
0034  * Tip Widget
0035  */
0036
0037 #include <X11/Xaw/Simple.h>
0038
0039 /* Resources:
0040
0041   Name          Class       RepType     Default Value
0042   ----          -----       -------     -------------
0043   background        Background      Pixel       XtDefaultBackground
0044   backgroundPixmap  BackgroundPixmap    Pixmap      XtUnspecifiedPixmap
0045   border        BorderColor     Pixel       XtDefaultForeground
0046   borderWidth       BorderWidth     Dimension   1
0047   bottomMargin      VerticalMargins Dimension   2
0048   destroyCallback   Callback        XtCallbackList  NULL
0049   displayList       DisplayList     XawDisplayList* NULL
0050   font          Font        XFontStruct*    XtDefaultFont
0051   foreground        Foreground      Pixel       XtDefaultForeground
0052   height        Height      Dimension   text height
0053   leftMargin        HorizontalMargins   Dimension   6
0054   rightMargin       HorizontalMargins   Dimension   6
0055   timeout       Timeout     Int     500
0056   topMargin     VerticalMargins Dimension   2
0057   width         Width       Dimension   text width
0058   x         Position        Position    0
0059   y         Position        Position    0
0060
0061 */
0062
0063 typedef struct _TipClassRec *TipWidgetClass;
0064 typedef struct _TipRec *TipWidget;
0065
0066 extern WidgetClass tipWidgetClass;
0067
0068 #define XtNbottomMargin     "bottomMargin"
0069 #define XawNdisplayList     "displayList"
0070 #define XtNencoding     "encoding"
0071 #define XtNleftMargin       "leftMargin"
0072 #define XtNrightMargin      "rightMargin"
0073 #define XtNtimeout      "timeout"
0074 #define XtNtopMargin        "topMargin"
0075 #define XtNtip          "tip"
0076
0077 #define XawCDisplayList     "DisplayList"
0078 #define XtCHorizontalMargins    "HorizontalMargins"
0079 #define XtCTimeout      "Timeout"
0080 #define XtCVerticalMargins  "VerticalMargins"
0081 #define XtCTip          "Tip"
0082
0083 #define XawRDisplayList     "XawDisplayList"
0084
0085 /*
0086  * Public Functions
0087  */
0088 /*
0089  * Function:
0090  *  XawTipEnable
0091  *
0092  * Parameters:
0093  *  w - widget
0094  *
0095  * Description:
0096  *  Enables the tip event handler for this widget.
0097  */
0098 void XawTipEnable
0099 (
0100  Widget     w
0101  );
0102
0103 /*
0104  * Function:
0105  *  XawTipEnable
0106  *
0107  * Parameters:
0108  *  w - widget
0109  *
0110  * Description:
0111  *  Disables the tip event handler for this widget.
0112  */
0113 void XawTipDisable
0114 (
0115  Widget     w
0116  );
0117
0118 #endif /* _XawTip_h */