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_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     // don't need to install idle handler, its done from "event" signal
 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     // FIXME: there is no such function for toolbars in 2.0
 322 #if 0
 323     if (style & wxTB_FLAT)
 324         gtk_toolbar_set_button_relief( GTK_TOOLBAR(m_toolbar), GTK_RELIEF_NONE );
 325 #endif
 326
 327     m_parent->DoAddChild( this );
 328
 329     PostCreation(size);
 330
 331     return true;
 332 }
 333
 334 GdkWindow *wxToolBar::GTKGetWindow(wxArrayGdkWindows& windows) const
 335 {
 336     return GTK_WIDGET(m_toolbar)->window;
 337 }
 338
 339 void wxToolBar::GtkSetStyle()
 340 {
 341     GtkOrientation orient;
 342     GtkToolbarStyle style;
 343     GetGtkStyle(GetWindowStyle(), &orient, &style);
 344
 345     gtk_toolbar_set_orientation(m_toolbar, orient);
 346     gtk_toolbar_set_style(m_toolbar, style);
 347     gtk_toolbar_set_tooltips( GTK_TOOLBAR(m_toolbar), !(style & wxTB_NO_TOOLTIPS) );
 348 }
 349
 350 void wxToolBar::SetWindowStyleFlag( long style )
 351 {
 352     wxToolBarBase::SetWindowStyleFlag(style);
 353
 354     if ( m_toolbar )
 355         GtkSetStyle();
 356 }
 357
 358 bool wxToolBar::DoInsertTool(size_t pos, wxToolBarToolBase *toolBase)
 359 {
 360     wxToolBarTool *tool = (wxToolBarTool *)toolBase;
 361
 362     size_t posGtk = pos;
 363
 364     if ( tool->IsButton() )
 365     {
 366         if ( !HasFlag(wxTB_NOICONS) )
 367         {
 368             wxBitmap bitmap = tool->GetNormalBitmap();
 369
 370             wxCHECK_MSG( bitmap.Ok(), false,
 371                          wxT("invalid bitmap for wxToolBar icon") );
 372
 373             wxCHECK_MSG( bitmap.GetDepth() != 1, false,
 374                          wxT("wxToolBar doesn't support GdkBitmap") );
 375
 376             wxCHECK_MSG( bitmap.GetPixmap() != NULL, false,
 377                          wxT("wxToolBar::Add needs a wxBitmap") );
 378
 379             GtkWidget *tool_pixmap = (GtkWidget *)NULL;
 380
 381
 382             if (bitmap.HasPixbuf())
 383             {
 384                 tool_pixmap = gtk_image_new();
 385                 tool->m_pixmap = tool_pixmap;
 386                 tool->SetPixmap(bitmap);
 387             }
 388             else
 389             {
 390                 GdkPixmap *pixmap = bitmap.GetPixmap();
 391
 392                 GdkBitmap *mask = (GdkBitmap *)NULL;
 393                 if ( bitmap.GetMask() )
 394                     mask = bitmap.GetMask()->GetBitmap();
 395
 396                 tool_pixmap = gtk_pixmap_new( pixmap, mask );
 397                 gtk_pixmap_set_build_insensitive( GTK_PIXMAP(tool_pixmap), TRUE );
 398             }
 399
 400             gtk_misc_set_alignment( GTK_MISC(tool_pixmap), 0.5, 0.5 );
 401
 402             tool->m_pixmap = tool_pixmap;
 403         }
 404     }
 405
 406     switch ( tool->GetStyle() )
 407     {
 408         case wxTOOL_STYLE_BUTTON:
 409             // for a radio button we need the widget which starts the radio
 410             // group it belongs to, i.e. the first radio button immediately
 411             // preceding this one
 412             {
 413                 GtkWidget *widget = NULL;
 414
 415                 if ( tool->IsRadio() )
 416                 {
 417                     wxToolBarToolsList::compatibility_iterator node
 418                         = wxToolBarToolsList::compatibility_iterator();
 419                     if ( pos )
 420                         node = m_tools.Item(pos - 1);
 421
 422                     while ( node )
 423                     {
 424                         wxToolBarTool *toolNext = (wxToolBarTool *)node->GetData();
 425                         if ( !toolNext->IsRadio() )
 426                             break;
 427
 428                         widget = toolNext->m_item;
 429
 430                         node = node->GetPrevious();
 431                     }
 432
 433                     if ( !widget )
 434                     {
 435                         // this is the first button in the radio button group,
 436                         // it will be toggled automatically by GTK so bring the
 437                         // internal flag in sync
 438                         tool->Toggle(true);
 439                     }
 440                 }
 441
 442                 tool->m_item = gtk_toolbar_insert_element
 443                                (
 444                                   m_toolbar,
 445                                   tool->GetGtkChildType(),
 446                                   widget,
 447                                   tool->GetLabel().empty()
 448                                     ? NULL
 449                                     : (const char*) wxGTK_CONV( tool->GetLabel() ),
 450                                   tool->GetShortHelp().empty()
 451                                     ? NULL
 452                                     : (const char*) wxGTK_CONV( tool->GetShortHelp() ),
 453                                   "", // tooltip_private_text (?)
 454                                   tool->m_pixmap,
 455                                   (GtkSignalFunc)gtk_toolbar_callback,
 456                                   (gpointer)tool,
 457                                   posGtk
 458                                );
 459
 460                 if ( !tool->m_item )
 461                 {
 462                     wxFAIL_MSG( _T("gtk_toolbar_insert_element() failed") );
 463
 464                     return false;
 465                 }
 466
 467                 g_signal_connect (tool->m_item, "enter_notify_event",
 468                                   G_CALLBACK (gtk_toolbar_tool_callback),
 469                                   tool);
 470                 g_signal_connect (tool->m_item, "leave_notify_event",
 471                                   G_CALLBACK (gtk_toolbar_tool_callback),
 472                                   tool);
 473             }
 474             break;
 475
 476         case wxTOOL_STYLE_SEPARATOR:
 477             gtk_toolbar_insert_space( m_toolbar, posGtk );
 478
 479             // skip the rest
 480             return true;
 481
 482         case wxTOOL_STYLE_CONTROL:
 483             gtk_toolbar_insert_widget(
 484                                        m_toolbar,
 485                                        tool->GetControl()->m_widget,
 486                                        (const char *) NULL,
 487                                        (const char *) NULL,
 488                                        posGtk
 489                                       );
 490             break;
 491     }
 492
 493     GtkRequisition req;
 494     (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget) )->size_request )
 495         (m_widget, &req );
 496     m_width = req.width + m_xMargin;
 497     m_height = req.height + 2*m_yMargin;
 498     InvalidateBestSize();
 499
 500     return true;
 501 }
 502
 503 bool wxToolBar::DoDeleteTool(size_t pos, wxToolBarToolBase *toolBase)
 504 {
 505     wxToolBarTool *tool = (wxToolBarTool *)toolBase;
 506
 507     switch ( tool->GetStyle() )
 508     {
 509         case wxTOOL_STYLE_CONTROL:
 510             tool->GetControl()->Destroy();
 511             break;
 512
 513         case wxTOOL_STYLE_BUTTON:
 514             gtk_widget_destroy( tool->m_item );
 515             break;
 516
 517         case wxTOOL_STYLE_SEPARATOR:
 518             gtk_toolbar_remove_space( m_toolbar, pos );
 519             break;
 520     }
 521
 522     InvalidateBestSize();
 523     return true;
 524 }
 525
 526 // ----------------------------------------------------------------------------
 527 // wxToolBar tools state
 528 // ----------------------------------------------------------------------------
 529
 530 void wxToolBar::DoEnableTool(wxToolBarToolBase *toolBase, bool enable)
 531 {
 532     wxToolBarTool *tool = (wxToolBarTool *)toolBase;
 533
 534     if (tool->m_item)
 535     {
 536         gtk_widget_set_sensitive( tool->m_item, enable );
 537     }
 538 }
 539
 540 void wxToolBar::DoToggleTool( wxToolBarToolBase *toolBase, bool toggle )
 541 {
 542     wxToolBarTool *tool = (wxToolBarTool *)toolBase;
 543
 544     GtkWidget *item = tool->m_item;
 545     if ( item && GTK_IS_TOGGLE_BUTTON(item) )
 546     {
 547         tool->SetPixmap(tool->GetBitmap());
 548
 549         m_blockEvent = true;
 550
 551         gtk_toggle_button_set_active( GTK_TOGGLE_BUTTON(item), toggle );
 552
 553         m_blockEvent = false;
 554     }
 555 }
 556
 557 void wxToolBar::DoSetToggle(wxToolBarToolBase * WXUNUSED(tool),
 558                             bool WXUNUSED(toggle))
 559 {
 560     // VZ: absolutely no idea about how to do it
 561     wxFAIL_MSG( _T("not implemented") );
 562 }
 563
 564 // ----------------------------------------------------------------------------
 565 // wxToolBar geometry
 566 // ----------------------------------------------------------------------------
 567
 568 wxToolBarToolBase *wxToolBar::FindToolForPosition(wxCoord WXUNUSED(x),
 569                                                   wxCoord WXUNUSED(y)) const
 570 {
 571     // VZ: GTK+ doesn't seem to have such thing
 572     wxFAIL_MSG( _T("wxToolBar::FindToolForPosition() not implemented") );
 573
 574     return (wxToolBarToolBase *)NULL;
 575 }
 576
 577 void wxToolBar::SetMargins( int x, int y )
 578 {
 579     wxCHECK_RET( GetToolsCount() == 0,
 580                  wxT("wxToolBar::SetMargins must be called before adding tools.") );
 581
 582     m_xMargin = x;
 583     m_yMargin = y;
 584 }
 585
 586 void wxToolBar::SetToolSeparation( int separation )
 587 {
 588     // FIXME: this function disappeared
 589 #if 0
 590     gtk_toolbar_set_space_size( m_toolbar, separation );
 591 #endif
 592
 593     m_toolSeparation = separation;
 594 }
 595
 596 void wxToolBar::SetToolShortHelp( int id, const wxString& helpString )
 597 {
 598     wxToolBarTool *tool = (wxToolBarTool *)FindById(id);
 599
 600     if ( tool )
 601     {
 602         (void)tool->SetShortHelp(helpString);
 603         gtk_tooltips_set_tip(m_toolbar->tooltips, tool->m_item,
 604                              wxGTK_CONV( helpString ), "");
 605     }
 606 }
 607
 608 // ----------------------------------------------------------------------------
 609 // wxToolBar idle handling
 610 // ----------------------------------------------------------------------------
 611
 612 void wxToolBar::OnInternalIdle()
 613 {
 614     // Check if we have to show window now
 615     if (GtkShowFromOnIdle()) return;
 616
 617     wxCursor cursor = m_cursor;
 618     if (g_globalCursor.Ok()) cursor = g_globalCursor;
 619
 620     if (cursor.Ok())
 621     {
 622         /* I now set the cursor the anew in every OnInternalIdle call
 623            as setting the cursor in a parent window also effects the
 624            windows above so that checking for the current cursor is
 625            not possible. */
 626
 627         if (HasFlag(wxTB_DOCKABLE) && (m_widget->window))
 628         {
 629             /* if the toolbar is dockable, then m_widget stands for the
 630                GtkHandleBox widget, which uses its own window so that we
 631                can set the cursor for it. if the toolbar is not dockable,
 632                m_widget comes from m_toolbar which uses its parent's
 633                window ("windowless windows") and thus we cannot set the
 634                cursor. */
 635             gdk_window_set_cursor( m_widget->window, cursor.GetCursor() );
 636         }
 637
 638         wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
 639         while ( node )
 640         {
 641             wxToolBarTool *tool = (wxToolBarTool *)node->GetData();
 642             node = node->GetNext();
 643
 644             GtkWidget *item = tool->m_item;
 645             if ( item )
 646             {
 647                 GdkWindow *window = item->window;
 648
 649                 if ( window )
 650                 {
 651                     gdk_window_set_cursor( window, cursor.GetCursor() );
 652                 }
 653             }
 654         }
 655     }
 656
 657     if (wxUpdateUIEvent::CanUpdate(this))
 658         UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
 659 }
 660
 661
 662 // ----------------------------------------------------------------------------
 663
 664 // static
 665 wxVisualAttributes
 666 wxToolBar::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 667 {
 668     return GetDefaultAttributesFromGTKWidget(gtk_toolbar_new);
 669 }
 670
 671 #endif // wxUSE_TOOLBAR_NATIVE