src/gtk/tbargtk.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/tbargtk.cpp
   3 // Purpose:     GTK toolbar
   4 // Author:      Robert Roebling
   5 // Modified:    13.12.99 by VZ to derive from wxToolBarBase
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) Robert Roebling
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 // ============================================================================
  12 // declarations
  13 // ============================================================================
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 // For compilers that support precompilation, includes "wx.h".
  20 #include "wx/wxprec.h"
  21
  22 #if wxUSE_TOOLBAR_NATIVE
  23
  24 #include "wx/toolbar.h"
  25
  26 #ifndef WX_PRECOMP
  27     #include "wx/frame.h"
  28 #endif
  29
  30 // FIXME: Use GtkImage instead of GtkPixmap. Use the new toolbar API for when gtk runtime is new enough?
  31 // Beware that the new and old toolbar API may not be mixed in usage.
  32 #include <gtk/gtkversion.h>
  33 #ifdef GTK_DISABLE_DEPRECATED
  34 #undef GTK_DISABLE_DEPRECATED
  35 #endif
  36
  37 #include "wx/gtk/private.h"
  38
  39 // ----------------------------------------------------------------------------
  40 // globals
  41 // ----------------------------------------------------------------------------
  42
  43 // data
  44 extern bool       g_blockEventsOnDrag;
  45 extern wxCursor   g_globalCursor;
  46
  47 // ----------------------------------------------------------------------------
  48 // private functions
  49 // ----------------------------------------------------------------------------
  50
  51 // translate wxWidgets toolbar style flags to GTK orientation and style
  52 static void GetGtkStyle(long style,
  53                         GtkOrientation *orient, GtkToolbarStyle *gtkStyle)
  54 {
  55     *orient = ( style & wxTB_LEFT || style & wxTB_RIGHT ) ? GTK_ORIENTATION_VERTICAL : GTK_ORIENTATION_HORIZONTAL;
  56
  57
  58     if ( style & wxTB_TEXT )
  59     {
  60         *gtkStyle = style & wxTB_NOICONS
  61                         ? GTK_TOOLBAR_TEXT
  62                         : (
  63                           style & wxTB_HORZ_LAYOUT ? GTK_TOOLBAR_BOTH_HORIZ :
  64                           GTK_TOOLBAR_BOTH);
  65     }
  66     else // no text, hence we must have the icons or what would we show?
  67     {
  68         *gtkStyle = GTK_TOOLBAR_ICONS;
  69     }
  70 }
  71
  72 // ----------------------------------------------------------------------------
  73 // wxToolBarTool
  74 // ----------------------------------------------------------------------------
  75
  76 class wxToolBarTool : public wxToolBarToolBase
  77 {
  78 public:
  79     wxToolBarTool(wxToolBar *tbar,
  80                   int id,
  81                   const wxString& label,
  82                   const wxBitmap& bitmap1,
  83                   const wxBitmap& bitmap2,
  84                   wxItemKind kind,
  85                   wxObject *clientData,
  86                   const wxString& shortHelpString,
  87                   const wxString& longHelpString)
  88         : wxToolBarToolBase(tbar, id, label, bitmap1, bitmap2, kind,
  89                             clientData, shortHelpString, longHelpString)
  90     {
  91         Init();
  92     }
  93
  94     wxToolBarTool(wxToolBar *tbar, wxControl *control, const wxString& label)
  95         : wxToolBarToolBase(tbar, control, label)
  96     {
  97         Init();
  98     }
  99
 100     // is this a radio button?
 101     //
 102     // unlike GetKind(), can be called for any kind of tools, not just buttons
 103     bool IsRadio() const { return IsButton() && GetKind() == wxITEM_RADIO; }
 104
 105     // this is only called for the normal buttons, i.e. not separators nor
 106     // controls
 107     GtkToolbarChildType GetGtkChildType() const
 108     {
 109         switch ( GetKind() )
 110         {
 111             case wxITEM_CHECK:
 112                 return GTK_TOOLBAR_CHILD_TOGGLEBUTTON;
 113
 114             case wxITEM_RADIO:
 115                 return GTK_TOOLBAR_CHILD_RADIOBUTTON;
 116
 117             default:
 118                 wxFAIL_MSG( _T("unknown toolbar child type") );
 119                 // fall through
 120
 121             case wxITEM_NORMAL:
 122                 return GTK_TOOLBAR_CHILD_BUTTON;
 123         }
 124     }
 125
 126     void SetImage(const wxBitmap& bitmap)
 127     {
 128         if (bitmap.Ok())
 129         {
 130             // setting from pixmap doesn't seem to work right, but pixbuf works well
 131             gtk_image_set_from_pixbuf((GtkImage*)m_image, bitmap.GetPixbuf());
 132         }
 133     }
 134
 135     GtkWidget            *m_item;
 136     GtkWidget            *m_image;
 137
 138 protected:
 139     void Init();
 140 };
 141
 142 // ----------------------------------------------------------------------------
 143 // wxWin macros
 144 // ----------------------------------------------------------------------------
 145
 146 IMPLEMENT_DYNAMIC_CLASS(wxToolBar, wxControl)
 147
 148 // ============================================================================
 149 // implementation
 150 // ============================================================================
 151
 152 //-----------------------------------------------------------------------------
 153 // "clicked" (internal from gtk_toolbar)
 154 //-----------------------------------------------------------------------------
 155
 156 extern "C" {
 157 static void gtk_toolbar_callback( GtkWidget *WXUNUSED(widget),
 158                                   wxToolBarTool *tool )
 159 {
 160     if (g_isIdle)
 161         wxapp_install_idle_handler();
 162
 163     wxToolBar *tbar = (wxToolBar *)tool->GetToolBar();
 164
 165     if (tbar->m_blockEvent) return;
 166
 167     if (g_blockEventsOnDrag) return;
 168     if (!tool->IsEnabled()) return;
 169
 170     if (tool->CanBeToggled())
 171     {
 172         tool->Toggle();
 173
 174         tool->SetImage(tool->GetBitmap());
 175
 176         if ( tool->IsRadio() && !tool->IsToggled() )
 177         {
 178             // radio button went up, don't report this as a wxWin event
 179             return;
 180         }
 181     }
 182
 183     if( !tbar->OnLeftClick( tool->GetId(), tool->IsToggled() ) && tool->CanBeToggled() )
 184     {
 185         // revert back
 186         tool->Toggle();
 187
 188         tool->SetImage(tool->GetBitmap());
 189     }
 190 }
 191 }
 192
 193 //-----------------------------------------------------------------------------
 194 // "enter_notify_event" / "leave_notify_event"
 195 //-----------------------------------------------------------------------------
 196
 197 extern "C" {
 198 static gint gtk_toolbar_tool_callback( GtkWidget *WXUNUSED(widget),
 199                                        GdkEventCrossing *gdk_event,
 200                                        wxToolBarTool *tool )
 201 {
 202     // don't need to install idle handler, its done from "event" signal
 203
 204     if (g_blockEventsOnDrag) return TRUE;
 205
 206     wxToolBar *tb = (wxToolBar *)tool->GetToolBar();
 207
 208     // emit the event
 209     if( gdk_event->type == GDK_ENTER_NOTIFY )
 210         tb->OnMouseEnter( tool->GetId() );
 211     else
 212         tb->OnMouseEnter( -1 );
 213
 214     return FALSE;
 215 }
 216 }
 217
 218 extern "C" {
 219 static
 220 void gtktoolwidget_size_callback( GtkWidget *widget,
 221                                   GtkAllocation *alloc,
 222                                   wxWindow *win )
 223 {
 224     // this shouldn't happen...
 225     if (win->GetParent()->m_wxwindow) return;
 226
 227     wxSize size = win->GetEffectiveMinSize();
 228     if (size.y != alloc->height)
 229     {
 230         GtkAllocation alloc2;
 231         alloc2.x = alloc->x;
 232         alloc2.y = (alloc->height - size.y + 3) / 2;
 233         alloc2.width = alloc->width;
 234         alloc2.height = size.y;
 235         gtk_widget_size_allocate( widget, &alloc2 );
 236     }
 237 }
 238 }
 239 //-----------------------------------------------------------------------------
 240 // InsertChild callback for wxToolBar
 241 //-----------------------------------------------------------------------------
 242
 243 static void wxInsertChildInToolBar( wxToolBar* WXUNUSED(parent),
 244                                     wxWindow* WXUNUSED(child) )
 245 {
 246     // we don't do anything here
 247 }
 248
 249 // ----------------------------------------------------------------------------
 250 // wxToolBarTool
 251 // ----------------------------------------------------------------------------
 252
 253 void wxToolBarTool::Init()
 254 {
 255     m_item =
 256     m_image = NULL;
 257 }
 258
 259 wxToolBarToolBase *wxToolBar::CreateTool(int id,
 260                                          const wxString& text,
 261                                          const wxBitmap& bitmap1,
 262                                          const wxBitmap& bitmap2,
 263                                          wxItemKind kind,
 264                                          wxObject *clientData,
 265                                          const wxString& shortHelpString,
 266                                          const wxString& longHelpString)
 267 {
 268     return new wxToolBarTool(this, id, text, bitmap1, bitmap2, kind,
 269                              clientData, shortHelpString, longHelpString);
 270 }
 271
 272 wxToolBarToolBase *
 273 wxToolBar::CreateTool(wxControl *control, const wxString& label)
 274 {
 275     return new wxToolBarTool(this, control, label);
 276 }
 277
 278 //-----------------------------------------------------------------------------
 279 // wxToolBar construction
 280 //-----------------------------------------------------------------------------
 281
 282 void wxToolBar::Init()
 283 {
 284     m_toolbar = (GtkToolbar *)NULL;
 285     m_blockEvent = false;
 286     m_defaultWidth = 32;
 287     m_defaultHeight = 32;
 288 }
 289
 290 wxToolBar::~wxToolBar()
 291 {
 292 }
 293
 294 bool wxToolBar::Create( wxWindow *parent,
 295                         wxWindowID id,
 296                         const wxPoint& pos,
 297                         const wxSize& size,
 298                         long style,
 299                         const wxString& name )
 300 {
 301     m_needParent = true;
 302     m_insertCallback = (wxInsertChildFunction)wxInsertChildInToolBar;
 303
 304     if ( !PreCreation( parent, pos, size ) ||
 305          !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))
 306     {
 307         wxFAIL_MSG( wxT("wxToolBar creation failed") );
 308
 309         return false;
 310     }
 311
 312     FixupStyle();
 313
 314     m_toolbar = GTK_TOOLBAR( gtk_toolbar_new() );
 315     GtkSetStyle();
 316
 317     // Doesn't work this way.
 318     // GtkToolbarSpaceStyle space_style = GTK_TOOLBAR_SPACE_EMPTY;
 319     // gtk_widget_style_set (GTK_WIDGET (m_toolbar), "space_style", &space_style, NULL);
 320
 321     SetToolSeparation(7);
 322
 323     if (style & wxTB_DOCKABLE)
 324     {
 325         m_widget = gtk_handle_box_new();
 326         gtk_container_add( GTK_CONTAINER(m_widget), GTK_WIDGET(m_toolbar) );
 327         gtk_widget_show( GTK_WIDGET(m_toolbar) );
 328
 329         if (style & wxTB_FLAT)
 330             gtk_handle_box_set_shadow_type( GTK_HANDLE_BOX(m_widget), GTK_SHADOW_NONE );
 331     }
 332     else
 333     {
 334         m_widget = gtk_event_box_new();
 335         gtk_container_add( GTK_CONTAINER(m_widget), GTK_WIDGET(m_toolbar) );
 336         ConnectWidget( m_widget );
 337         gtk_widget_show(GTK_WIDGET(m_toolbar));
 338     }
 339
 340     // FIXME: there is no such function for toolbars in 2.0
 341 #if 0
 342     if (style & wxTB_FLAT)
 343         gtk_toolbar_set_button_relief( GTK_TOOLBAR(m_toolbar), GTK_RELIEF_NONE );
 344 #endif
 345
 346     m_parent->DoAddChild( this );
 347
 348     PostCreation(size);
 349
 350     return true;
 351 }
 352
 353 GdkWindow *wxToolBar::GTKGetWindow(wxArrayGdkWindows& windows) const
 354 {
 355     return GTK_WIDGET(m_toolbar)->window;
 356 }
 357
 358 void wxToolBar::GtkSetStyle()
 359 {
 360     GtkOrientation orient;
 361     GtkToolbarStyle style;
 362     GetGtkStyle(GetWindowStyle(), &orient, &style);
 363
 364     gtk_toolbar_set_orientation(m_toolbar, orient);
 365     gtk_toolbar_set_style(m_toolbar, style);
 366     gtk_toolbar_set_tooltips(m_toolbar, !(style & wxTB_NO_TOOLTIPS));
 367 }
 368
 369 void wxToolBar::SetWindowStyleFlag( long style )
 370 {
 371     wxToolBarBase::SetWindowStyleFlag(style);
 372
 373     if ( m_toolbar )
 374         GtkSetStyle();
 375 }
 376
 377 bool wxToolBar::DoInsertTool(size_t pos, wxToolBarToolBase *toolBase)
 378 {
 379     wxToolBarTool* tool = wx_static_cast(wxToolBarTool*, toolBase);
 380
 381     if ( tool->IsButton() )
 382     {
 383         if ( !HasFlag(wxTB_NOICONS) )
 384         {
 385             wxBitmap bitmap = tool->GetNormalBitmap();
 386
 387             wxCHECK_MSG( bitmap.Ok(), false,
 388                          wxT("invalid bitmap for wxToolBar icon") );
 389
 390             tool->m_image = gtk_image_new();
 391             tool->SetImage(bitmap);
 392
 393             gtk_misc_set_alignment((GtkMisc*)tool->m_image, 0.5, 0.5);
 394         }
 395     }
 396
 397     const int posGtk = int(pos);
 398
 399     switch ( tool->GetStyle() )
 400     {
 401         case wxTOOL_STYLE_BUTTON:
 402             // for a radio button we need the widget which starts the radio
 403             // group it belongs to, i.e. the first radio button immediately
 404             // preceding this one
 405             {
 406                 GtkWidget *widget = NULL;
 407
 408                 if ( tool->IsRadio() )
 409                 {
 410                     wxToolBarToolsList::compatibility_iterator node
 411                         = wxToolBarToolsList::compatibility_iterator();
 412                     if ( pos )
 413                         node = m_tools.Item(pos - 1);
 414
 415                     while ( node )
 416                     {
 417                         wxToolBarTool *toolNext = (wxToolBarTool *)node->GetData();
 418                         if ( !toolNext->IsRadio() )
 419                             break;
 420
 421                         widget = toolNext->m_item;
 422
 423                         node = node->GetPrevious();
 424                     }
 425
 426                     if ( !widget )
 427                     {
 428                         // this is the first button in the radio button group,
 429                         // it will be toggled automatically by GTK so bring the
 430                         // internal flag in sync
 431                         tool->Toggle(true);
 432                     }
 433                 }
 434
 435                 tool->m_item = gtk_toolbar_insert_element
 436                                (
 437                                   m_toolbar,
 438                                   tool->GetGtkChildType(),
 439                                   widget,
 440                                   tool->GetLabel().empty()
 441                                     ? NULL
 442                                     : (const char*) wxGTK_CONV( tool->GetLabel() ),
 443                                   tool->GetShortHelp().empty()
 444                                     ? NULL
 445                                     : (const char*) wxGTK_CONV( tool->GetShortHelp() ),
 446                                   "", // tooltip_private_text (?)
 447                                   tool->m_image,
 448                                   (GtkSignalFunc)gtk_toolbar_callback,
 449                                   (gpointer)tool,
 450                                   posGtk
 451                                );
 452
 453                 wxCHECK_MSG(tool->m_item != NULL, false, _T("gtk_toolbar_insert_element() failed"));
 454
 455                 g_signal_connect (tool->m_item, "enter_notify_event",
 456                                   G_CALLBACK (gtk_toolbar_tool_callback),
 457                                   tool);
 458                 g_signal_connect (tool->m_item, "leave_notify_event",
 459                                   G_CALLBACK (gtk_toolbar_tool_callback),
 460                                   tool);
 461             }
 462             break;
 463
 464         case wxTOOL_STYLE_SEPARATOR:
 465             gtk_toolbar_insert_space( m_toolbar, posGtk );
 466
 467             // skip the rest
 468             return true;
 469
 470         case wxTOOL_STYLE_CONTROL:
 471             gtk_toolbar_insert_widget(
 472                                        m_toolbar,
 473                                        tool->GetControl()->m_widget,
 474                                        (const char *) NULL,
 475                                        (const char *) NULL,
 476                                        posGtk
 477                                       );
 478
 479             // connect after in order to correct size_allocate events
 480             g_signal_connect_after (tool->GetControl()->m_widget, "size_allocate",
 481                           G_CALLBACK (gtktoolwidget_size_callback), tool->GetControl());
 482
 483             break;
 484     }
 485
 486     GtkRequisition req;
 487     (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget) )->size_request )
 488         (m_widget, &req );
 489     m_width = req.width + m_xMargin;
 490     m_height = req.height + 2*m_yMargin;
 491     InvalidateBestSize();
 492
 493     return true;
 494 }
 495
 496 bool wxToolBar::DoDeleteTool(size_t pos, wxToolBarToolBase *toolBase)
 497 {
 498     wxToolBarTool* tool = wx_static_cast(wxToolBarTool*, toolBase);
 499
 500     switch ( tool->GetStyle() )
 501     {
 502         case wxTOOL_STYLE_CONTROL:
 503             tool->GetControl()->Destroy();
 504             break;
 505
 506         case wxTOOL_STYLE_BUTTON:
 507             gtk_widget_destroy( tool->m_item );
 508             break;
 509
 510         case wxTOOL_STYLE_SEPARATOR:
 511             gtk_toolbar_remove_space( m_toolbar, pos );
 512             break;
 513     }
 514
 515     InvalidateBestSize();
 516     return true;
 517 }
 518
 519 // ----------------------------------------------------------------------------
 520 // wxToolBar tools state
 521 // ----------------------------------------------------------------------------
 522
 523 void wxToolBar::DoEnableTool(wxToolBarToolBase *toolBase, bool enable)
 524 {
 525     wxToolBarTool* tool = wx_static_cast(wxToolBarTool*, toolBase);
 526
 527     if (tool->m_item)
 528     {
 529         gtk_widget_set_sensitive( tool->m_item, enable );
 530     }
 531 }
 532
 533 void wxToolBar::DoToggleTool( wxToolBarToolBase *toolBase, bool toggle )
 534 {
 535     wxToolBarTool* tool = wx_static_cast(wxToolBarTool*, toolBase);
 536
 537     GtkWidget *item = tool->m_item;
 538     if ( item && GTK_IS_TOGGLE_BUTTON(item) )
 539     {
 540         tool->SetImage(tool->GetBitmap());
 541
 542         m_blockEvent = true;
 543
 544         gtk_toggle_button_set_active( GTK_TOGGLE_BUTTON(item), toggle );
 545
 546         m_blockEvent = false;
 547     }
 548 }
 549
 550 void wxToolBar::DoSetToggle(wxToolBarToolBase * WXUNUSED(tool),
 551                             bool WXUNUSED(toggle))
 552 {
 553     // VZ: absolutely no idea about how to do it
 554     wxFAIL_MSG( _T("not implemented") );
 555 }
 556
 557 // ----------------------------------------------------------------------------
 558 // wxToolBar geometry
 559 // ----------------------------------------------------------------------------
 560
 561 wxToolBarToolBase *wxToolBar::FindToolForPosition(wxCoord WXUNUSED(x),
 562                                                   wxCoord WXUNUSED(y)) const
 563 {
 564     // VZ: GTK+ doesn't seem to have such thing
 565     wxFAIL_MSG( _T("wxToolBar::FindToolForPosition() not implemented") );
 566
 567     return (wxToolBarToolBase *)NULL;
 568 }
 569
 570 void wxToolBar::SetMargins( int x, int y )
 571 {
 572     wxCHECK_RET( GetToolsCount() == 0,
 573                  wxT("wxToolBar::SetMargins must be called before adding tools.") );
 574
 575     m_xMargin = x;
 576     m_yMargin = y;
 577 }
 578
 579 void wxToolBar::SetToolSeparation( int separation )
 580 {
 581     // FIXME: this function disappeared
 582 #if 0
 583     gtk_toolbar_set_space_size( m_toolbar, separation );
 584 #endif
 585
 586     m_toolSeparation = separation;
 587 }
 588
 589 void wxToolBar::SetToolShortHelp( int id, const wxString& helpString )
 590 {
 591     wxToolBarTool* tool = wx_static_cast(wxToolBarTool*, FindById(id));
 592
 593     if ( tool )
 594     {
 595         (void)tool->SetShortHelp(helpString);
 596         gtk_tooltips_set_tip(m_toolbar->tooltips, tool->m_item,
 597                              wxGTK_CONV( helpString ), "");
 598     }
 599 }
 600
 601 void wxToolBar::SetToolNormalBitmap( int id, const wxBitmap& bitmap )
 602 {
 603     wxToolBarTool* tool = wx_static_cast(wxToolBarTool*, FindById(id));
 604     if ( tool )
 605     {
 606         wxCHECK_RET( tool->IsButton(), wxT("Can only set bitmap on button tools."));
 607
 608         tool->SetNormalBitmap(bitmap);
 609         tool->SetImage(tool->GetBitmap());
 610     }
 611 }
 612
 613 void wxToolBar::SetToolDisabledBitmap( int id, const wxBitmap& bitmap )
 614 {
 615     wxToolBarTool* tool = wx_static_cast(wxToolBarTool*, FindById(id));
 616     if ( tool )
 617     {
 618         wxCHECK_RET( tool->IsButton(), wxT("Can only set bitmap on button tools."));
 619
 620         tool->SetDisabledBitmap(bitmap);
 621         tool->SetImage(tool->GetBitmap());
 622     }
 623 }
 624
 625 // ----------------------------------------------------------------------------
 626 // wxToolBar idle handling
 627 // ----------------------------------------------------------------------------
 628
 629 void wxToolBar::OnInternalIdle()
 630 {
 631     // Check if we have to show window now
 632     if (GtkShowFromOnIdle()) return;
 633
 634     wxCursor cursor = m_cursor;
 635     if (g_globalCursor.Ok()) cursor = g_globalCursor;
 636
 637     if (cursor.Ok())
 638     {
 639         /* I now set the cursor the anew in every OnInternalIdle call
 640            as setting the cursor in a parent window also effects the
 641            windows above so that checking for the current cursor is
 642            not possible. */
 643
 644         if (HasFlag(wxTB_DOCKABLE) && (m_widget->window))
 645         {
 646             /* if the toolbar is dockable, then m_widget stands for the
 647                GtkHandleBox widget, which uses its own window so that we
 648                can set the cursor for it. if the toolbar is not dockable,
 649                m_widget comes from m_toolbar which uses its parent's
 650                window ("windowless windows") and thus we cannot set the
 651                cursor. */
 652             gdk_window_set_cursor( m_widget->window, cursor.GetCursor() );
 653         }
 654
 655         wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
 656         while ( node )
 657         {
 658             wxToolBarTool *tool = (wxToolBarTool *)node->GetData();
 659             node = node->GetNext();
 660
 661             GtkWidget *item = tool->m_item;
 662             if ( item )
 663             {
 664                 GdkWindow *window = item->window;
 665
 666                 if ( window )
 667                 {
 668                     gdk_window_set_cursor( window, cursor.GetCursor() );
 669                 }
 670             }
 671         }
 672     }
 673
 674     if (wxUpdateUIEvent::CanUpdate(this))
 675         UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
 676 }
 677
 678
 679 // ----------------------------------------------------------------------------
 680
 681 // static
 682 wxVisualAttributes
 683 wxToolBar::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 684 {
 685     return GetDefaultAttributesFromGTKWidget(gtk_toolbar_new);
 686 }
 687
 688 #endif // wxUSE_TOOLBAR_NATIVE