annotate lwlib/xlwgauge.h @ 2608:f45ce138f2ad

[xemacs-hg @ 2005-02-23 15:33:32 by stephent] document \c <87650jz411.fsf@tleepslib.sk.tsukuba.ac.jp>
author stephent
date Wed, 23 Feb 2005 15:33:38 +0000
parents abe6d1db359e
children 16b17fd1dc93
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
424
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
1 /* Gauge Widget for XEmacs.
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
2 Copyright (C) 1999 Edward A. Falk
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
3
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
4 This file is part of XEmacs.
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
5
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
6 XEmacs is free software; you can redistribute it and/or modify it
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
7 under the terms of the GNU General Public License as published by the
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
8 Free Software Foundation; either version 2, or (at your option) any
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
9 later version.
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
10
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
14 for more details.
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
15
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
17 along with XEmacs; see the file COPYING. If not, write to
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
19 Boston, MA 02111-1307, USA. */
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
20
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
21 /* Synched up with: Gauge.h 1.1 */
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
22
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
23 /*
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
24 * Gauge.h - Gauge widget
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
25 *
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
26 * Author: Edward A. Falk
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
27 * falk@falconer.vip.best.com
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 434
diff changeset
28 *
424
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
29 * Date: July 8, 1997
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
30 */
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
31
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
32 #ifndef _XawGauge_h
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
33 #define _XawGauge_h
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
34
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
35 /***********************************************************************
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
36 *
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
37 * Gauge Widget
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
38 *
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
39 * The Gauge widget looks something like a thermometer. Application
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
40 * defines the values at the ends of the range and the current value
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
41 * and Gauge draws accordingly. Gauge does not accept input.
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
42 *
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
43 ***********************************************************************/
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
44
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 434
diff changeset
45 #include ATHENA_Label_h_
424
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
46
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
47 /* Resources:
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
48
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
49 Name Class RepType Default Value
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
50 ---- ----- ------- -------------
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
51 value Value Cardinal 0
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
52 minValue MinValue Cardinal 0
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
53 maxValue MaxValue Cardinal 100
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
54 ntics NTics Cardinal 0 +
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
55 nlabels NLabels Cardinal 0 ++
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
56 labels Labels String * NULL +++
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
57 orientation Orientation XtOrientation horizontal
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
58 autoScaleUp AutoScaleUp Boolean FALSE ++++
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
59 autoScaleDown AutoScaleDown Boolean FALSE ++++
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
60 getValue Callback XtCallbackList NULL +++++
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
61 update Interval int 0 (seconds) = disabled
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
62
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
63 encoding Encoding unsigned char XawTextEncoding8bit
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
64 font Font XFontStruct* XtDefaultFont
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
65 foreground Foreground Pixel XtDefaultForeground
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
66 internalHeight Height Dimension 2
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
67 internalWidth Width Dimension 4
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
68 resize Resize Boolean True
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
69 background Background Pixel XtDefaultBackground
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
70 bitmap Pixmap Pixmap None
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
71 border BorderColor Pixel XtDefaultForeground
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
72 borderWidth BorderWidth Dimension 1
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
73 cursor Cursor Cursor None
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
74 cursorName Cursor String NULL
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
75 destroyCallback Callback XtCallbackList NULL
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
76 height Height Dimension varies
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
77 insensitiveBorder Insensitive Pixmap Gray
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
78 mappedWhenManaged MappedWhenManaged Boolean True
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
79 pointerColor Foreground Pixel XtDefaultForeground
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
80 pointerColorBackground Background Pixel XtDefaultBackground
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
81 sensitive Sensitive Boolean True
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
82 width Width Dimension text width
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
83 x Position Position 0
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
84 y Position Position 0
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
85
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
86 + Ntics sets the number of tic marks next to the gauge. If 0, no
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
87 tic marks will be drawn.
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
88 ++ Nlabels sets the number of labels next to the gauge.
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
89 +++ Labels is an array of nul-terminated strings to be used as labels.
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
90 If this field is NULL but nlabels is > 0, then numeric labels will be
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
91 provided. NOTE: the labels are not copied to any internal memory; they
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 434
diff changeset
92 must be stored in static memory provided by the application.
424
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
93 ++++ AutoScale allows the gauge to set its own value limits. Default is
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
94 False unless upper & lower limits are both 0.
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
95
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
96 +++++ The GetValue() callback proc is called with these arguments:
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
97 static void
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
98 myGetValue(gauge, client, rval)
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
99 Widget gauge ;
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
100 XtPointer client ;
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
101 XtPointer rval ;
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
102 {
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
103 *(Cardinal *)rval = value ;
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
104 }
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 434
diff changeset
105
424
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
106 */
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
107
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
108 /*
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
109 * Resource names not provided in StringDefs.h
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
110 */
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
111
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
112 #ifndef XtNvalue
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
113 #define XtNvalue "value"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
114 #define XtCValue "Value"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
115 #endif
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
116
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
117 #ifndef XtNorientation
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
118 #define XtNorientation "orientation"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
119 #define XtCOrientation "Orientation"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
120 #endif
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
121
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
122 #define XtNntics "ntics"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
123 #define XtCNTics "NTics"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
124
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
125 #ifndef XtNnlabels
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
126 #define XtNnlabels "nlabels"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
127 #define XtCNLabels "NLabels"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
128 #endif
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
129 #ifndef XtNlabels
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
130 #define XtNlabels "labels"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
131 #define XtCLabels "Labels"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
132 #endif
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
133
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
134 #ifndef XtNminValue
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
135 #define XtNminValue "minValue"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
136 #define XtCMinValue "MinValue"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
137 #endif
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
138 #ifndef XtNmaxValue
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
139 #define XtNmaxValue "maxValue"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
140 #define XtCMaxValue "MaxValue"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
141 #endif
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
142
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
143 #ifndef XtNautoScaleUp
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
144 #define XtNautoScaleUp "autoScaleUp"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
145 #define XtCAutoScaleUp "AutoScaleUp"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
146 #define XtNautoScaleDown "autoScaleDown"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
147 #define XtCAutoScaleDown "AutoScaleDown"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
148 #endif
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
149
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
150 #ifndef XtNupdate
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
151 #define XtNupdate "update"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
152 #endif
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
153
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
154 #ifndef XtNgetValue
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
155 #define XtNgetValue "getValue"
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
156 #endif
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
157
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
158
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
159 /* Class record constants */
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
160
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
161 extern WidgetClass gaugeWidgetClass;
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
162
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
163 typedef struct _GaugeClassRec *GaugeWidgetClass;
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
164 typedef struct _GaugeRec *GaugeWidget;
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
165
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
166
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
167 _XFUNCPROTOBEGIN
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
168
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
169 extern void XawGaugeSetValue(
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
170 #if NeedFunctionPrototypes
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
171 Widget gauge,
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
172 Cardinal value
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
173 #endif
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
174 );
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
175
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
176 extern Cardinal XawGaugeGetValue(
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
177 #if NeedFunctionPrototypes
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
178 Widget gauge
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
179 #endif
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
180 );
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
181
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
182 _XFUNCPROTOEND
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
183
11054d720c21 Import from CVS: tag r21-2-20
cvs
parents:
diff changeset
184 #endif /* _XawGauge_h */