src/gtk/tbargtk.cpp

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