components/x11/libXaw4/src/Xaw3_1Command.c

   1 #ifndef lint
   2 static char Xrcsid[] = "$XConsortium: Command.c,v 1.70 89/12/12 20:17:23 swick Exp $";
   3 #endif /* lint */
   4
   5 /***********************************************************
   6 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
   7 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
   8
   9                         All Rights Reserved
  10
  11 Permission to use, copy, modify, and distribute this software and its
  12 documentation for any purpose and without fee is hereby granted,
  13 provided that the above copyright notice appear in all copies and that
  14 both that copyright notice and this permission notice appear in
  15 supporting documentation, and that the names of Digital or MIT not be
  16 used in advertising or publicity pertaining to distribution of the
  17 software without specific, written prior permission.
  18
  19 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  20 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  21 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  22 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  23 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  24 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  25 SOFTWARE.
  26
  27 ******************************************************************/
  28
  29
  30 /*
  31  * Command.c - Command button widget
  32  *
  33  */
  34
  35 #include <stdio.h>
  36
  37 #include <X11/IntrinsicP.h>
  38 #include <X11/StringDefs.h>
  39
  40 #include <X11/Xmu/Misc.h>
  41
  42 #include <./Xaw3_1XawInit.h>
  43 #include <./Xaw3_1CommandP.h>
  44
  45 #ifdef SHAPE
  46 #include <X11/Xmu/Converters.h>
  47 #endif
  48
  49 #define DEFAULT_HIGHLIGHT_THICKNESS 2
  50
  51 #ifdef SHAPE
  52 #    define DEFAULT_SHAPE_HIGHLIGHT 32767
  53 #endif
  54
  55 /****************************************************************
  56  *
  57  * Full class record constant
  58  *
  59  ****************************************************************/
  60
  61 /* Private Data */
  62
  63 static char defaultTranslations[] =
  64     "<EnterWindow>:     highlight()             \n\
  65      <LeaveWindow>:     reset()                 \n\
  66      <Btn1Down>:        set()                   \n\
  67      <Btn1Up>:          notify() unset()        ";
  68
  69 #define offset(field) XtOffset(CommandWidget, field)
  70 static XtResource resources[] = {
  71
  72    {XtNcallback, XtCCallback, XtRCallback, sizeof(XtPointer),
  73       offset(command.callbacks), XtRCallback, (XtPointer)NULL},
  74    {XtNhighlightThickness, XtCThickness, XtRDimension, sizeof(Dimension),
  75 #ifndef SHAPE
  76       offset(command.highlight_thickness), XtRImmediate,
  77       (XtPointer)DEFAULT_HIGHLIGHT_THICKNESS },
  78 #else
  79       offset(command.highlight_thickness), XtRImmediate,
  80       (XtPointer) DEFAULT_SHAPE_HIGHLIGHT},
  81
  82    {XtNshapeStyle, XtCShapeStyle, XtRShapeStyle, sizeof(int),
  83       offset(command.shape_style), XtRImmediate, (XtPointer)XawShapeRectangle},
  84    {XtNcornerRoundPercent, XtCCornerRoundPercent,
  85         XtRDimension, sizeof(Dimension),
  86         offset(command.corner_round), XtRImmediate, (XtPointer) 25},
  87 #endif /*SHAPE*/
  88 };
  89 #undef offset
  90
  91 static Boolean SetValues();
  92 static void Initialize(), Redisplay(), Set(), Reset(), Notify(), Unset();
  93 static void Highlight(), Unhighlight(), Destroy(), PaintCommandWidget();
  94 static void ClassInitialize();
  95
  96 #ifdef SHAPE
  97 static Boolean ShapeButton();
  98 static void Realize(), Resize();
  99 #endif /* SHAPE */
 100
 101 static XtActionsRec actionsList[] =
 102 {
 103   {"set",               Set},
 104   {"notify",            Notify},
 105   {"highlight",         Highlight},
 106   {"reset",             Reset},
 107   {"unset",             Unset},
 108   {"unhighlight",       Unhighlight},
 109 };
 110
 111 /*
 112  * This is a temporary exported actions list for the command
 113  * widget I have added this code because there is a bug in the MIT
 114  * Xtk Intrinsics implementation that does not allow the action table
 115  * to be retreived from the widget class, Ralph Swick has promised me that
 116  * this will eventually be fixed, but until then this is how the toggle
 117  * widget will get the command widget's actions list.
 118  *
 119  * Chris D. Peterson - 12/28/88.
 120  */
 121
 122 XtActionList xaw_command_actions_list = actionsList;
 123
 124 #define SuperClass ((LabelWidgetClass)&labelClassRec)
 125
 126 CommandClassRec commandClassRec = {
 127   {
 128     (WidgetClass) SuperClass,           /* superclass             */
 129     "Command",                          /* class_name             */
 130     sizeof(CommandRec),                 /* size                   */
 131     ClassInitialize,                    /* class_initialize       */
 132     NULL,                               /* class_part_initialize  */
 133     FALSE,                              /* class_inited           */
 134     Initialize,                         /* initialize             */
 135     NULL,                               /* initialize_hook        */
 136 #ifdef SHAPE
 137     Realize,                            /* realize                */
 138 #else
 139     XtInheritRealize,                   /* realize                */
 140 #endif /*SHAPE*/
 141     actionsList,                        /* actions                */
 142     XtNumber(actionsList),              /* num_actions            */
 143     resources,                          /* resources              */
 144     XtNumber(resources),                /* resource_count         */
 145     NULLQUARK,                          /* xrm_class              */
 146     FALSE,                              /* compress_motion        */
 147     TRUE,                               /* compress_exposure      */
 148     TRUE,                               /* compress_enterleave    */
 149     FALSE,                              /* visible_interest       */
 150     Destroy,                            /* destroy                */
 151 #ifdef SHAPE
 152     Resize,                             /* resize                 */
 153 #else
 154     XtInheritResize,                    /* resize                 */
 155 #endif /* SHAPE */
 156     Redisplay,                          /* expose                 */
 157     SetValues,                          /* set_values             */
 158     NULL,                               /* set_values_hook        */
 159     XtInheritSetValuesAlmost,           /* set_values_almost      */
 160     NULL,                               /* get_values_hook        */
 161     NULL,                               /* accept_focus           */
 162     XtVersion,                          /* version                */
 163     NULL,                               /* callback_private       */
 164     defaultTranslations,                /* tm_table               */
 165     XtInheritQueryGeometry,             /* query_geometry         */
 166     XtInheritDisplayAccelerator,        /* display_accelerator    */
 167     NULL                                /* extension              */
 168   },  /* CoreClass fields initialization */
 169   {
 170     XtInheritChangeSensitive            /* change_sensitive     */
 171   },  /* SimpleClass fields initialization */
 172   {
 173     0,                                     /* field not used    */
 174   },  /* LabelClass fields initialization */
 175   {
 176     0,                                     /* field not used    */
 177   },  /* CommandClass fields initialization */
 178 };
 179
 180   /* for public consumption */
 181 WidgetClass commandWidgetClass = (WidgetClass) &commandClassRec;
 182
 183 /****************************************************************
 184  *
 185  * Private Procedures
 186  *
 187  ****************************************************************/
 188
 189 static GC
 190 Get_GC(cbw, fg, bg)
 191 CommandWidget cbw;
 192 Pixel fg, bg;
 193 {
 194   XGCValues     values;
 195
 196   values.foreground   = fg;
 197   values.background     = bg;
 198   values.font           = cbw->label.font->fid;
 199   values.cap_style = CapProjecting;
 200
 201   if (cbw->command.highlight_thickness > 1 )
 202     values.line_width   = cbw->command.highlight_thickness;
 203   else
 204     values.line_width   = 0;
 205
 206   return XtGetGC((Widget)cbw,
 207                  (GCForeground|GCBackground|GCFont|GCLineWidth|GCCapStyle),
 208                  &values);
 209 }
 210
 211
 212 /* ARGSUSED */
 213 static void
 214 Initialize(request, new, args, num_args)
 215 Widget request, new;
 216 ArgList args;                   /* unused */
 217 Cardinal *num_args;             /* unused */
 218 {
 219   CommandWidget cbw = (CommandWidget) new;
 220 #ifdef SHAPE
 221   int shape_event_base, shape_error_base;
 222
 223   if (cbw->command.shape_style != XawShapeRectangle
 224       && !XShapeQueryExtension(XtDisplay(new), &shape_event_base,
 225                                &shape_error_base))
 226       cbw->command.shape_style = XawShapeRectangle;
 227   if (cbw->command.highlight_thickness == DEFAULT_SHAPE_HIGHLIGHT) {
 228       if (cbw->command.shape_style != XawShapeRectangle)
 229           cbw->command.highlight_thickness = 0;
 230       else
 231           cbw->command.highlight_thickness = DEFAULT_HIGHLIGHT_THICKNESS;
 232   }
 233 #endif /*SHAPE*/
 234
 235   cbw->command.normal_GC = Get_GC(cbw, cbw->label.foreground,
 236                                   cbw->core.background_pixel);
 237   cbw->command.inverse_GC = Get_GC(cbw, cbw->core.background_pixel,
 238                                    cbw->label.foreground);
 239   XtReleaseGC(new, cbw->label.normal_GC);
 240   cbw->label.normal_GC = cbw->command.normal_GC;
 241
 242   cbw->command.set = FALSE;
 243   cbw->command.highlighted = HighlightNone;
 244 }
 245
 246 static Region
 247 HighlightRegion(cbw)
 248 CommandWidget cbw;
 249 {
 250   static Region outerRegion = NULL, innerRegion, emptyRegion;
 251   XRectangle rect;
 252
 253   if (cbw->command.highlight_thickness == 0 ||
 254       cbw->command.highlight_thickness > Min(cbw->core.width,
 255                                              cbw->core.height)/2)
 256     return(NULL);
 257
 258   if (outerRegion == NULL) {
 259     /* save time by allocating scratch regions only once. */
 260     outerRegion = XCreateRegion();
 261     innerRegion = XCreateRegion();
 262     emptyRegion = XCreateRegion();
 263   }
 264
 265   rect.x = rect.y = 0;
 266   rect.width = cbw->core.width;
 267   rect.height = cbw->core.height;
 268   XUnionRectWithRegion( &rect, emptyRegion, outerRegion );
 269   rect.x = rect.y = cbw->command.highlight_thickness;
 270   rect.width -= cbw->command.highlight_thickness * 2;
 271   rect.height -= cbw->command.highlight_thickness * 2;
 272   XUnionRectWithRegion( &rect, emptyRegion, innerRegion );
 273   XSubtractRegion( outerRegion, innerRegion, outerRegion );
 274   return outerRegion;
 275 }
 276
 277 /***************************
 278 *
 279 *  Action Procedures
 280 *
 281 ***************************/
 282
 283 /* ARGSUSED */
 284 static void
 285 Set(w,event,params,num_params)
 286 Widget w;
 287 XEvent *event;
 288 String *params;         /* unused */
 289 Cardinal *num_params;   /* unused */
 290 {
 291   CommandWidget cbw = (CommandWidget)w;
 292
 293   if (cbw->command.set)
 294     return;
 295
 296   cbw->command.set= TRUE;
 297   if (XtIsRealized(w))
 298     PaintCommandWidget(w, (Region) NULL, TRUE);
 299 }
 300
 301 /* ARGSUSED */
 302 static void
 303 Unset(w,event,params,num_params)
 304 Widget w;
 305 XEvent *event;
 306 String *params;         /* unused */
 307 Cardinal *num_params;
 308 {
 309   CommandWidget cbw = (CommandWidget)w;
 310
 311   if (!cbw->command.set)
 312     return;
 313
 314   cbw->command.set = FALSE;
 315   if (XtIsRealized(w)) {
 316     XClearWindow(XtDisplay(w), XtWindow(w));
 317     PaintCommandWidget(w, (Region) NULL, TRUE);
 318   }
 319 }
 320
 321 /* ARGSUSED */
 322 static void
 323 Reset(w,event,params,num_params)
 324 Widget w;
 325 XEvent *event;
 326 String *params;         /* unused */
 327 Cardinal *num_params;   /* unused */
 328 {
 329   CommandWidget cbw = (CommandWidget)w;
 330
 331   if (cbw->command.set) {
 332     cbw->command.highlighted = HighlightNone;
 333     Unset(w, event, params, num_params);
 334   }
 335   else
 336     Unhighlight(w, event, params, num_params);
 337 }
 338
 339 /* ARGSUSED */
 340 static void
 341 Highlight(w,event,params,num_params)
 342 Widget w;
 343 XEvent *event;
 344 String *params;
 345 Cardinal *num_params;
 346 {
 347   CommandWidget cbw = (CommandWidget)w;
 348
 349   if ( *num_params == (Cardinal) 0)
 350     cbw->command.highlighted = HighlightWhenUnset;
 351   else {
 352     if ( *num_params != (Cardinal) 1)
 353       XtWarning("Too many parameters passed to highlight action table.");
 354     switch (params[0][0]) {
 355     case 'A':
 356     case 'a':
 357       cbw->command.highlighted = HighlightAlways;
 358       break;
 359     default:
 360       cbw->command.highlighted = HighlightWhenUnset;
 361       break;
 362     }
 363   }
 364
 365   if (XtIsRealized(w))
 366     PaintCommandWidget(w, HighlightRegion(cbw), TRUE);
 367 }
 368
 369 /* ARGSUSED */
 370 static void
 371 Unhighlight(w,event,params,num_params)
 372 Widget w;
 373 XEvent *event;
 374 String *params;         /* unused */
 375 Cardinal *num_params;   /* unused */
 376 {
 377   CommandWidget cbw = (CommandWidget)w;
 378
 379   cbw->command.highlighted = HighlightNone;
 380   if (XtIsRealized(w))
 381     PaintCommandWidget(w, HighlightRegion(cbw), TRUE);
 382 }
 383
 384 /* ARGSUSED */
 385 static void
 386 Notify(w,event,params,num_params)
 387 Widget w;
 388 XEvent *event;
 389 String *params;         /* unused */
 390 Cardinal *num_params;   /* unused */
 391 {
 392   CommandWidget cbw = (CommandWidget)w;
 393
 394   /* check to be sure state is still Set so that user can cancel
 395      the action (e.g. by moving outside the window, in the default
 396      bindings.
 397   */
 398   if (cbw->command.set)
 399     XtCallCallbackList(w, cbw->command.callbacks, NULL);
 400 }
 401
 402 /*
 403  * Repaint the widget window
 404  */
 405
 406 /************************
 407 *
 408 *  REDISPLAY (DRAW)
 409 *
 410 ************************/
 411
 412 /* ARGSUSED */
 413 static void
 414 Redisplay(w, event, region)
 415 Widget w;
 416 XEvent *event;
 417 Region region;
 418 {
 419   PaintCommandWidget(w, region, FALSE);
 420 }
 421
 422 /*      Function Name: PaintCommandWidget
 423  *      Description: Paints the command widget.
 424  *      Arguments: w - the command widget.
 425  *                 region - region to paint (passed to the superclass).
 426  *                 change - did it change either set or highlight state?
 427  *      Returns: none
 428  */
 429
 430 static void
 431 PaintCommandWidget(w, region, change)
 432 Widget w;
 433 Region region;
 434 Boolean change;
 435 {
 436   CommandWidget cbw = (CommandWidget) w;
 437   Boolean very_thick;
 438   GC norm_gc, rev_gc;
 439
 440   very_thick = cbw->command.highlight_thickness > Min(cbw->core.width,
 441                                                       cbw->core.height)/2;
 442
 443   if (cbw->command.set) {
 444     cbw->label.normal_GC = cbw->command.inverse_GC;
 445     XFillRectangle(XtDisplay(w), XtWindow(w), cbw->command.normal_GC,
 446                    0, 0, cbw->core.width, cbw->core.height);
 447     region = NULL;              /* Force label to repaint text. */
 448   }
 449   else
 450       cbw->label.normal_GC = cbw->command.normal_GC;
 451
 452   if (cbw->command.highlight_thickness <= 0)
 453   {
 454     (*SuperClass->core_class.expose) (w, (XEvent *) NULL, region);
 455     return;
 456   }
 457
 458 /*
 459  * If we are set then use the same colors as if we are not highlighted.
 460  */
 461
 462   if (cbw->command.set == (cbw->command.highlighted == HighlightNone)) {
 463     norm_gc = cbw->command.inverse_GC;
 464     rev_gc = cbw->command.normal_GC;
 465   }
 466   else {
 467     norm_gc = cbw->command.normal_GC;
 468     rev_gc = cbw->command.inverse_GC;
 469   }
 470
 471   if ( !( (!change && (cbw->command.highlighted == HighlightNone)) ||
 472           ((cbw->command.highlighted == HighlightWhenUnset) &&
 473            (cbw->command.set))) ) {
 474     if (very_thick) {
 475       cbw->label.normal_GC = norm_gc; /* Give the label the right GC. */
 476       XFillRectangle(XtDisplay(w),XtWindow(w), rev_gc,
 477                      0, 0, cbw->core.width, cbw->core.height);
 478     }
 479     else {
 480       /* wide lines are centered on the path, so indent it */
 481       int offset = cbw->command.highlight_thickness/2;
 482       XDrawRectangle(XtDisplay(w),XtWindow(w), rev_gc, offset, offset,
 483                      cbw->core.width - cbw->command.highlight_thickness,
 484                      cbw->core.height - cbw->command.highlight_thickness);
 485     }
 486   }
 487   (*SuperClass->core_class.expose) (w, (XEvent *) NULL, region);
 488 }
 489
 490 static void
 491 Destroy(w)
 492 Widget w;
 493 {
 494   CommandWidget cbw = (CommandWidget) w;
 495
 496   /* so Label can release it */
 497   if (cbw->label.normal_GC == cbw->command.normal_GC)
 498     XtReleaseGC( w, cbw->command.inverse_GC );
 499   else
 500     XtReleaseGC( w, cbw->command.normal_GC );
 501 }
 502
 503 /*
 504  * Set specified arguments into widget
 505  */
 506
 507 /* ARGSUSED */
 508 static Boolean
 509 SetValues (current, request, new)
 510 Widget current, request, new;
 511 {
 512   CommandWidget oldcbw = (CommandWidget) current;
 513   CommandWidget cbw = (CommandWidget) new;
 514   Boolean redisplay = False;
 515
 516   if ( oldcbw->core.sensitive != cbw->core.sensitive && !cbw->core.sensitive) {
 517     /* about to become insensitive */
 518     cbw->command.set = FALSE;
 519     cbw->command.highlighted = HighlightNone;
 520     redisplay = TRUE;
 521   }
 522
 523   if ( (oldcbw->label.foreground != cbw->label.foreground)           ||
 524        (oldcbw->core.background_pixel != cbw->core.background_pixel) ||
 525        (oldcbw->command.highlight_thickness !=
 526                                    cbw->command.highlight_thickness) ||
 527        (oldcbw->label.font != cbw->label.font) )
 528   {
 529     if (oldcbw->label.normal_GC == oldcbw->command.normal_GC)
 530         /* Label has release one of these */
 531       XtReleaseGC(new, cbw->command.inverse_GC);
 532     else
 533       XtReleaseGC(new, cbw->command.normal_GC);
 534
 535     cbw->command.normal_GC = Get_GC(cbw, cbw->label.foreground,
 536                                     cbw->core.background_pixel);
 537     cbw->command.inverse_GC = Get_GC(cbw, cbw->core.background_pixel,
 538                                      cbw->label.foreground);
 539     XtReleaseGC(new, cbw->label.normal_GC);
 540     cbw->label.normal_GC = (cbw->command.set
 541                             ? cbw->command.inverse_GC
 542                             : cbw->command.normal_GC);
 543
 544     redisplay = True;
 545   }
 546
 547 #ifdef SHAPE
 548   if ( XtIsRealized(new)
 549        && oldcbw->command.shape_style != cbw->command.shape_style
 550        && !ShapeButton(cbw))
 551   {
 552       cbw->command.shape_style = oldcbw->command.shape_style;
 553   }
 554 #endif /*SHAPE*/
 555
 556   return (redisplay);
 557 }
 558
 559 static void ClassInitialize()
 560 {
 561     XawInitializeWidgetSet();
 562 #ifdef SHAPE
 563     XtSetTypeConverter( XtRString, XtRShapeStyle, XmuCvtStringToShapeStyle,
 564                         NULL, 0, XtCacheNone, NULL );
 565 #endif
 566 }
 567
 568
 569
 570 #ifdef SHAPE
 571
 572 static Boolean
 573 ShapeButton(cbw)
 574 CommandWidget cbw;
 575 {
 576     Dimension corner_size;
 577
 578     if ( (cbw->command.shape_style == XawShapeRoundedRectangle) ) {
 579         corner_size = (cbw->core.width < cbw->core.height) ? cbw->core.width
 580                                                            : cbw->core.height;
 581         corner_size = (corner_size * cbw->command.corner_round) / 100;
 582     }
 583
 584     if (cbw->command.shape_style != XawShapeRectangle) {
 585         if (!XmuReshapeWidget((Widget) cbw, cbw->command.shape_style,
 586                               corner_size, corner_size)) {
 587             cbw->command.shape_style = XawShapeRectangle;
 588             return(False);
 589         }
 590     }
 591     return(TRUE);
 592 }
 593
 594 static void Realize(w, valueMask, attributes)
 595     Widget w;
 596     Mask *valueMask;
 597     XSetWindowAttributes *attributes;
 598 {
 599     (*commandWidgetClass->core_class.superclass->core_class.realize)
 600         (w, valueMask, attributes);
 601
 602     ShapeButton( (CommandWidget) w);
 603 }
 604
 605 static void Resize(w)
 606     Widget w;
 607 {
 608     if (XtIsRealized(w))
 609         ShapeButton( (CommandWidget) w);
 610
 611     (*commandWidgetClass->core_class.superclass->core_class.resize)(w);
 612 }
 613 #endif /*SHAPE*/