1 ///////////////////////////////////////////////////////////////////////////// 
   3 // Purpose:     GTK toolbar 
   4 // Author:      Robert Roebling 
   5 // Modified:    13.12.99 by VZ to derive from wxToolBarBase 
   7 // Copyright:   (c) Robert Roebling 
   8 // Licence:     wxWindows licence 
   9 ///////////////////////////////////////////////////////////////////////////// 
  11 // ============================================================================ 
  13 // ============================================================================ 
  15 // ---------------------------------------------------------------------------- 
  17 // ---------------------------------------------------------------------------- 
  19 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) 
  20     #pragma implementation "tbargtk.h" 
  23 // For compilers that support precompilation, includes "wx.h". 
  24 #include "wx/wxprec.h" 
  26 #include "wx/toolbar.h" 
  28 #if wxUSE_TOOLBAR_NATIVE 
  33 #include "wx/gtk/private.h" 
  35 extern GdkFont 
*GtkGetDefaultGuiFont(); 
  37 // ---------------------------------------------------------------------------- 
  39 // ---------------------------------------------------------------------------- 
  42 extern void wxapp_install_idle_handler(); 
  46 extern bool       g_blockEventsOnDrag
; 
  47 extern wxCursor   g_globalCursor
; 
  49 // ---------------------------------------------------------------------------- 
  51 // ---------------------------------------------------------------------------- 
  53 // translate wxWidgets toolbar style flags to GTK orientation and style 
  54 static void GetGtkStyle(long style
, 
  55                         GtkOrientation 
*orient
, GtkToolbarStyle 
*gtkStyle
) 
  57     *orient 
= style 
& wxTB_VERTICAL 
? GTK_ORIENTATION_VERTICAL
 
  58                                     : GTK_ORIENTATION_HORIZONTAL
; 
  61     if ( style 
& wxTB_TEXT 
) 
  63         *gtkStyle 
= style 
& wxTB_NOICONS
 
  67                           style 
& wxTB_HORZ_LAYOUT 
? GTK_TOOLBAR_BOTH_HORIZ 
: 
  71     else // no text, hence we must have the icons or what would we show? 
  73         *gtkStyle 
= GTK_TOOLBAR_ICONS
; 
  77 // ---------------------------------------------------------------------------- 
  79 // ---------------------------------------------------------------------------- 
  81 class wxToolBarTool 
: public wxToolBarToolBase
 
  84     wxToolBarTool(wxToolBar 
*tbar
, 
  86                   const wxString
& label
, 
  87                   const wxBitmap
& bitmap1
, 
  88                   const wxBitmap
& bitmap2
, 
  91                   const wxString
& shortHelpString
, 
  92                   const wxString
& longHelpString
) 
  93         : wxToolBarToolBase(tbar
, id
, label
, bitmap1
, bitmap2
, kind
, 
  94                             clientData
, shortHelpString
, longHelpString
) 
  99     wxToolBarTool(wxToolBar 
*tbar
, wxControl 
*control
) 
 100         : wxToolBarToolBase(tbar
, control
) 
 105     // is this a radio button? 
 107     // unlike GetKind(), can be called for any kind of tools, not just buttons 
 108     bool IsRadio() const { return IsButton() && GetKind() == wxITEM_RADIO
; } 
 110     // this is only called for the normal buttons, i.e. not separators nor 
 112     GtkToolbarChildType 
GetGtkChildType() const 
 117                 return GTK_TOOLBAR_CHILD_TOGGLEBUTTON
; 
 120                 return GTK_TOOLBAR_CHILD_RADIOBUTTON
; 
 123                 wxFAIL_MSG( _T("unknown toolbar child type") ); 
 127                 return GTK_TOOLBAR_CHILD_BUTTON
; 
 131     void SetPixmap(const wxBitmap
& bitmap
) 
 135             GdkBitmap 
