1 /***********************************************************
3 Copyright 1987, 1988, 1994, 1998 The Open Group
5 Permission to use, copy, modify, distribute, and sell this software and its
6 documentation for any purpose is hereby granted without fee, provided that
7 the above copyright notice appear in all copies and that both that
8 copyright notice and this permission notice appear in supporting
11 The above copyright notice and this permission notice shall be included in
12 all copies or substantial portions of the Software.
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 THE
17 OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
18 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 Except as contained in this notice, the name of The Open Group shall not be
22 used in advertising or otherwise to promote the sale, use or other dealings
23 in this Software without prior written authorization from The Open Group.
26 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts.
30 Permission to use, copy, modify, and distribute this software and its
31 documentation for any purpose and without fee is hereby granted,
32 provided that the above copyright notice appear in all copies and that
33 both that copyright notice and this permission notice appear in
34 supporting documentation, and that the name of Digital not be
35 used in advertising or publicity pertaining to distribution of the
36 software without specific, written prior permission.
38 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
39 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
40 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
41 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
42 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
43 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
46 ******************************************************************/
51 #include <X11/IntrinsicP.h>
52 #include <X11/StringDefs.h>
53 #include <X11/Xmu/Drawing.h>
54 #include <X11/Xaw/ScrollbarP.h>
55 #include <X11/Xaw/XawInit.h>
59 #define PICKLENGTH(widget, x, y) \
60 (((widget)->scrollbar.orientation == XtorientHorizontal) ? (x) : (y))
65 static void XawScrollbarClassInitialize(void);
66 static void XawScrollbarDestroy(Widget);
67 static void XawScrollbarInitialize(Widget, Widget, ArgList, Cardinal*_args);
68 static void XawScrollbarRealize(Widget, Mask*, XSetWindowAttributes*);
69 static void XawScrollbarRedisplay(Widget, XEvent*, Region);
70 static void XawScrollbarResize(Widget);
71 static Boolean XawScrollbarSetValues(Widget, Widget, Widget,
77 static Boolean CompareEvents(XEvent*, XEvent*);
78 static void CreateGC(Widget);
79 static float FloatInRange(float, float, float);
80 static float FractionLoc(ScrollbarWidget, int, int);
81 static void ExtractPosition(XEvent*, Position*, Position*);
82 static int InRange(int, int, int);
83 static void FillArea(ScrollbarWidget, int, int, int);
84 static Bool LookAhead(Widget, XEvent*);
85 static void PaintThumb(ScrollbarWidget);
86 static Bool PeekNotifyEvent(Display*, XEvent*, char*);
87 static void SetDimensions(ScrollbarWidget);
92 static void EndScroll(Widget, XEvent*, String*, Cardinal*);
93 static void MoveThumb(Widget, XEvent*, String*, Cardinal*);
94 static void NotifyScroll(Widget, XEvent*, String*, Cardinal*);
95 static void NotifyThumb(Widget, XEvent*, String*, Cardinal*);
96 static void StartScroll(Widget, XEvent*, String*, Cardinal*);
101 static char defaultTranslations[] =
102 "<Btn1Down>:" "StartScroll(Forward)\n"
103 "<Btn2Down>:" "StartScroll(Continuous) MoveThumb() NotifyThumb()\n"
104 "<Btn3Down>:" "StartScroll(Backward)\n"
105 "<Btn2Motion>:" "MoveThumb() NotifyThumb()\n"
106 "<BtnUp>:" "NotifyScroll(Proportional) EndScroll()\n";
108 static float floatZero = 0.0;
110 #define Offset(field) XtOffsetOf(ScrollbarRec, field)
112 static XtResource resources[] = {
118 Offset(scrollbar.length),
127 Offset(scrollbar.thickness),
135 sizeof(XtOrientation),
136 Offset(scrollbar.orientation),
138 (XtPointer)XtorientVertical
145 Offset(scrollbar.scrollProc),
154 Offset(scrollbar.thumbProc),
163 Offset(scrollbar.jumpProc),
172 Offset(scrollbar.thumb),
174 (XtPointer)XtUnspecifiedPixmap
181 Offset(scrollbar.foreground),
190 Offset(scrollbar.shown),
192 (XtPointer)&floatZero
199 Offset(scrollbar.top),
201 (XtPointer)&floatZero
208 Offset(scrollbar.verCursor),
217 Offset(scrollbar.horCursor),
226 Offset(scrollbar.upCursor),
235 Offset(scrollbar.downCursor),
244 Offset(scrollbar.leftCursor),
253 Offset(scrollbar.rightCursor),
262 Offset(scrollbar.min_thumb),
269 static XtActionsRec actions[] = {
270 {"StartScroll", StartScroll},
271 {"MoveThumb", MoveThumb},
272 {"NotifyThumb", NotifyThumb},
273 {"NotifyScroll", NotifyScroll},
274 {"EndScroll", EndScroll},
277 #define Superclass (&simpleClassRec)
278 ScrollbarClassRec scrollbarClassRec = {
281 (WidgetClass)&simpleClassRec, /* superclass */
282 "Scrollbar", /* class_name */
283 sizeof(ScrollbarRec), /* widget_size */
284 XawScrollbarClassInitialize, /* class_initialize */
285 NULL, /* class_part_init */
286 False, /* class_inited */
287 XawScrollbarInitialize, /* initialize */
288 NULL, /* initialize_hook */
289 XawScrollbarRealize, /* realize */
290 actions, /* actions */
291 XtNumber(actions), /* num_actions */
292 resources, /* resources */
293 XtNumber(resources), /* num_resources */
294 NULLQUARK, /* xrm_class */
295 True, /* compress_motion */
296 True, /* compress_exposure */
297 True, /* compress_enterleave */
298 False, /* visible_interest */
299 XawScrollbarDestroy, /* destroy */
300 XawScrollbarResize, /* resize */
301 XawScrollbarRedisplay, /* expose */
302 XawScrollbarSetValues, /* set_values */
303 NULL, /* set_values_hook */
304 XtInheritSetValuesAlmost, /* set_values_almost */
305 NULL, /* get_values_hook */
306 NULL, /* accept_focus */
307 XtVersion, /* version */
308 NULL, /* callback_private */
309 defaultTranslations, /* tm_table */
310 XtInheritQueryGeometry, /* query_geometry */
311 XtInheritDisplayAccelerator, /* display_accelerator */
312 NULL, /* extension */
316 XtInheritChangeSensitive, /* change_sensitive */
320 NULL, /* extension */
324 WidgetClass scrollbarWidgetClass = (WidgetClass)&scrollbarClassRec;
330 XawScrollbarClassInitialize(void)
332 XawInitializeWidgetSet();
333 XtAddConverter(XtRString, XtROrientation, XmuCvtStringToOrientation,
335 XtSetTypeConverter(XtROrientation, XtRString, XmuCvtOrientationToString,
336 NULL, 0, XtCacheNone, NULL);
340 * Make sure the first number is within the range specified by the other
344 InRange(int num, int small, int big)
346 return ((num < small) ? small : ((num > big) ? big : num));
350 * Same as above, but for floating numbers
353 FloatInRange(float num, float small, float big)
355 return ((num < small) ? small : ((num > big) ? big : num));
358 /* Fill the area specified by top and bottom with the given pattern */
360 FractionLoc(ScrollbarWidget w, int x, int y)
364 result = PICKLENGTH(w, x / (float)XtWidth(w), y / (float)XtHeight(w));
366 return (FloatInRange(result, 0.0, 1.0));
370 FillArea(ScrollbarWidget w, int top, int bottom, int thumb)
374 top = XawMax(1, top);
375 if (w->scrollbar.orientation == XtorientHorizontal)
376 bottom = XawMin(bottom, XtWidth(w) - 1);
378 bottom = XawMin(bottom, XtHeight(w) - 1);
383 length = bottom - top;
386 /* Fill the new Thumb location */
388 if (w->scrollbar.orientation == XtorientHorizontal)
389 XFillRectangle(XtDisplay(w), XtWindow(w), w->scrollbar.gc,
390 top, 1, length, XtHeight(w) - 2);
392 XFillRectangle(XtDisplay(w), XtWindow(w), w->scrollbar.gc,
393 1, top, XtWidth(w) - 2, length);
395 /* Clear the old Thumb location */
397 if (w->scrollbar.orientation == XtorientHorizontal)
398 XClearArea(XtDisplay(w), XtWindow(w),
399 top, 1, length, XtHeight(w) - 2, False);
401 XClearArea(XtDisplay(w), XtWindow(w),
402 1, top, XtWidth(w) - 2, length, False);
408 /* Paint the thumb in the area specified by w->top and
409 w->shown. The old area is erased. The painting and
410 erasing is done cleverly so that no flickering will occur. */
412 PaintThumb(ScrollbarWidget w)
414 Position oldtop, oldbot, newtop, newbot;
416 oldtop = w->scrollbar.topLoc;
417 oldbot = oldtop + w->scrollbar.shownLength;
418 newtop = w->scrollbar.length * w->scrollbar.top;
419 newbot = newtop + (int)(w->scrollbar.length * w->scrollbar.shown);
420 if (newbot < newtop + (int)w->scrollbar.min_thumb)
421 newbot = newtop + w->scrollbar.min_thumb;
422 w->scrollbar.topLoc = newtop;
423 w->scrollbar.shownLength = newbot - newtop;
425 if (XtIsRealized((Widget)w)) {
427 FillArea(w, newtop, XawMin(newbot, oldtop), 1);
429 FillArea(w, oldtop, XawMin(newtop, oldbot), 0);
431 FillArea(w, XawMax(newbot, oldtop), oldbot, 0);
433 FillArea(w, XawMax(newtop, oldbot), newbot, 1);
438 SetDimensions(ScrollbarWidget w)
440 if (w->scrollbar.orientation == XtorientVertical) {
441 w->scrollbar.length = XtHeight(w);
442 w->scrollbar.thickness = XtWidth(w);
445 w->scrollbar.length = XtWidth(w);
446 w->scrollbar.thickness = XtHeight(w);
451 XawScrollbarDestroy(Widget w)
453 ScrollbarWidget sbw = (ScrollbarWidget)w;
455 XtReleaseGC(w, sbw->scrollbar.gc);
461 ScrollbarWidget sbw = (ScrollbarWidget)w;
464 unsigned int depth = 1;
466 if (sbw->scrollbar.thumb == XtUnspecifiedPixmap)
467 sbw->scrollbar.thumb = XmuCreateStippledPixmap(XtScreen(w),
470 else if (sbw->scrollbar.thumb != None) {
473 unsigned int width, height, bw;
475 XGetGeometry(XtDisplay(w), sbw->scrollbar.thumb, &root, &x, &y,
476 &width, &height, &bw, &depth);
479 gcValues.foreground = sbw->scrollbar.foreground;
480 gcValues.background = sbw->core.background_pixel;
481 mask = GCForeground | GCBackground;
483 if (sbw->scrollbar.thumb != None) {
485 gcValues.fill_style = FillOpaqueStippled;
486 gcValues.stipple = sbw->scrollbar.thumb;
487 mask |= GCFillStyle | GCStipple;
490 gcValues.fill_style = FillTiled;
491 gcValues.tile = sbw->scrollbar.thumb;
492 mask |= GCFillStyle | GCTile;
495 sbw->scrollbar.gc = XtGetGC(w, mask, &gcValues);
500 XawScrollbarInitialize(Widget request, Widget cnew,
501 ArgList args, Cardinal *num_args)
503 ScrollbarWidget w = (ScrollbarWidget)cnew;
508 XtWidth(w) = w->scrollbar.orientation == XtorientVertical ?
509 w->scrollbar.thickness : w->scrollbar.length;
511 if (XtHeight(w) == 0)
512 XtHeight(w) = w->scrollbar.orientation == XtorientHorizontal ?
513 w->scrollbar.thickness : w->scrollbar.length;
516 w->scrollbar.direction = 0;
517 w->scrollbar.topLoc = 0;
518 w->scrollbar.shownLength = w->scrollbar.min_thumb;
522 XawScrollbarRealize(Widget gw, Mask *valueMask,
523 XSetWindowAttributes *attributes)
525 ScrollbarWidget w = (ScrollbarWidget)gw;
527 w->scrollbar.inactiveCursor = w->scrollbar.orientation == XtorientVertical ?
528 w->scrollbar.verCursor : w->scrollbar.horCursor;
530 XtVaSetValues(gw, XtNcursor, w->scrollbar.inactiveCursor, NULL);
533 * The Simple widget actually stuffs the value in the valuemask
535 (*scrollbarWidgetClass->core_class.superclass->core_class.realize)
536 (gw, valueMask, attributes);
541 XawScrollbarSetValues(Widget current, Widget request, Widget desired,
542 ArgList args, Cardinal *num_args)
544 ScrollbarWidget w = (ScrollbarWidget)current;
545 ScrollbarWidget dw = (ScrollbarWidget)desired;
546 Boolean redraw = False;
549 * If these values are outside the acceptable range ignore them...
551 if (dw->scrollbar.top < 0.0 || dw->scrollbar.top > 1.0)
552 dw->scrollbar.top = w->scrollbar.top;
554 if (dw->scrollbar.shown < 0.0 || dw->scrollbar.shown > 1.0)
555 dw->scrollbar.shown = w->scrollbar.shown;
557 if (XtIsRealized (desired)) {
558 if (w->scrollbar.foreground != dw->scrollbar.foreground ||
559 w->core.background_pixel != dw->core.background_pixel ||
560 w->scrollbar.thumb != dw->scrollbar.thumb) {
561 XtReleaseGC((Widget)dw, w->scrollbar.gc);
562 CreateGC((Widget)dw);
565 if (w->scrollbar.top != dw->scrollbar.top ||
566 w->scrollbar.shown != dw->scrollbar.shown)
574 XawScrollbarResize(Widget gw)
576 /* ForgetGravity has taken care of background, but thumb may
577 * have to move as a result of the new size. */
578 SetDimensions((ScrollbarWidget)gw);
579 XawScrollbarRedisplay(gw, NULL, NULL);
584 XawScrollbarRedisplay(Widget gw, XEvent *event, Region region)
586 ScrollbarWidget w = (ScrollbarWidget)gw;
588 unsigned int width, height;
590 if (Superclass->core_class.expose)
591 (*Superclass->core_class.expose)(gw, event, region);
593 if (w->scrollbar.orientation == XtorientHorizontal) {
594 x = w->scrollbar.topLoc;
596 width = w->scrollbar.shownLength;
597 height = XtHeight(w) - 2;
601 y = w->scrollbar.topLoc;
602 width = XtWidth(w) - 2;
603 height = w->scrollbar.shownLength;
606 if (region == NULL ||
607 XRectInRegion(region, x, y, width, height) != RectangleOut) {
608 /* Forces entire thumb to be painted */
609 w->scrollbar.topLoc = -(w->scrollbar.length + 1);
616 StartScroll(Widget gw, XEvent *event, String *params, Cardinal *num_params)
618 ScrollbarWidget w = (ScrollbarWidget)gw;
622 if (w->scrollbar.direction != 0) /* if we're already scrolling */
625 direction = *params[0];
629 w->scrollbar.direction = direction;
634 cursor = w->scrollbar.orientation == XtorientVertical ?
635 w->scrollbar.downCursor : w->scrollbar.rightCursor;
639 cursor = w->scrollbar.orientation == XtorientVertical ?
640 w->scrollbar.upCursor : w->scrollbar.leftCursor;
644 cursor = w->scrollbar.orientation == XtorientVertical ?
645 w->scrollbar.rightCursor : w->scrollbar.upCursor;
648 return; /* invalid invocation */
651 XtVaSetValues(gw, XtNcursor, cursor, NULL);
653 XFlush(XtDisplay(w));
657 CompareEvents(XEvent *oldEvent, XEvent *newEvent)
659 #define Check(field) if (newEvent->field != oldEvent->field) return (False)
665 switch(newEvent->type) {
667 Check(xmotion.state);
671 Check(xbutton.state);
672 Check(xbutton.button);
681 Check(xcrossing.mode);
682 Check(xcrossing.detail);
683 Check(xcrossing.state);
697 PeekNotifyEvent(Display *dpy, XEvent *event, char *args)
699 struct EventData *eventData = (struct EventData*)args;
701 return (++eventData->count == QLength(dpy) /* since PeekIf blocks */
702 || CompareEvents(event, eventData->oldEvent));
706 LookAhead(Widget w, XEvent *event)
709 struct EventData eventData;
711 if (QLength(XtDisplay(w)) == 0)
715 eventData.oldEvent = event;
717 XPeekIfEvent(XtDisplay(w), &newEvent, PeekNotifyEvent, (char*)&eventData);
719 if (CompareEvents(event, &newEvent))
726 ExtractPosition(XEvent *event, Position *x, Position *y)
728 switch(event->type) {
730 *x = event->xmotion.x;
731 *y = event->xmotion.y;
735 *x = event->xbutton.x;
736 *y = event->xbutton.y;
745 *x = event->xcrossing.x;
746 *y = event->xcrossing.y;
756 NotifyScroll(Widget gw, XEvent *event, String *params, Cardinal *num_params)
758 ScrollbarWidget w = (ScrollbarWidget)gw;
763 if (w->scrollbar.direction == 0) /* if no StartScroll */
766 if (LookAhead(gw, event))
775 case 'P': /* Proportional */
777 ExtractPosition(event, &x, &y);
778 call_data = InRange(PICKLENGTH(w, x, y), 0, (int)w->scrollbar.length);
780 case 'F': /* FullLength */
782 call_data = w->scrollbar.length;
786 switch(w->scrollbar.direction) {
789 call_data = -call_data;
793 XtCallCallbacks(gw, XtNscrollProc, (XtPointer)call_data);
796 case 'c': /* NotifyThumb has already called the thumbProc(s) */
803 EndScroll(Widget gw, XEvent *event, String *params, Cardinal *num_params)
805 ScrollbarWidget w = (ScrollbarWidget)gw;
807 XtVaSetValues(gw, XtNcursor, w->scrollbar.inactiveCursor, NULL);
808 XFlush(XtDisplay(w)); /* make sure it get propogated */
810 w->scrollbar.direction = 0;
815 MoveThumb(Widget gw, XEvent *event, String *params, Cardinal *num_params)
817 ScrollbarWidget w = (ScrollbarWidget)gw;
820 if (w->scrollbar.direction == 0) /* if no StartScroll */
823 if (LookAhead(gw, event))
826 if (!event->xmotion.same_screen)
829 ExtractPosition(event, &x, &y);
830 w->scrollbar.top = FractionLoc(w, x, y);
835 NotifyThumb(Widget gw, XEvent *event, String *params, Cardinal *num_params)
837 ScrollbarWidget w = (ScrollbarWidget)gw;
843 if (w->scrollbar.direction == 0) /* if no StartScroll */
846 if (LookAhead(gw, event))
849 /* thumbProc is not pretty, but is necessary for backwards
850 compatibility on those architectures for which it work{s,ed};
851 the intent is to pass a (truncated) float by value. */
852 xtpf.xtf = w->scrollbar.top;
853 XtCallCallbacks(gw, XtNthumbProc, xtpf.xtp);
854 XtCallCallbacks(gw, XtNjumpProc, (XtPointer)&w->scrollbar.top);
862 /* Set the scroll bar to the given location. */
864 XawScrollbarSetThumb(Widget gw,
865 #if NeedWidePrototypes
866 double top, double shown
868 float top, float shown
872 ScrollbarWidget w = (ScrollbarWidget)gw;
874 if (w->scrollbar.direction == 'c') /* if still thumbing */
877 w->scrollbar.top = top > 1.0 ? 1.0 : top >= 0.0 ? top : w->scrollbar.top;
879 w->scrollbar.shown = shown > 1.0 ? 1.0 : shown >= 0.0 ?
880 shown : w->scrollbar.shown;