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     wxToolBar *tbar = (wxToolBar *)tool->GetToolBar();
 161
 162     if (tbar->m_blockEvent) return;
 163
 164     if (g_blockEventsOnDrag) return;
 165     if (!tool->IsEnabled()) return;
 166
 167     if (tool->CanBeToggled())
 168     {
 169         tool->Toggle();
 170
 171         tool->SetImage(tool->GetBitmap());
 172
 173         if ( tool->IsRadio() && !tool->IsToggled() )
 174         {
 175             // radio button went up, don't report this as a wxWin event
 176             return;
 177         }
 178     }
 179
 180     if( !tbar->OnLeftClick( tool->GetId(), tool->IsToggled() ) && tool->CanBeToggled() )
 181     {
 182         // revert back
 183         tool->Toggle();
 184
 185         tool->SetImage(tool->GetBitmap());
 186     }
 187 }
 188 }
 189
 190 //-----------------------------------------------------------------------------
 191 // "enter_notify_event" / "leave_notify_event"
 192 //-----------------------------------------------------------------------------
 193
 194 extern "C" {
 195 static gint gtk_toolbar_tool_callback( GtkWidget *WXUNUSED(widget),
 196                                        GdkEventCrossing *gdk_event,
 197                                        wxToolBarTool *tool )
 198 {
 199     if (g_blockEventsOnDrag) return TRUE;
 200
 201     wxToolBar *tb = (wxToolBar *)tool->GetToolBar();
 202
 203     // emit the event
 204     if( gdk_event->type == GDK_ENTER_NOTIFY )
 205         tb->OnMouseEnter( tool->GetId() );
 206     else
 207         tb->OnMouseEnter( -1 );
 208
 209     return FALSE;
 210 }
 211 }
 212
 213 extern "C" {
 214 static
 215 void gtktoolwidget_size_callback( GtkWidget *widget,
 216                                   GtkAllocation *alloc,
 217                                   wxWindow *win )
 218 {
 219     // this shouldn't happen...
 220     if (win->GetParent()->m_wxwindow) return;
 221
 222     wxSize size = win->GetEffectiveMinSize();
 223     if (size.y != alloc->height)
 224     {
 225         GtkAllocation alloc2;
 226         alloc2.x = alloc->x;
 227         alloc2.y = (alloc->height - size.y + 3) / 2;
 228         alloc2.width = alloc->width;
 229         alloc2.height = size.y;
 230         gtk_widget_size_allocate( widget, &alloc2 );
 231     }
 232 }
 233 }
 234 //-----------------------------------------------------------------------------
 235 // InsertChild callback for wxToolBar
 236 //-----------------------------------------------------------------------------
 237
 238 static void wxInsertChildInToolBar( wxToolBar* WXUNUSED(parent),
 239                                     wxWindow* WXUNUSED(child) )
 240 {
 241     // we don't do anything here
 242 }
 243
 244 // ----------------------------------------------------------------------------
 245 // wxToolBarTool
 246 // ----------------------------------------------------------------------------
 247
 248 void wxToolBarTool::Init()
 249 {
 250     m_item =
 251     m_image = NULL;
 252 }
 253
 254 wxToolBarToolBase *wxToolBar::CreateTool(int id,
 255                                          const wxString& text,
 256                                          const wxBitmap& bitmap1,
 257                                          const wxBitmap& bitmap2,
 258                                          wxItemKind kind,
 259                                          wxObject *clientData,
 260                                          const wxString& shortHelpString,
 261                                          const wxString& longHelpString)
 262 {
 263     return new wxToolBarTool(this, id, text, bitmap1, bitmap2, kind,
 264                              clientData, shortHelpString, longHelpString);
 265 }
 266
 267 wxToolBarToolBase *
 268 wxToolBar::CreateTool(wxControl *control, const wxString& label)
 269 {
 270     return new wxToolBarTool(this, control, label);
 271 }
 272
 273 //-----------------------------------------------------------------------------
 274 // wxToolBar construction
 275 //-----------------------------------------------------------------------------
 276
 277 void wxToolBar::Init()
 278 {
 279     m_toolbar = (GtkToolbar *)NULL;
 280     m_blockEvent = false;
 281     m_defaultWidth = 32;
 282     m_defaultHeight = 32;
 283 }
 284
 285 wxToolBar::~wxToolBar()
 286 {
 287 }
 288
 289 bool wxToolBar::Create( wxWindow *parent,
 290                         wxWindowID id,
 291                         const wxPoint& pos,
 292                         const wxSize& size,
 293                         long style,
 294                         const wxString& name )
 295 {
 296     m_needParent = true;
 297     m_insertCallback = (wxInsertChildFunction)wxInsertChildInToolBar;
 298
 299     if ( !PreCreation( parent, pos, size ) ||
 300          !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))
 301     {
 302         wxFAIL_MSG( wxT("wxToolBar creation failed") );
 303
 304         return false;
 305     }
 306
 307     FixupStyle();
 308
 309     m_toolbar = GTK_TOOLBAR( gtk_toolbar_new() );
 310     GtkSetStyle();
 311
 312     // Doesn't work this way.
 313     // GtkToolbarSpaceStyle space_style = GTK_TOOLBAR_SPACE_EMPTY;
 314     // gtk_widget_style_set (GTK_WIDGET (m_toolbar), "space_style", &space_style, NULL);
 315
 316     SetToolSeparation(7);
 317
 318     if (style & wxTB_DOCKABLE)
 319     {
 320         m_widget = gtk_handle_box_new();
 321         gtk_container_add( GTK_CONTAINER(m_widget), GTK_WIDGET(m_toolbar) );
 322         gtk_widget_show( GTK_WIDGET(m_toolbar) );
 323
 324         if (style & wxTB_FLAT)
 325             gtk_handle_box_set_shadow_type( GTK_HANDLE_BOX(m_widget), GTK_SHADOW_NONE );
 326     }
 327     else
 328     {
 329         m_widget = gtk_event_box_new();
 330         gtk_container_add( GTK_CONTAINER(m_widget), GTK_WIDGET(m_toolbar) );
 331         ConnectWidget( m_widget );
 332         gtk_widget_show(GTK_WIDGET(m_toolbar));
 333     }
 334
 335     // FIXME: there is no such function for toolbars in 2.0
 336 #if 0
 337     if (style & wxTB_FLAT)
 338         gtk_toolbar_set_button_relief( GTK_TOOLBAR(m_toolbar), GTK_RELIEF_NONE );
 339 #endif
 340
 341     m_parent->DoAddChild( this );
 342
 343     PostCreation(size);
 344
 345     return true;
 346 }
 347
 348 GdkWindow *wxToolBar::GTKGetWindow(wxArrayGdkWindows& windows) const
 349 {
 350     return GTK_WIDGET(m_toolbar)->window;
 351 }
 352
 353 void wxToolBar::GtkSetStyle()
 354 {
 355     GtkOrientation orient;
 356     GtkToolbarStyle style;
 357     GetGtkStyle(GetWindowStyle(), &orient, &style);
 358
 359     gtk_toolbar_set_orientation(m_toolbar, orient);
 360     gtk_toolbar_set_style(m_toolbar, style);
 361     gtk_toolbar_set_tooltips(m_toolbar, !(style & wxTB_NO_TOOLTIPS));
 362 }
 363
 364 void wxToolBar::SetWindowStyleFlag( long style )
 365 {
 366     wxToolBarBase::SetWindowStyleFlag(style);
 367
 368     if ( m_toolbar )
 369         GtkSetStyle();
 370 }
 371
 372 bool wxToolBar::DoInsertTool(size_t pos, wxToolBarToolBase *toolBase)
 373 {
 374     wxToolBarTool* tool = wx_static_cast(wxToolBarTool*, toolBase);
 375
 376     if ( tool->IsButton() )
 377     {
 378         if ( !HasFlag(wxTB_NOICONS) )
 379         {
 380             wxBitmap bitmap = tool->GetNormalBitmap();
 381
 382             wxCHECK_MSG( bitmap.Ok(), false,
 383                          wxT("invalid bitmap for wxToolBar icon") );
 384
 385             tool->m_image = gtk_image_new();
 386             tool->SetImage(bitmap);
 387
 388             gtk_misc_set_alignment((GtkMisc*)tool->m_image, 0.5, 0.5);
 389         }
 390     }
 391
 392     const int posGtk = int(pos);
 393
 394     switch ( tool->GetStyle() )
 395     {
 396         case wxTOOL_STYLE_BUTTON:
 397             // for a radio button we need the widget which starts the radio
 398             // group it belongs to, i.e. the first radio button immediately
 399             // preceding this one
 400             {
 401                 GtkWidget *widget = NULL;
 402
 403                 if ( tool->IsRadio() )
 404                 {
 405                     wxToolBarToolsList::compatibility_iterator node
 406                         = wxToolBarToolsList::compatibility_iterator();
 407                     if ( pos )
 408                         node = m_tools.Item(pos - 1);
 409
 410                     while ( node )
 411                     {
 412                         wxToolBarTool *toolNext = (wxToolBarTool *)node->GetData();
 413                         if ( !toolNext->IsRadio() )
 414                             break;
 415
 416                         widget = toolNext->m_item;
 417
 418                         node = node->GetPrevious();
 419                     }
 420
 421                     if ( !widget )
 422                     {
 423                         // this is the first button in the radio button group,
 424                         // it will be toggled automatically by GTK so bring the
 425                         // internal flag in sync
 426                         tool->Toggle(true);
 427                     }
 428                 }
 429
 430                 tool->m_item = gtk_toolbar_insert_element
 431                                (
 432                                   m_toolbar,
 433                                   tool->GetGtkChildType(),
 434                                   widget,
 435                                   tool->GetLabel().empty()
 436                                     ? NULL
 437                                     : (const char*) wxGTK_CONV( tool->GetLabel() ),
 438                                   tool->GetShortHelp().empty()
 439                                     ? NULL
 440                                     : (const char*) wxGTK_CONV( tool->GetShortHelp() ),
 441                                   "", // tooltip_private_text (?)
 442                                   tool->m_image,
 443                                   (GtkSignalFunc)gtk_toolbar_callback,
 444                                   (gpointer)tool,
 445                                   posGtk
 446                                );
 447
 448                 wxCHECK_MSG(tool->m_item != NULL, false, _T("gtk_toolbar_insert_element() failed"));
 449
 450                 g_signal_connect (tool->m_item, "enter_notify_event",
 451                                   G_CALLBACK (gtk_toolbar_tool_callback),
 452                                   tool);
 453                 g_signal_connect (tool->m_item, "leave_notify_event",
 454                                   G_CALLBACK (gtk_toolbar_tool_callback),
 455                                   tool);
 456             }
 457             break;
 458
 459         case wxTOOL_STYLE_SEPARATOR:
 460             gtk_toolbar_insert_space( m_toolbar, posGtk );
 461
 462             // skip the rest
 463             return true;
 464
 465         case wxTOOL_STYLE_CONTROL:
 466             gtk_toolbar_insert_widget(
 467                                        m_toolbar,
 468                                        tool->GetControl()->m_widget,
 469                                        (const char *) NULL,
 470                                        (const char *) NULL,
 471                                        posGtk
 472                                       );
 473
 474             // connect after in order to correct size_allocate events
 475             g_signal_connect_after (tool->GetControl()->m_widget, "size_allocate",
 476                           G_CALLBACK (gtktoolwidget_size_callback), tool->GetControl());
 477
 478             break;
 479     }
 480
 481     GtkRequisition req;
 482     (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget) )->size_request )
 483         (m_widget, &req );
 484     m_width = req.width + m_xMargin;
 485     m_height = req.height + 2*m_yMargin;
 486     InvalidateBestSize();
 487
 488     return true;
 489 }
 490
 491 bool wxToolBar::DoDeleteTool(size_t pos, wxToolBarToolBase *toolBase)
 492 {
 493     wxToolBarTool* tool = wx_static_cast(wxToolBarTool*, toolBase);
 494
 495     switch ( tool->GetStyle() )
 496     {
 497         case wxTOOL_STYLE_CONTROL:
 498             tool->GetControl()->Destroy();
 499             break;
 500
 501         case wxTOOL_STYLE_BUTTON:
 502             gtk_widget_destroy( tool->m_item );
 503             break;
 504
 505         case wxTOOL_STYLE_SEPARATOR:
 506             gtk_toolbar_remove_space( m_toolbar, pos );
 507             break;
 508     }
 509
 510     InvalidateBestSize();
 511     return true;
 512 }
 513
 514 // ----------------------------------------------------------------------------
 515 // wxToolBar tools state
 516 // ----------------------------------------------------------------------------
 517
 518 void wxToolBar::DoEnableTool(wxToolBarToolBase *toolBase, bool enable)
 519 {
 520     wxToolBarTool* tool = wx_static_cast(wxToolBarTool*, toolBase);
 521
 522     if (tool->m_item)
 523     {
 524         gtk_widget_set_sensitive( tool->m_item, enable );
 525     }
 526 }
 527
 528 void wxToolBar::DoToggleTool( wxToolBarToolBase *toolBase, bool toggle )
 529 {
 530     wxToolBarTool* tool = wx_static_cast(wxToolBarTool*, toolBase);
 531
 532     GtkWidget *item = tool->m_item;
 533     if ( item && GTK_IS_TOGGLE_BUTTON(item) )
 534     {
 535         tool->SetImage(tool->GetBitmap());
 536
 537         m_blockEvent = true;
 538
 539         gtk_toggle_button_set_active( GTK_TOGGLE_BUTTON(item), toggle );
 540
 541         m_blockEvent = false;
 542     }
 543 }
 544
 545 void wxToolBar::DoSetToggle(wxToolBarToolBase * WXUNUSED(tool),
 546                             bool WXUNUSED(toggle))
 547 {
 548     // VZ: absolutely no idea about how to do it
 549     wxFAIL_MSG( _T("not implemented") );
 550 }
 551
 552 // ----------------------------------------------------------------------------
 553 // wxToolBar geometry
 554 // ----------------------------------------------------------------------------
 555
 556 wxToolBarToolBase *wxToolBar::FindToolForPosition(wxCoord WXUNUSED(x),
 557                                                   wxCoord WXUNUSED(y)) const
 558 {
 559     // VZ: GTK+ doesn't seem to have such thing
 560     wxFAIL_MSG( _T("wxToolBar::FindToolForPosition() not implemented") );
 561
 562     return (wxToolBarToolBase *)NULL;
 563 }
 564
 565 void wxToolBar::SetMargins( int x, int y )
 566 {
 567     wxCHECK_RET( GetToolsCount() == 0,
 568                  wxT("wxToolBar::SetMargins must be called before adding tools.") );
 569
 570     m_xMargin = x;
 571     m_yMargin = y;
 572 }
 573
 574 void wxToolBar::SetToolSeparation( int separation )
 575 {
 576     // FIXME: this function disappeared
 577 #if 0
 578     gtk_toolbar_set_space_size( m_toolbar, separation );
 579 #endif
 580
 581     m_toolSeparation = separation;
 582 }
 583
 584 void wxToolBar::SetToolShortHelp( int id, const wxString& helpString )
 585 {
 586     wxToolBarTool* tool = wx_static_cast(wxToolBarTool*, FindById(id));
 587
 588     if ( tool )
 589     {
 590         (void)tool->SetShortHelp(helpString);
 591         gtk_tooltips_set_tip(m_toolbar->tooltips, tool->m_item,
 592                              wxGTK_CONV( helpString ), "");
 593     }
 594 }
 595
 596 void wxToolBar::SetToolNormalBitmap( int id, const wxBitmap& bitmap )
 597 {
 598     wxToolBarTool* tool = wx_static_cast(wxToolBarTool*, FindById(id));
 599     if ( tool )
 600     {
 601         wxCHECK_RET( tool->IsButton(), wxT("Can only set bitmap on button tools."));
 602
 603         tool->SetNormalBitmap(bitmap);
 604         tool->SetImage(tool->GetBitmap());
 605     }
 606 }
 607
 608 void wxToolBar::SetToolDisabledBitmap( int id, const wxBitmap& bitmap )
 609 {
 610     wxToolBarTool* tool = wx_static_cast(wxToolBarTool*, FindById(id));
 611     if ( tool )
 612     {
 613         wxCHECK_RET( tool->IsButton(), wxT("Can only set bitmap on button tools."));
 614
 615         tool->SetDisabledBitmap(bitmap);
 616         tool->SetImage(tool->GetBitmap());
 617     }
 618 }
 619
 620 // ----------------------------------------------------------------------------
 621 // wxToolBar idle handling
 622 // ----------------------------------------------------------------------------
 623
 624 void wxToolBar::OnInternalIdle()
 625 {
 626     // Check if we have to show window now
 627     if (GtkShowFromOnIdle()) return;
 628
 629     wxCursor cursor = m_cursor;
 630     if (g_globalCursor.Ok()) cursor = g_globalCursor;
 631
 632     if (cursor.Ok())
 633     {
 634         /* I now set the cursor the anew in every OnInternalIdle call
 635            as setting the cursor in a parent window also effects the
 636            windows above so that checking for the current cursor is
 637            not possible. */
 638
 639         if (HasFlag(wxTB_DOCKABLE) && (m_widget->window))
 640         {
 641             /* if the toolbar is dockable, then m_widget stands for the
 642                GtkHandleBox widget, which uses its own window so that we
 643                can set the cursor for it. if the toolbar is not dockable,
 644                m_widget comes from m_toolbar which uses its parent's
 645                window ("windowless windows") and thus we cannot set the
 646                cursor. */
 647             gdk_window_set_cursor( m_widget->window, cursor.GetCursor() );
 648         }
 649
 650         wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
 651         while ( node )
 652         {
 653             wxToolBarTool *tool = (wxToolBarTool *)node->GetData();
 654             node = node->GetNext();
 655
 656             GtkWidget *item = tool->m_item;
 657             if ( item )
 658             {
 659                 GdkWindow *window = item->window;
 660
 661                 if ( window )
 662                 {
 663                     gdk_window_set_cursor( window, cursor.GetCursor() );
 664                 }
 665             }
 666         }
 667     }
 668
 669     if (wxUpdateUIEvent::CanUpdate(this))
 670         UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
 671 }
 672
 673
 674 // ----------------------------------------------------------------------------
 675
 676 // static
 677 wxVisualAttributes
 678 wxToolBar::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 679 {
 680     return GetDefaultAttributesFromGTKWidget(gtk_toolbar_new);
 681 }
 682
 683 #endif // wxUSE_TOOLBAR_NATIVE