*mask 
= bitmap
.GetMask() ? bitmap
.GetMask()->GetBitmap() 
 138             if (bitmap
.HasPixbuf()) 
 139                 gtk_image_set_from_pixbuf(GTK_IMAGE(m_pixmap
), 
 142                 gtk_image_set_from_pixmap(GTK_IMAGE(m_pixmap
), 
 143                                           bitmap
.GetPixmap(), mask
); 
 145             gtk_pixmap_set(GTK_PIXMAP(m_pixmap
), bitmap
.GetPixmap(), mask
); 
 146 #endif // !__WXGTK20__ 
 157 // ---------------------------------------------------------------------------- 
 159 // ---------------------------------------------------------------------------- 
 161 IMPLEMENT_DYNAMIC_CLASS(wxToolBar
, wxControl
) 
 163 // ============================================================================ 
 165 // ============================================================================ 
 167 //----------------------------------------------------------------------------- 
 168 // "clicked" (internal from gtk_toolbar) 
 169 //----------------------------------------------------------------------------- 
 171 static void gtk_toolbar_callback( GtkWidget 
*WXUNUSED(widget
), 
 172                                   wxToolBarTool 
*tool 
) 
 175         wxapp_install_idle_handler(); 
 177     wxToolBar 
*tbar 
= (wxToolBar 
*)tool
->GetToolBar(); 
 179     if (tbar
->m_blockEvent
) return; 
 181     if (g_blockEventsOnDrag
) return; 
 182     if (!tool
->IsEnabled()) return; 
 184     if (tool
->CanBeToggled()) 
 188         tool
->SetPixmap(tool
->GetBitmap()); 
 190         if ( tool
->IsRadio() && !tool
->IsToggled() ) 
 192             // radio button went up, don't report this as a wxWin event 
 197     if( !tbar
->OnLeftClick( tool
->GetId(), tool
->IsToggled() ) && tool
->CanBeToggled() ) 
 202         tool
->SetPixmap(tool
->GetBitmap()); 
 206 //----------------------------------------------------------------------------- 
 207 // "enter_notify_event" / "leave_notify_event" 
 208 //----------------------------------------------------------------------------- 
 210 static gint 
gtk_toolbar_tool_callback( GtkWidget 
*WXUNUSED(widget
), 
 211                                        GdkEventCrossing 
*gdk_event
, 
 212                                        wxToolBarTool 
*tool 
) 
 214     if (g_isIdle
) wxapp_install_idle_handler(); 
 216     if (g_blockEventsOnDrag
) return TRUE
; 
 218     wxToolBar 
*tb 
= (wxToolBar 
*)tool
->GetToolBar(); 
 221     if( gdk_event
->type 
== GDK_ENTER_NOTIFY 
) 
 222         tb
->OnMouseEnter( tool
->GetId() ); 
 224         tb
->OnMouseEnter( -1 ); 
 229 //----------------------------------------------------------------------------- 
 230 // InsertChild callback for wxToolBar 
 231 //----------------------------------------------------------------------------- 
 233 static void wxInsertChildInToolBar( wxToolBar
* WXUNUSED(parent
), 
 234                                     wxWindow
* WXUNUSED(child
) ) 
 236     // we don't do anything here 
 239 // ---------------------------------------------------------------------------- 
 241 // ---------------------------------------------------------------------------- 
 243 void wxToolBarTool::Init() 
 246     m_pixmap 
= (GtkWidget 
*)NULL
; 
 249 wxToolBarToolBase 
*wxToolBar::CreateTool(int id
, 
 250                                          const wxString
& text
, 
 251                                          const wxBitmap
& bitmap1
, 
 252                                          const wxBitmap
& bitmap2
, 
 254                                          wxObject 
*clientData
, 
 255                                          const wxString
& shortHelpString
, 
 256                                          const wxString
& longHelpString
) 
 258     return new wxToolBarTool(this, id
, text
, bitmap1
, bitmap2
, kind
, 
 259                              clientData
, shortHelpString
, longHelpString
); 
 262 wxToolBarToolBase 
*wxToolBar::CreateTool(wxControl 
*control
) 
 264     return new wxToolBarTool(this, control
); 
 267 //----------------------------------------------------------------------------- 
 268 // wxToolBar construction 
 269 //----------------------------------------------------------------------------- 
 271 void wxToolBar::Init() 
 273     m_toolbar 
= (GtkToolbar 
*)NULL
; 
 274     m_blockEvent 
= FALSE
; 
 276     m_defaultHeight 
= 32; 
 279 wxToolBar::~wxToolBar() 
 283 bool wxToolBar::Create( wxWindow 
*parent
, 
 288                         const wxString
& name 
) 
 291     m_insertCallback 
= (wxInsertChildFunction
)wxInsertChildInToolBar
; 
 293     if ( !PreCreation( parent
, pos
, size 
) || 
 294          !CreateBase( parent
, id
, pos
, size
, style
, wxDefaultValidator
, name 
)) 
 296         wxFAIL_MSG( wxT("wxToolBar creation failed") ); 
 302     m_toolbar 
= GTK_TOOLBAR( gtk_toolbar_new() ); 
 305     // Doesn't work this way. 
 306     // GtkToolbarSpaceStyle space_style = GTK_TOOLBAR_SPACE_EMPTY; 
 307     // gtk_widget_style_set (GTK_WIDGET (m_toolbar), "space_style", &space_style, NULL); 
 309     GtkOrientation orient
; 
 310     GtkToolbarStyle gtkStyle
; 
 311     GetGtkStyle(style
, &orient
, >kStyle
); 
 313     m_toolbar 
= GTK_TOOLBAR( gtk_toolbar_new(orient
, gtkStyle
) ); 
 316     SetToolSeparation(7); 
 318     if (style 
& wxTB_DOCKABLE
) 
 320         m_widget 
= gtk_handle_box_new(); 
 321         gtk_container_add( GTK_CONTAINER(m_widget
), GTK_WIDGET(m_toolbar
) ); 
 322         gtk_widget_show( GTK_WIDGET(m_toolbar
) ); 
 324         if (style 
& wxTB_FLAT
) 
 325             gtk_handle_box_set_shadow_type( GTK_HANDLE_BOX(m_widget
), GTK_SHADOW_NONE 
); 
 329         m_widget 
= gtk_event_box_new(); 
 330         gtk_container_add( GTK_CONTAINER(m_widget
), GTK_WIDGET(m_toolbar
) ); 
 331         ConnectWidget( m_widget 
); 
 332         gtk_widget_show(GTK_WIDGET(m_toolbar
)); 
 335     gtk_toolbar_set_tooltips( GTK_TOOLBAR(m_toolbar
), TRUE 
); 
 337     // FIXME: there is no such function for toolbars in 2.0 
 339     if (style 
& wxTB_FLAT
) 
 340         gtk_toolbar_set_button_relief( GTK_TOOLBAR(m_toolbar
), GTK_RELIEF_NONE 
); 
 343     m_parent
->DoAddChild( this ); 
 350 void wxToolBar::GtkSetStyle() 
 352     GtkOrientation orient
; 
 353     GtkToolbarStyle style
; 
 354     GetGtkStyle(GetWindowStyle(), &orient
, &style
); 
 356     gtk_toolbar_set_orientation(m_toolbar
, orient
); 
 357     gtk_toolbar_set_style(m_toolbar
, style
); 
 360 void wxToolBar::SetWindowStyleFlag( long style 
) 
 362     wxToolBarBase::SetWindowStyleFlag(style
); 
 368 bool wxToolBar::DoInsertTool(size_t pos
, wxToolBarToolBase 
*toolBase
) 
 370     wxToolBarTool 
*tool 
= (wxToolBarTool 
*)toolBase
; 
 373     // if we have inserted a space before all the tools we must change the GTK 
 375     size_t posGtk 
= m_xMargin 
> 1 ? pos 
+ 1 : pos
; 
 380     if ( tool
->IsButton() ) 
 382         if ( !HasFlag(wxTB_NOICONS
) ) 
 384             wxBitmap bitmap 
= tool
->GetNormalBitmap(); 
 386             wxCHECK_MSG( bitmap
.Ok(), FALSE
, 
 387                          wxT("invalid bitmap for wxToolBar icon") ); 
 389             wxCHECK_MSG( bitmap
.GetBitmap() == NULL
, FALSE
, 
 390                          wxT("wxToolBar doesn't support GdkBitmap") ); 
 392             wxCHECK_MSG( bitmap
.GetPixmap() != NULL
, FALSE
, 
 393                          wxT("wxToolBar::Add needs a wxBitmap") ); 
 395             GtkWidget 
*tool_pixmap 
= (GtkWidget 
*)NULL
; 
 399             tool_pixmap 
= gtk_image_new(); 
 400             tool
->m_pixmap 
= tool_pixmap
; 
 401             tool
->SetPixmap(bitmap
); 
 403             GdkPixmap 
*pixmap 
= bitmap
.GetPixmap(); 
 405             GdkBitmap 
*mask 
= (GdkBitmap 
*)NULL
; 
 406             if ( bitmap
.GetMask() ) 
 407               mask 
= bitmap
.GetMask()->GetBitmap(); 
 409             tool_pixmap 
= gtk_pixmap_new( pixmap
, mask 
); 
 410             gtk_pixmap_set_build_insensitive( GTK_PIXMAP(tool_pixmap
), TRUE 
); 
 413             gtk_misc_set_alignment( GTK_MISC(tool_pixmap
), 0.5, 0.5 ); 
 415             tool
->m_pixmap 
= tool_pixmap
; 
 419     switch ( tool
->GetStyle() ) 
 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 
 426                 GtkWidget 
*widget 
= NULL
; 
 428                 if ( tool
->IsRadio() ) 
 430                     wxToolBarToolsList::compatibility_iterator node
 
 431                         = wxToolBarToolsList::compatibility_iterator(); 
 432                     if ( pos 
) node 
= m_tools
.Item(pos 
- 1); 
 436                         wxToolBarTool 
*tool 
= (wxToolBarTool 
*)node
->GetData(); 
 437                         if ( !tool
->IsRadio() ) 
 440                         widget 
= tool
->m_item
; 
 442                         node 
= node
->GetPrevious(); 
 447                         // this is the first button in the radio button group, 
 448                         // it will be toggled automatically by GTK so bring the 
 449                         // internal flag in sync 
 454                 tool
->m_item 
= gtk_toolbar_insert_element
 
 457                                   tool
->GetGtkChildType(), 
 459                                   tool
->GetLabel().empty() 
 461                                     : (const char*) wxGTK_CONV( tool
->GetLabel() ), 
 462                                   tool
->GetShortHelp().empty() 
 464                                     : (const char*) wxGTK_CONV( tool
->GetShortHelp() ), 
 465                                   "", // tooltip_private_text (?) 
 467                                   (GtkSignalFunc
)gtk_toolbar_callback
, 
 474                     wxFAIL_MSG( _T("gtk_toolbar_insert_element() failed") ); 
 479                 gtk_signal_connect( GTK_OBJECT(tool
->m_item
), 
 480                                     "enter_notify_event", 
 481                                     GTK_SIGNAL_FUNC(gtk_toolbar_tool_callback
), 
 483                 gtk_signal_connect( GTK_OBJECT(tool
->m_item
), 
 484                                     "leave_notify_event", 
 485                                     GTK_SIGNAL_FUNC(gtk_toolbar_tool_callback
), 
 490         case wxTOOL_STYLE_SEPARATOR
: 
 491             gtk_toolbar_insert_space( m_toolbar
, posGtk 
); 
 496         case wxTOOL_STYLE_CONTROL
: 
 497             gtk_toolbar_insert_widget( 
 499                                        tool
->GetControl()->m_widget
, 
 508     (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget
) )->size_request 
) 
 510     m_width 
= req
.width 
+ m_xMargin
; 
 511     m_height 
= req
.height 
+ 2*m_yMargin
; 
 512     InvalidateBestSize(); 
 517 bool wxToolBar::DoDeleteTool(size_t WXUNUSED(pos
), wxToolBarToolBase 
*toolBase
) 
 519     wxToolBarTool 
*tool 
= (wxToolBarTool 
*)toolBase
; 
 521     switch ( tool
->GetStyle() ) 
 523         case wxTOOL_STYLE_CONTROL
: 
 524             tool
->GetControl()->Destroy(); 
 527         case wxTOOL_STYLE_BUTTON
: 
 528             gtk_widget_destroy( tool
->m_item 
); 
 531         //case wxTOOL_STYLE_SEPARATOR: -- nothing to do 
 534     InvalidateBestSize(); 
 538 // ---------------------------------------------------------------------------- 
 539 // wxToolBar tools state 
 540 // ---------------------------------------------------------------------------- 
 542 void wxToolBar::DoEnableTool(wxToolBarToolBase 
*toolBase
, bool enable
) 
 544     wxToolBarTool 
*tool 
= (wxToolBarTool 
*)toolBase
; 
 548         gtk_widget_set_sensitive( tool
->m_item
, enable 
); 
 552 void wxToolBar::DoToggleTool( wxToolBarToolBase 
*toolBase
, bool toggle 
) 
 554     wxToolBarTool 
*tool 
= (wxToolBarTool 
*)toolBase
; 
 556     GtkWidget 
*item 
= tool
->m_item
; 
 557     if ( item 
&& GTK_IS_TOGGLE_BUTTON(item
) ) 
 559         tool
->SetPixmap(tool
->GetBitmap()); 
 563         gtk_toggle_button_set_state( GTK_TOGGLE_BUTTON(item
), toggle 
); 
 565         m_blockEvent 
= FALSE
; 
 569 void wxToolBar::DoSetToggle(wxToolBarToolBase 
* WXUNUSED(tool
), 
 570                             bool WXUNUSED(toggle
)) 
 572     // VZ: absolutely no idea about how to do it 
 573     wxFAIL_MSG( _T("not implemented") ); 
 576 // ---------------------------------------------------------------------------- 
 577 // wxToolBar geometry 
 578 // ---------------------------------------------------------------------------- 
 580 wxToolBarToolBase 
*wxToolBar::FindToolForPosition(wxCoord 
WXUNUSED(x
), 
 581                                                   wxCoord 
WXUNUSED(y
)) const 
 583     // VZ: GTK+ doesn't seem to have such thing 
 584     wxFAIL_MSG( _T("wxToolBar::FindToolForPosition() not implemented") ); 
 586     return (wxToolBarToolBase 
*)NULL
; 
 589 void wxToolBar::SetMargins( int x
, int y 
) 
 591     wxCHECK_RET( GetToolsCount() == 0, 
 592                  wxT("wxToolBar::SetMargins must be called before adding tools.") ); 
 596         gtk_toolbar_append_space( m_toolbar 
);  // oh well 
 603 void wxToolBar::SetToolSeparation( int separation 
) 
 605     // FIXME: this function disappeared 
 607     gtk_toolbar_set_space_size( m_toolbar
, separation 
); 
 610     m_toolSeparation 
= separation
; 
 613 void wxToolBar::SetToolShortHelp( int id
, const wxString
& helpString 
) 
 615     wxToolBarTool 
*tool 
= (wxToolBarTool 
*)FindById(id
); 
 619         (void)tool
->SetShortHelp(helpString
); 
 620         gtk_tooltips_set_tip(m_toolbar
->tooltips
, tool
->m_item
, 
 621                              wxGTK_CONV( helpString 
), ""); 
 625 // ---------------------------------------------------------------------------- 
 626 // wxToolBar idle handling 
 627 // ---------------------------------------------------------------------------- 
 629 void wxToolBar::OnInternalIdle() 
 631     wxCursor cursor 
= m_cursor
; 
 632     if (g_globalCursor
.Ok()) cursor 
= g_globalCursor
; 
 636         /* I now set the cursor the anew in every OnInternalIdle call 
 637            as setting the cursor in a parent window also effects the 
 638            windows above so that checking for the current cursor is 
 641         if (HasFlag(wxTB_DOCKABLE
) && (m_widget
->window
)) 
 643             /* if the toolbar is dockable, then m_widget stands for the 
 644                GtkHandleBox widget, which uses its own window so that we 
 645                can set the cursor for it. if the toolbar is not dockable, 
 646                m_widget comes from m_toolbar which uses its parent's 
 647                window ("windowless windows") and thus we cannot set the 
 649             gdk_window_set_cursor( m_widget
->window
, cursor
.GetCursor() ); 
 652         wxToolBarToolsList::compatibility_iterator node 
= m_tools
.GetFirst(); 
 655             wxToolBarTool 
*tool 
= (wxToolBarTool 
*)node
->GetData(); 
 656             node 
= node
->GetNext(); 
 658             GtkWidget 
*item 
= tool
->m_item
; 
 661                 GdkWindow 
*window 
= item
->window
; 
 665                     gdk_window_set_cursor( window
, cursor
.GetCursor() ); 
 671     if (wxUpdateUIEvent::CanUpdate(this)) 
 672         UpdateWindowUI(wxUPDATE_UI_FROMIDLE
); 
 676 // ---------------------------------------------------------------------------- 
 680 wxToolBar::GetClassDefaultAttributes(wxWindowVariant 
WXUNUSED(variant
)) 
 683     return GetDefaultAttributesFromGTKWidget(gtk_toolbar_new
); 
 685     wxVisualAttributes attr
; 
 686     GtkWidget
* widget 
= gtk_toolbar_new(GTK_ORIENTATION_HORIZONTAL
, GTK_TOOLBAR_BOTH
); 
 687     attr 
= GetDefaultAttributesFromGTKWidget(widget
); 
 688     gtk_widget_destroy(widget
); 
 693 #endif // wxUSE_TOOLBAR_NATIVE