src/gtk1/tbargtk.cpp

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