1 /*
2  * Copyright (c) 1999 by The XFree86 Project, Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
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
17  * THE XFREE86 PROJECT BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
18  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
19  * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20  * SOFTWARE.
21  *
22  * Except as contained in this notice, the name of the XFree86 Project shall
23  * not be used in advertising or otherwise to promote the sale, use or other
24  * dealings in this Software without prior written authorization from the
25  * XFree86 Project.
26  *
27  * Author: Paulo César Pereira de Andrade
28  */
29 
30 #ifndef _XawTip_h
31 #define _XawTip_h
32 
33 /*
34  * Tip Widget
35  */
36 
37 #include <X11/Xaw/Simple.h>
38 
39 /* Resources:
40 
41   Name		    Class		RepType		Default Value
42   ----		    -----		-------		-------------
43   background	    Background		Pixel		XtDefaultBackground
44   backgroundPixmap  BackgroundPixmap	Pixmap		XtUnspecifiedPixmap
45   border	    BorderColor		Pixel		XtDefaultForeground
46   borderWidth	    BorderWidth		Dimension	1
47   bottomMargin	    VerticalMargins	Dimension	2
48   destroyCallback   Callback		XtCallbackList	NULL
49   displayList	    DisplayList		XawDisplayList*	NULL
50   font		    Font		XFontStruct*	XtDefaultFont
51   foreground	    Foreground		Pixel		XtDefaultForeground
52   height	    Height		Dimension	text height
53   leftMargin	    HorizontalMargins	Dimension	6
54   rightMargin	    HorizontalMargins	Dimension	6
55   timeout	    Timeout		Int		500
56   topMargin	    VerticalMargins	Dimension	2
57   width		    Width		Dimension	text width
58   x		    Position		Position	0
59   y		    Position		Position	0
60 
61 */
62 
63 typedef struct _TipClassRec *TipWidgetClass;
64 typedef struct _TipRec *TipWidget;
65 
66 extern WidgetClass tipWidgetClass;
67 
68 #define XtNbottomMargin		"bottomMargin"
69 #define XawNdisplayList		"displayList"
70 #define XtNencoding		"encoding"
71 #define XtNleftMargin		"leftMargin"
72 #define XtNrightMargin		"rightMargin"
73 #define XtNtimeout		"timeout"
74 #define XtNtopMargin		"topMargin"
75 #define XtNtip			"tip"
76 
77 #define XawCDisplayList		"DisplayList"
78 #define XtCHorizontalMargins	"HorizontalMargins"
79 #define XtCTimeout		"Timeout"
80 #define XtCVerticalMargins	"VerticalMargins"
81 #define XtCTip			"Tip"
82 
83 #define XawRDisplayList		"XawDisplayList"
84 
85 /*
86  * Public Functions
87  */
88 /*
89  * Function:
90  *	XawTipEnable
91  *
92  * Parameters:
93  *	w - widget
94  *
95  * Description:
96  *	Enables the tip event handler for this widget.
97  */
98 void XawTipEnable
99 (
100  Widget		w
101  );
102 
103 /*
104  * Function:
105  *	XawTipEnable
106  *
107  * Parameters:
108  *	w - widget
109  *
110  * Description:
111  *	Disables the tip event handler for this widget.
112  */
113 void XawTipDisable
114 (
115  Widget		w
116  );
117 
118 #endif /* _XawTip_h */
119