src/motif/toolbar.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        motif/toolbar.cpp
   3 // Purpose:     wxToolBar
   4 // Author:      Julian Smart
   5 // Modified by: 13.12.99 by VZ during toolbar classes reorganization
   6 // Created:     04/01/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #ifdef __GNUG__
  21     #pragma implementation "toolbar.h"
  22 #endif
  23
  24 #include "wx/wx.h"
  25 #include "wx/app.h"
  26 #include "wx/timer.h"
  27 #include "wx/toolbar.h"
  28
  29 #ifdef __VMS__
  30 #pragma message disable nosimpint
  31 #endif
  32 #include <Xm/Xm.h>
  33 #include <Xm/PushBG.h>
  34 #include <Xm/PushB.h>
  35 #include <Xm/Label.h>
  36 #include <Xm/ToggleB.h>
  37 #include <Xm/ToggleBG.h>
  38 #include <Xm/Form.h>
  39 #ifdef __VMS__
  40 #pragma message enable nosimpint
  41 #endif
  42
  43 #include "wx/motif/private.h"
  44
  45 // ----------------------------------------------------------------------------
  46 // wxWin macros
  47 // ----------------------------------------------------------------------------
  48
  49 #if !USE_SHARED_LIBRARY
  50 IMPLEMENT_DYNAMIC_CLASS(wxToolBar, wxControl)
  51 #endif
  52
  53 // ----------------------------------------------------------------------------
  54 // private functions
  55 // ----------------------------------------------------------------------------
  56
  57 static void wxToolButtonCallback (Widget w, XtPointer clientData,
  58                     XtPointer ptr);
  59 static void wxToolButtonPopupCallback (Widget w, XtPointer client_data,
  60                      XEvent *event, Boolean *continue_to_dispatch);
  61
  62 // ----------------------------------------------------------------------------
  63 // private classes
  64 // ----------------------------------------------------------------------------
  65
  66 class wxToolBarTimer : public wxTimer
  67 {
  68 public:
  69     virtual void Notify();
  70
  71     static Widget help_popup;
  72     static Widget buttonWidget;
  73     static wxString helpString;
  74 };
  75
  76 class wxToolBarTool : public wxToolBarToolBase
  77 {
  78 public:
  79     wxToolBarTool(wxToolBar *tbar,
  80                   int id,
  81                   const wxBitmap& bitmap1,
  82                   const wxBitmap& bitmap2,
  83                   bool toggle,
  84                   wxObject *clientData,
  85                   const wxString& shortHelpString,
  86                   const wxString& longHelpString)
  87         : wxToolBarToolBase(tbar, id, bitmap1, bitmap2, toggle,
  88                             clientData, shortHelpString, longHelpString)
  89     {
  90         Init();
  91     }
  92
  93     wxToolBarTool(wxToolBar *tbar, wxControl *control)
  94         : wxToolBarToolBase(tbar, control)
  95     {
  96         Init();
  97     }
  98
  99     virtual ~wxToolBarTool();
 100
 101     // accessors
 102     void SetWidget(Widget widget) { m_widget = widget; }
 103     Widget GetButtonWidget() const { return m_widget; }
 104
 105     void SetPixmap(Pixmap pixmap) { m_pixmap = pixmap; }
 106     Pixmap GetPixmap() const { return m_pixmap; }
 107
 108 protected:
 109     void Init();
 110
 111     Widget m_widget;
 112     Pixmap m_pixmap;
 113 };
 114
 115 // ----------------------------------------------------------------------------
 116 // globals
 117 // ----------------------------------------------------------------------------
 118
 119 static wxToolBarTimer* wxTheToolBarTimer = (wxToolBarTimer*) NULL;
 120
 121 Widget wxToolBarTimer::help_popup = (Widget) 0;
 122 Widget wxToolBarTimer::buttonWidget = (Widget) 0;
 123 wxString wxToolBarTimer::helpString;
 124
 125 // ============================================================================
 126 // implementation
 127 // ============================================================================
 128
 129 // ----------------------------------------------------------------------------
 130 // wxToolBarTool
 131 // ----------------------------------------------------------------------------
 132
 133 wxToolBarToolBase *wxToolBar::CreateTool(int id,
 134                                          const wxBitmap& bitmap1,
 135                                          const wxBitmap& bitmap2,
 136                                          bool toggle,
 137                                          wxObject *clientData,
 138                                          const wxString& shortHelpString,
 139                                          const wxString& longHelpString)
 140 {
 141     return new wxToolBarTool(this, id, bitmap1, bitmap2, toggle,
 142                              clientData, shortHelpString, longHelpString);
 143 }
 144
 145 wxToolBarToolBase *wxToolBar::CreateTool(wxControl *control)
 146 {
 147     return new wxToolBarTool(this, control);
 148 }
 149
 150 void wxToolBarTool::Init()
 151 {
 152     m_widget = (Widget)0;
 153     m_pixmap = (Pixmap)0;
 154 }
 155
 156 wxToolBarTool::~wxToolBarTool()
 157 {
 158     if ( m_widget )
 159         XtDestroyWidget(m_widget);
 160     if ( m_pixmap )
 161         XmDestroyPixmap(DefaultScreenOfDisplay((Display*)wxGetDisplay()),
 162                         m_pixmap);
 163 }
 164
 165 // ----------------------------------------------------------------------------
 166 // wxToolBar construction
 167 // ----------------------------------------------------------------------------
 168
 169 void wxToolBar::Init()
 170 {
 171     m_maxWidth = -1;
 172     m_maxHeight = -1;
 173     m_defaultWidth = 24;
 174     m_defaultHeight = 22;
 175     m_toolPacking = 2;
 176     m_toolSeparation = 8;
 177     m_xMargin = 2;
 178     m_yMargin = 2;
 179     m_maxRows = 100;
 180     m_maxCols = 100;
 181 }
 182
 183 bool wxToolBar::Create(wxWindow *parent,
 184                        wxWindowID id,
 185                        const wxPoint& pos,
 186                        const wxSize& size,
 187                        long style,
 188                        const wxString& name)
 189 {
 190     Init();
 191
 192     m_windowId = id;
 193
 194     SetName(name);
 195     m_backgroundColour = wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE);
 196     m_foregroundColour = parent->GetForegroundColour();
 197     m_windowStyle = style;
 198
 199     SetParent(parent);
 200
 201     if (parent) parent->AddChild(this);
 202
 203     Widget parentWidget = (Widget) parent->GetClientWidget();
 204
 205     Widget toolbar = XtVaCreateManagedWidget("toolbar",
 206                     xmBulletinBoardWidgetClass, (Widget) parentWidget,
 207                     XmNmarginWidth, 0,
 208                     XmNmarginHeight, 0,
 209                     XmNresizePolicy, XmRESIZE_NONE,
 210                     NULL);
 211 /*
 212     Widget toolbar = XtVaCreateManagedWidget("toolbar",
 213                 xmFormWidgetClass, (Widget) m_clientWidget,
 214                 XmNtraversalOn, False,
 215                 XmNhorizontalSpacing, 0,
 216                 XmNverticalSpacing, 0,
 217                 XmNleftOffset, 0,
 218                 XmNrightOffset, 0,
 219                 XmNmarginWidth, 0,
 220                 XmNmarginHeight, 0,
 221                 NULL);
 222 */
 223
 224     m_mainWidget = (WXWidget) toolbar;
 225
 226     m_font = parent->GetFont();
 227     ChangeFont(FALSE);
 228
 229     SetCanAddEventHandler(TRUE);
 230     AttachWidget (parent, m_mainWidget, (WXWidget) NULL, pos.x, pos.y, size.x, size.y);
 231
 232     ChangeBackgroundColour();
 233
 234     return TRUE;
 235 }
 236
 237 wxToolBar::~wxToolBar()
 238 {
 239     delete wxTheToolBarTimer;
 240     wxTheToolBarTimer = NULL;
 241 }
 242
 243 bool wxToolBar::Realize()
 244 {
 245     if ( m_tools.GetCount() == 0 )
 246     {
 247         // nothing to do
 248         return TRUE;
 249     }
 250
 251     // Separator spacing
 252     const int separatorSize = GetToolSeparation(); // 8;
 253     wxSize margins = GetToolMargins();
 254     int marginX = margins.x;
 255     int marginY = margins.y;
 256
 257     int currentX = marginX;
 258     int currentY = marginY;
 259
 260     int buttonHeight = 0;
 261
 262     int currentSpacing = 0;
 263
 264     Widget button;
 265     Pixmap pixmap, insensPixmap;
 266     wxBitmap bmp;
 267
 268     wxToolBarToolsList::Node *node = m_tools.GetFirst();
 269     while ( node )
 270     {
 271         wxToolBarTool *tool = (wxToolBarTool *)node->GetData();
 272
 273         switch ( tool->GetStyle() )
 274         {
 275             case wxTOOL_STYLE_CONTROL:
 276                 wxFAIL_MSG( _T("not implemented") );
 277                 break;
 278
 279             case wxTOOL_STYLE_SEPARATOR:
 280                 currentX += separatorSize;
 281                 break;
 282
 283             case wxTOOL_STYLE_BUTTON:
 284                 button = (Widget) 0;
 285
 286                 if ( tool->CanBeToggled() )
 287                 {
 288                     button = XtVaCreateWidget("toggleButton",
 289                             xmToggleButtonWidgetClass, (Widget) m_mainWidget,
 290                             XmNx, currentX, XmNy, currentY,
 291                             XmNindicatorOn, False,
 292                             XmNshadowThickness, 2,
 293                             XmNborderWidth, 0,
 294                             XmNspacing, 0,
 295                             XmNmarginWidth, 0,
 296                             XmNmarginHeight, 0,
 297                             XmNmultiClick, XmMULTICLICK_KEEP,
 298                             XmNlabelType, XmPIXMAP,
 299                             NULL);
 300                     XtAddCallback ((Widget) button, XmNvalueChangedCallback, (XtCallbackProc) wxToolButtonCallback,
 301                             (XtPointer) this);
 302
 303                     XtVaSetValues ((Widget) button,
 304                             XmNselectColor, m_backgroundColour.AllocColour(XtDisplay((Widget) button)),
 305                             NULL);
 306                 }
 307                 else
 308                 {
 309                     button = XtVaCreateWidget("button",
 310                             xmPushButtonWidgetClass, (Widget) m_mainWidget,
 311                             XmNx, currentX, XmNy, currentY,
 312                             XmNpushButtonEnabled, True,
 313                             XmNmultiClick, XmMULTICLICK_KEEP,
 314                             XmNlabelType, XmPIXMAP,
 315                             NULL);
 316                     XtAddCallback (button,
 317                             XmNactivateCallback, (XtCallbackProc) wxToolButtonCallback,
 318                             (XtPointer) this);
 319                 }
 320
 321                 DoChangeBackgroundColour((WXWidget) button, m_backgroundColour, TRUE);
 322
 323                 tool->SetWidget(button);
 324
 325                 // For each button, if there is a mask, we must create
 326                 // a new wxBitmap that has the correct background colour
 327                 // for the button. Otherwise the background will just be
 328                 // e.g. black if a transparent XPM has been loaded.
 329                 bmp = tool->GetBitmap1();
 330                 if ( bmp.GetMask() )
 331                 {
 332                     int backgroundPixel;
 333                     XtVaGetValues(button, XmNbackground, &backgroundPixel,
 334                             NULL);
 335
 336                     wxColour col;
 337                     col.SetPixel(backgroundPixel);
 338
 339                     bmp = wxCreateMaskedBitmap(bmp, col);
 340
 341                     tool->SetBitmap1(bmp);
 342                 }
 343
 344                 // Create a selected/toggled bitmap. If there isn't a 2nd
 345                 // bitmap, we need to create it (with a darker, selected
 346                 // background)
 347                 int backgroundPixel;
 348                 if ( tool->CanBeToggled() )
 349                     XtVaGetValues(button, XmNselectColor, &backgroundPixel,
 350                             NULL);
 351                 else
 352                     XtVaGetValues(button, XmNarmColor, &backgroundPixel,
 353                             NULL);
 354
 355                 wxColour col;
 356                 col.SetPixel(backgroundPixel);
 357
 358                 if (tool->GetBitmap2().Ok() && tool->GetBitmap2().GetMask())
 359                 {
 360                     // Use what's there
 361                     wxBitmap newBitmap = wxCreateMaskedBitmap(tool->GetBitmap2(), col);
 362                     tool->SetBitmap2(newBitmap);
 363                 }
 364                 else
 365                 {
 366                     // Use unselected bitmap
 367                     if ( bmp.GetMask() )
 368                     {
 369                         wxBitmap newBitmap = wxCreateMaskedBitmap(bmp, col);
 370                         tool->SetBitmap2(newBitmap);
 371                     }
 372                     else
 373                         tool->SetBitmap2(bmp);
 374                 }
 375
 376                 pixmap = (Pixmap) bmp.GetPixmap();
 377                 insensPixmap = (Pixmap) bmp.GetInsensPixmap();
 378
 379                 if (tool->CanBeToggled())
 380                 {
 381                     // Toggle button
 382                     Pixmap pixmap2 = (Pixmap) 0;
 383                     Pixmap insensPixmap2 = (Pixmap) 0;
 384
 385                     // If there's a bitmap for the toggled state, use it,
 386                     // otherwise generate one.
 387                     if (tool->GetBitmap2().Ok())
 388                     {
 389                         wxBitmap bmp2 = tool->GetBitmap2();
 390                         pixmap2 = (Pixmap) bmp2.GetPixmap();
 391                         insensPixmap2 = (Pixmap) bmp2.GetInsensPixmap();
 392                     }
 393                     else
 394                     {
 395                         pixmap2 = (Pixmap) bmp.GetArmPixmap(button);
 396                         insensPixmap2 = XCreateInsensitivePixmap((Display*) wxGetDisplay(), pixmap2);
 397                     }
 398
 399                     tool->SetPixmap(pixmap2);
 400
 401                     XtVaSetValues (button,
 402                             XmNfillOnSelect, True,
 403                             XmNlabelPixmap, pixmap,
 404                             XmNselectPixmap, pixmap2,
 405                             XmNlabelInsensitivePixmap, insensPixmap,
 406                             XmNselectInsensitivePixmap, insensPixmap2,
 407                             XmNlabelType, XmPIXMAP,
 408                             NULL);
 409                 }
 410                 else
 411                 {
 412                     Pixmap pixmap2 = (Pixmap) 0;
 413
 414                     // If there's a bitmap for the armed state, use it,
 415                     // otherwise generate one.
 416                     if (tool->GetBitmap2().Ok())
 417                     {
 418                         pixmap2 = (Pixmap) tool->GetBitmap2().GetPixmap();
 419                     }
 420                     else
 421                     {
 422                         pixmap2 = (Pixmap) bmp.GetArmPixmap(button);
 423
 424                     }
 425
 426                     tool->SetPixmap(pixmap2);
 427
 428                     // Normal button
 429                     XtVaSetValues(button,
 430                             XmNlabelPixmap, pixmap,
 431                             XmNlabelInsensitivePixmap, insensPixmap,
 432                             XmNarmPixmap, pixmap2,
 433                             NULL);
 434                 }
 435
 436                 XtManageChild(button);
 437
 438                 {
 439                     Dimension width, height;
 440                     XtVaGetValues(button,
 441                                   XmNwidth, &width,
 442                                   XmNheight, & height,
 443                                   NULL);
 444                     currentX += width + marginX;
 445                     buttonHeight = wxMax(buttonHeight, height);
 446                 }
 447
 448                 XtAddEventHandler (button, EnterWindowMask | LeaveWindowMask,
 449                         False, wxToolButtonPopupCallback, (XtPointer) this);
 450
 451                 currentSpacing = 0;
 452                 break;
 453         }
 454
 455         node = node->GetNext();
 456     }
 457
 458     SetSize(-1, -1, currentX, buttonHeight + 2*marginY);
 459
 460     return TRUE;
 461 }
 462
 463 wxToolBarToolBase *wxToolBar::FindToolForPosition(wxCoord WXUNUSED(x),
 464                                                   wxCoord WXUNUSED(y)) const
 465 {
 466     wxFAIL_MSG( _T("TODO") );
 467
 468     return (wxToolBarToolBase *)NULL;
 469 }
 470
 471 bool wxToolBar::DoInsertTool(size_t WXUNUSED(pos), wxToolBarToolBase *tool)
 472 {
 473     tool->Attach(this);
 474
 475     return TRUE;
 476 }
 477
 478 bool wxToolBar::DoDeleteTool(size_t WXUNUSED(pos), wxToolBarToolBase *tool)
 479 {
 480     tool->Detach();
 481
 482     return TRUE;
 483 }
 484
 485 void wxToolBar::DoEnableTool(wxToolBarToolBase *toolBase, bool enable)
 486 {
 487     wxToolBarTool *tool = (wxToolBarTool *)toolBase;
 488
 489     XtSetSensitive(tool->GetButtonWidget(), (Boolean) enable);
 490 }
 491
 492 void wxToolBar::DoToggleTool(wxToolBarToolBase *toolBase, bool toggle)
 493 {
 494     wxToolBarTool *tool = (wxToolBarTool *)toolBase;
 495
 496     XmToggleButtonSetState(tool->GetButtonWidget(), (Boolean) toggle, False);
 497 }
 498
 499 void wxToolBar::DoSetToggle(wxToolBarToolBase * WXUNUSED(tool),
 500                             bool WXUNUSED(toggle))
 501 {
 502     // nothing to do
 503 }
 504
 505 // ----------------------------------------------------------------------------
 506 // Motif callbacks
 507 // ----------------------------------------------------------------------------
 508
 509 wxToolBarToolBase *wxToolBar::FindToolByWidget(WXWidget w) const
 510 {
 511     wxToolBarToolsList::Node* node = m_tools.GetFirst();
 512     while ( node )
 513     {
 514         wxToolBarTool *tool = (wxToolBarTool *)node->GetData();
 515         if ( tool->GetButtonWidget() == w)
 516         {
 517             return tool;
 518         }
 519
 520         node = node->GetNext();
 521     }
 522
 523     return (wxToolBarToolBase *)NULL;
 524 }
 525
 526 static void wxToolButtonCallback(Widget w,
 527                                  XtPointer clientData,
 528                                  XtPointer WXUNUSED(ptr))
 529 {
 530     wxToolBar *toolBar = (wxToolBar *) clientData;
 531     wxToolBarToolBase *tool = toolBar->FindToolByWidget((WXWidget) w);
 532     if ( !tool )
 533         return;
 534
 535     if ( tool->CanBeToggled() )
 536         tool->Toggle();
 537
 538     if ( !toolBar->OnLeftClick(tool->GetId(), tool->IsToggled()) )
 539     {
 540         // revert
 541         tool->Toggle();
 542     }
 543 }
 544
 545
 546 static void wxToolButtonPopupCallback(Widget w,
 547                                       XtPointer client_data,
 548                                       XEvent *event,
 549                                       Boolean *WXUNUSED(continue_to_dispatch))
 550 {
 551     // TODO: retrieve delay before popping up tooltip from wxSystemSettings.
 552     static const int delayMilli = 800;
 553
 554     wxToolBar* toolBar = (wxToolBar*) client_data;
 555     wxToolBarToolBase *tool = toolBar->FindToolByWidget((WXWidget) w);
 556
 557     if ( !tool )
 558         return;
 559
 560     wxString tooltip = tool->GetShortHelp();
 561     if ( !tooltip )
 562         return;
 563
 564     if (!wxTheToolBarTimer)
 565         wxTheToolBarTimer = new wxToolBarTimer;
 566
 567     wxToolBarTimer::buttonWidget = w;
 568     wxToolBarTimer::helpString = tooltip;
 569
 570     /************************************************************/
 571     /* Popup help label                                         */
 572     /************************************************************/
 573     if (event->type == EnterNotify)
 574     {
 575         if (wxToolBarTimer::help_popup != (Widget) 0)
 576         {
 577             XtDestroyWidget (wxToolBarTimer::help_popup);
 578             XtPopdown (wxToolBarTimer::help_popup);
 579         }
 580         wxToolBarTimer::help_popup = (Widget) 0;
 581
 582         // One shot
 583         wxTheToolBarTimer->Start(delayMilli, TRUE);
 584
 585     }
 586     /************************************************************/
 587     /* Popdown help label                                       */
 588     /************************************************************/
 589     else if (event->type == LeaveNotify)
 590     {
 591         if (wxTheToolBarTimer)
 592             wxTheToolBarTimer->Stop();
 593         if (wxToolBarTimer::help_popup != (Widget) 0)
 594         {
 595             XtDestroyWidget (wxToolBarTimer::help_popup);
 596             XtPopdown (wxToolBarTimer::help_popup);
 597         }
 598         wxToolBarTimer::help_popup = (Widget) 0;
 599     }
 600 }
 601
 602 void wxToolBarTimer::Notify()
 603 {
 604     Position x, y;
 605
 606         /************************************************************/
 607         /* Create shell without window decorations                  */
 608         /************************************************************/
 609         help_popup = XtVaCreatePopupShell ("shell",
 610                                            overrideShellWidgetClass, (Widget) wxTheApp->GetTopLevelWidget(),
 611                                            NULL);
 612
 613         /************************************************************/
 614         /* Get absolute position on display of toolbar button       */
 615         /************************************************************/
 616         XtTranslateCoords (buttonWidget,
 617                            (Position) 0,
 618                            (Position) 0,
 619                            &x, &y);
 620
 621         // Move the tooltip more or less above the button
 622         int yOffset = 20; // TODO: What should be really?
 623         y -= yOffset;
 624         if (y < yOffset) y = 0;
 625
 626         /************************************************************/
 627         /* Set the position of the help popup                       */
 628         /************************************************************/
 629         XtVaSetValues (help_popup,
 630                        XmNx, (Position) x,
 631                        XmNy, (Position) y,
 632                        NULL);
 633
 634         /************************************************************/
 635         /* Create help label                                        */
 636         /************************************************************/
 637         XmString text = XmStringCreateSimple ((char*) (const char*) helpString);
 638         XtVaCreateManagedWidget ("help_label",
 639                                  xmLabelWidgetClass, help_popup,
 640                                  XmNlabelString, text,
 641                                  XtVaTypedArg,
 642                                  XmNforeground, XtRString, "black",
 643                                                 strlen("black")+1,
 644                                  XtVaTypedArg,
 645                                  XmNbackground, XtRString, "LightGoldenrod",
 646                                                 strlen("LightGoldenrod")+1,
 647                                  NULL);
 648         XmStringFree (text);
 649
 650         /************************************************************/
 651         /* Popup help label                                         */
 652         /************************************************************/
 653         XtPopup (help_popup, XtGrabNone);
 654 }
 655