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