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
7 // Copyright: (c) Robert Roebling
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
11 // ============================================================================
13 // ============================================================================
15 // ----------------------------------------------------------------------------
17 // ----------------------------------------------------------------------------
19 // For compilers that support precompilation, includes "wx.h".
20 #include "wx/wxprec.h"
22 #if wxUSE_TOOLBAR_NATIVE
24 #include "wx/toolbar.h"
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
37 #include "wx/gtk/private.h"
42 static const char *arrow_down_xpm
[] = {
43 /* columns rows colors chars-per-pixel */
58 // ----------------------------------------------------------------------------
60 // ----------------------------------------------------------------------------
63 extern bool g_blockEventsOnDrag
;
64 extern wxCursor g_globalCursor
;
66 // ----------------------------------------------------------------------------
68 // ----------------------------------------------------------------------------
70 // translate wxWidgets toolbar style flags to GTK orientation and style
71 static void GetGtkStyle(long style
,
72 GtkOrientation
*orient
, GtkToolbarStyle
*gtkStyle
)
74 *orient
= ( style
& wxTB_LEFT
|| style
& wxTB_RIGHT
) ? GTK_ORIENTATION_VERTICAL
: GTK_ORIENTATION_HORIZONTAL
;
77 if ( style
& wxTB_TEXT
)
79 *gtkStyle
= style
& wxTB_NOICONS
82 style
& wxTB_HORZ_LAYOUT
? GTK_TOOLBAR_BOTH_HORIZ
:
85 else // no text, hence we must have the icons or what would we show?
87 *gtkStyle
= GTK_TOOLBAR_ICONS
;
91 // ----------------------------------------------------------------------------
93 // ----------------------------------------------------------------------------
95 class wxToolBarTool
: public wxToolBarToolBase
98 wxToolBarTool(wxToolBar
*tbar
,
100 const wxString
& label
,
101 const wxBitmap
& bitmap1
,
102 const wxBitmap
& bitmap2
,
104 wxObject
*clientData
,
105 const wxString
& shortHelpString
,
106 const wxString
& longHelpString
)
107 : wxToolBarToolBase(tbar
, id
, label
, bitmap1
, bitmap2
, kind
,
108 clientData
, shortHelpString
, longHelpString
)
113 wxToolBarTool(wxToolBar
*tbar
, wxControl
*control
, const wxString
& label
)
114 : wxToolBarToolBase(tbar
, control
, label
)
119 // is this a radio button?
121 // unlike GetKind(), can be called for any kind of tools, not just buttons
122 bool IsRadio() const { return IsButton() && GetKind() == wxITEM_RADIO
; }
124 // this is only called for the normal buttons, i.e. not separators nor
126 GtkToolbarChildType
GetGtkChildType() const
131 return GTK_TOOLBAR_CHILD_TOGGLEBUTTON
;
134 return GTK_TOOLBAR_CHILD_RADIOBUTTON
;
137 wxFAIL_MSG( _T("unknown toolbar child type") );
141 return GTK_TOOLBAR_CHILD_BUTTON
;
145 void SetImage(const wxBitmap
& bitmap
)
149 // setting from pixmap doesn't seem to work right, but pixbuf works well
150 gtk_image_set_from_pixbuf((GtkImage
*)m_image
, bitmap
.GetPixbuf());
161 // ----------------------------------------------------------------------------
163 // ----------------------------------------------------------------------------
165 IMPLEMENT_DYNAMIC_CLASS(wxToolBar
, wxControl
)
167 // ============================================================================
169 // ============================================================================
171 //-----------------------------------------------------------------------------
172 // "clicked" (internal from gtk_toolbar)
173 //-----------------------------------------------------------------------------
176 static void gtk_toolbar_callback( GtkWidget
*WXUNUSED(widget
),
177 wxToolBarTool
*tool
)
179 wxToolBar
*tbar
= (wxToolBar
*)tool
->GetToolBar();
181 if (tbar
->m_blockEvent
) return;
183 if (g_blockEventsOnDrag
) return;
184 if (!tool
->IsEnabled()) return;
186 if (tool
->CanBeToggled())
188 if (tool
->IsRadio() &&
189 gtk_toggle_button_get_active( GTK_TOGGLE_BUTTON(widget
)) &&
192 // pressed an already pressed radio button
198 tool
->SetImage(tool
->GetBitmap());
200 if ( tool
->IsRadio() && !tool
->IsToggled() )
202 // radio button went up, don't report this as a wxWin event
207 if( !tbar
->OnLeftClick( tool
->GetId(), tool
->IsToggled() ) && tool
->CanBeToggled() )
212 tool
->SetImage(tool
->GetBitmap());
217 //-----------------------------------------------------------------------------
219 //-----------------------------------------------------------------------------
221 static gboolean
gtk_toolbar_tool_rclick_callback(GtkWidget
*WXUNUSED(widget
),
222 GdkEventButton
*event
,
223 wxToolBarToolBase
*tool
)
225 if (event
->button
!= 3)
228 wxToolBar
*tbar
= (wxToolBar
*)tool
->GetToolBar();
230 if (tbar
->m_blockEvent
) return TRUE
;
232 if (g_blockEventsOnDrag
) return TRUE
;
233 if (!tool
->IsEnabled()) return TRUE
;
235 tbar
->OnRightClick( tool
->GetId(), (int)event
->x
, (int)event
->y
);
241 //-----------------------------------------------------------------------------
242 // "enter_notify_event" / "leave_notify_event" from dropdown
243 //-----------------------------------------------------------------------------
246 static gint
gtk_toolbar_buddy_enter_callback( GtkWidget
*WXUNUSED(widget
),
247 GdkEventCrossing
*WXUNUSED(gdk_event
),
250 guint8 state
= GTK_WIDGET_STATE( tool
);
251 state
|= GTK_STATE_PRELIGHT
;
252 gtk_widget_set_state( tool
, (GtkStateType
) state
);
256 static gint
gtk_toolbar_buddy_leave_callback( GtkWidget
*WXUNUSED(widget
),
257 GdkEventCrossing
*WXUNUSED(gdk_event
),
260 guint8 state
= GTK_WIDGET_STATE( tool
);
261 state
&= ~GTK_STATE_PRELIGHT
;
262 gtk_widget_set_state( tool
, (GtkStateType
) state
);
267 //-----------------------------------------------------------------------------
268 // "left-click" on dropdown
269 //-----------------------------------------------------------------------------
273 static void gtk_pop_tb_hide_callback( GtkWidget
*WXUNUSED(menu
), GtkToggleButton
*button
)
275 gtk_toggle_button_set_active( button
, FALSE
);
278 static gboolean
gtk_toolbar_dropdown_lclick_callback(GtkWidget
*widget
,
279 GdkEventButton
*event
,
280 wxToolBarToolBase
*tool
)
282 if (event
->button
!= 1)
285 wxToolBar
*tbar
= (wxToolBar
*)tool
->GetToolBar();
287 if (tbar
->m_blockEvent
) return FALSE
;
289 if (g_blockEventsOnDrag
) return FALSE
;
290 if (!tool
->IsEnabled()) return FALSE
;
292 wxCommandEvent
evt(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
, tool
->GetId() );
293 if ( tbar
->GetEventHandler()->ProcessEvent(evt
) )
298 wxMenu
* const menu
= tool
->GetDropdownMenu();
303 gtk_toggle_button_set_active( GTK_TOGGLE_BUTTON(widget
), TRUE
);
305 g_signal_connect (menu
->m_menu
, "hide",
306 G_CALLBACK (gtk_pop_tb_hide_callback
),
309 tbar
->PopupMenu( menu
, widget
->allocation
.x
,
310 widget
->allocation
.y
+ widget
->allocation
.height
);
317 //-----------------------------------------------------------------------------
318 // "enter_notify_event" / "leave_notify_event"
319 //-----------------------------------------------------------------------------
322 static gint
gtk_toolbar_tool_callback( GtkWidget
*WXUNUSED(widget
),
323 GdkEventCrossing
*gdk_event
,
324 wxToolBarTool
*tool
)
326 if (g_blockEventsOnDrag
) return TRUE
;
328 wxToolBar
*tb
= (wxToolBar
*)tool
->GetToolBar();
331 if( gdk_event
->type
== GDK_ENTER_NOTIFY
)
332 tb
->OnMouseEnter( tool
->GetId() );
334 tb
->OnMouseEnter( -1 );
342 void gtktoolwidget_size_callback( GtkWidget
*widget
,
343 GtkAllocation
*alloc
,
346 // this shouldn't happen...
347 if (win
->GetParent()->m_wxwindow
) return;
349 wxSize size
= win
->GetEffectiveMinSize();
350 if (size
.y
!= alloc
->height
)
352 GtkAllocation alloc2
;
354 alloc2
.y
= (alloc
->height
- size
.y
+ 3) / 2;
355 alloc2
.width
= alloc
->width
;
356 alloc2
.height
= size
.y
;
357 gtk_widget_size_allocate( widget
, &alloc2
);
361 //-----------------------------------------------------------------------------
362 // InsertChild callback for wxToolBar
363 //-----------------------------------------------------------------------------
365 static void wxInsertChildInToolBar( wxWindow
* WXUNUSED(parent
),
366 wxWindow
* WXUNUSED(child
) )
368 // we don't do anything here
371 // ----------------------------------------------------------------------------
373 // ----------------------------------------------------------------------------
375 void wxToolBarTool::Init()
381 wxToolBarToolBase
*wxToolBar::CreateTool(int id
,
382 const wxString
& text
,
383 const wxBitmap
& bitmap1
,
384 const wxBitmap
& bitmap2
,
386 wxObject
*clientData
,
387 const wxString
& shortHelpString
,
388 const wxString
& longHelpString
)
390 return new wxToolBarTool(this, id
, text
, bitmap1
, bitmap2
, kind
,
391 clientData
, shortHelpString
, longHelpString
);
395 wxToolBar::CreateTool(wxControl
*control
, const wxString
& label
)
397 return new wxToolBarTool(this, control
, label
);
400 //-----------------------------------------------------------------------------
401 // wxToolBar construction
402 //-----------------------------------------------------------------------------
404 void wxToolBar::Init()
406 m_toolbar
= (GtkToolbar
*)NULL
;
407 m_blockEvent
= false;
409 m_defaultHeight
= 32;
412 wxToolBar::~wxToolBar()
416 bool wxToolBar::Create( wxWindow
*parent
,
421 const wxString
& name
)
423 m_insertCallback
= wxInsertChildInToolBar
;
425 if ( !PreCreation( parent
, pos
, size
) ||
426 !CreateBase( parent
, id
, pos
, size
, style
, wxDefaultValidator
, name
))
428 wxFAIL_MSG( wxT("wxToolBar creation failed") );
435 m_toolbar
= GTK_TOOLBAR( gtk_toolbar_new() );
438 // Doesn't work this way.
439 // GtkToolbarSpaceStyle space_style = GTK_TOOLBAR_SPACE_EMPTY;
440 // gtk_widget_style_set (GTK_WIDGET (m_toolbar), "space_style", &space_style, NULL);
442 SetToolSeparation(7);
444 if (style
& wxTB_DOCKABLE
)
446 m_widget
= gtk_handle_box_new();
447 gtk_container_add( GTK_CONTAINER(m_widget
), GTK_WIDGET(m_toolbar
) );
448 gtk_widget_show( GTK_WIDGET(m_toolbar
) );
450 if (style
& wxTB_FLAT
)
451 gtk_handle_box_set_shadow_type( GTK_HANDLE_BOX(m_widget
), GTK_SHADOW_NONE
);
455 m_widget
= gtk_event_box_new();
456 gtk_container_add( GTK_CONTAINER(m_widget
), GTK_WIDGET(m_toolbar
) );
457 ConnectWidget( m_widget
);
458 gtk_widget_show(GTK_WIDGET(m_toolbar
));
461 // FIXME: there is no such function for toolbars in 2.0
463 if (style
& wxTB_FLAT
)
464 gtk_toolbar_set_button_relief( GTK_TOOLBAR(m_toolbar
), GTK_RELIEF_NONE
);
467 m_parent
->DoAddChild( this );
474 GdkWindow
*wxToolBar::GTKGetWindow(wxArrayGdkWindows
& windows
) const
476 return GTK_WIDGET(m_toolbar
)->window
;
479 void wxToolBar::GtkSetStyle()
481 GtkOrientation orient
;
482 GtkToolbarStyle style
;
483 GetGtkStyle(GetWindowStyle(), &orient
, &style
);
485 gtk_toolbar_set_orientation(m_toolbar
, orient
);
486 gtk_toolbar_set_style(m_toolbar
, style
);
487 gtk_toolbar_set_tooltips(m_toolbar
, !(style
& wxTB_NO_TOOLTIPS
));
490 void wxToolBar::SetWindowStyleFlag( long style
)
492 wxToolBarBase::SetWindowStyleFlag(style
);
498 bool wxToolBar::DoInsertTool(size_t pos
, wxToolBarToolBase
*toolBase
)
500 wxToolBarTool
* tool
= wx_static_cast(wxToolBarTool
*, toolBase
);
502 if ( tool
->IsButton() )
504 if ( !HasFlag(wxTB_NOICONS
) )
506 wxBitmap bitmap
= tool
->GetNormalBitmap();
508 wxCHECK_MSG( bitmap
.Ok(), false,
509 wxT("invalid bitmap for wxToolBar icon") );
511 tool
->m_image
= gtk_image_new();
512 tool
->SetImage(bitmap
);
514 gtk_misc_set_alignment((GtkMisc
*)tool
->m_image
, 0.5, 0.5);
522 for (i
= 0; i
< pos
; i
++)
527 // if we have a dropdown menu, we use 2 GTK tools
529 wxToolBarToolsList::compatibility_iterator node
= m_tools
.Item( i
);
530 wxToolBarTool
*tool
= (wxToolBarTool
*) node
->GetData();
531 if (tool
->IsButton() && (tool
->GetKind() == wxITEM_DROPDOWN
))
537 switch ( tool
->GetStyle() )
539 case wxTOOL_STYLE_BUTTON
:
540 // for a radio button we need the widget which starts the radio
541 // group it belongs to, i.e. the first radio button immediately
542 // preceding this one
544 GtkWidget
*widget
= NULL
;
546 if ( tool
->IsRadio() )
548 wxToolBarToolsList::compatibility_iterator node
549 = wxToolBarToolsList::compatibility_iterator();
551 node
= m_tools
.Item(pos
- 1);
555 wxToolBarTool
*toolNext
= (wxToolBarTool
*)node
->GetData();
556 if ( !toolNext
->IsRadio() )
559 widget
= toolNext
->m_item
;
561 node
= node
->GetPrevious();
566 // this is the first button in the radio button group,
567 // it will be toggled automatically by GTK so bring the
568 // internal flag in sync
573 tool
->m_item
= gtk_toolbar_insert_element
576 tool
->GetGtkChildType(),
578 tool
->GetLabel().empty()
580 : (const char*) wxGTK_CONV( tool
->GetLabel() ),
581 tool
->GetShortHelp().empty()
583 : (const char*) wxGTK_CONV( tool
->GetShortHelp() ),
584 "", // tooltip_private_text (?)
586 (GtkSignalFunc
)gtk_toolbar_callback
,
591 wxCHECK_MSG(tool
->m_item
!= NULL
, false, _T("gtk_toolbar_insert_element() failed"));
593 g_signal_connect (tool
->m_item
, "enter_notify_event",
594 G_CALLBACK (gtk_toolbar_tool_callback
),
596 g_signal_connect (tool
->m_item
, "leave_notify_event",
597 G_CALLBACK (gtk_toolbar_tool_callback
),
599 g_signal_connect(tool
->m_item
, "button-press-event",
600 G_CALLBACK (gtk_toolbar_tool_rclick_callback
),
603 if (tool
->GetKind() == wxITEM_DROPDOWN
)
605 GdkPixbuf
*pixbuf
= gdk_pixbuf_new_from_xpm_data( arrow_down_xpm
);
606 GtkWidget
*dropdown
= gtk_toggle_button_new();
607 GtkWidget
*image
= gtk_image_new_from_pixbuf( pixbuf
);
608 gtk_widget_show( image
);
609 gtk_container_add( GTK_CONTAINER(dropdown
), image
);
611 if (GetWindowStyle() & wxTB_FLAT
)
612 gtk_button_set_relief( GTK_BUTTON(dropdown
), GTK_RELIEF_NONE
);
613 GTK_WIDGET_UNSET_FLAGS (dropdown
, GTK_CAN_FOCUS
);
614 gtk_widget_show( dropdown
);
616 g_signal_connect (dropdown
, "enter_notify_event",
617 G_CALLBACK (gtk_toolbar_buddy_enter_callback
),
619 g_signal_connect (dropdown
, "leave_notify_event",
620 G_CALLBACK (gtk_toolbar_buddy_leave_callback
),
622 g_signal_connect(dropdown
, "button-press-event",
623 G_CALLBACK (gtk_toolbar_dropdown_lclick_callback
),
627 (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(tool
->m_item
) )->size_request
)
628 (tool
->m_item
, &req
);
629 gtk_widget_set_size_request( dropdown
, -1, req
.height
);
631 gtk_toolbar_insert_widget(
642 case wxTOOL_STYLE_SEPARATOR
:
643 gtk_toolbar_insert_space( m_toolbar
, posGtk
);
648 case wxTOOL_STYLE_CONTROL
:
649 gtk_toolbar_insert_widget(
651 tool
->GetControl()->m_widget
,
657 // connect after in order to correct size_allocate events
658 g_signal_connect_after (tool
->GetControl()->m_widget
, "size_allocate",
659 G_CALLBACK (gtktoolwidget_size_callback
), tool
->GetControl());
665 (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget
) )->size_request
)
667 m_width
= req
.width
+ m_xMargin
;
668 m_height
= req
.height
+ 2*m_yMargin
;
669 InvalidateBestSize();
674 bool wxToolBar::DoDeleteTool(size_t pos
, wxToolBarToolBase
*toolBase
)
676 wxToolBarTool
* tool
= wx_static_cast(wxToolBarTool
*, toolBase
);
678 switch ( tool
->GetStyle() )
680 case wxTOOL_STYLE_CONTROL
:
681 tool
->GetControl()->Destroy();
684 case wxTOOL_STYLE_BUTTON
:
685 gtk_widget_destroy( tool
->m_item
);
688 case wxTOOL_STYLE_SEPARATOR
:
689 gtk_toolbar_remove_space( m_toolbar
, pos
);
693 InvalidateBestSize();
697 // ----------------------------------------------------------------------------
698 // wxToolBar tools state
699 // ----------------------------------------------------------------------------
701 void wxToolBar::DoEnableTool(wxToolBarToolBase
*toolBase
, bool enable
)
703 wxToolBarTool
* tool
= wx_static_cast(wxToolBarTool
*, toolBase
);
707 gtk_widget_set_sensitive( tool
->m_item
, enable
);
711 void wxToolBar::DoToggleTool( wxToolBarToolBase
*toolBase
, bool toggle
)
713 wxToolBarTool
* tool
= wx_static_cast(wxToolBarTool
*, toolBase
);
715 GtkWidget
*item
= tool
->m_item
;
716 if ( item
&& GTK_IS_TOGGLE_BUTTON(item
) )
718 tool
->SetImage(tool
->GetBitmap());
722 gtk_toggle_button_set_active( GTK_TOGGLE_BUTTON(item
), toggle
);
724 m_blockEvent
= false;
728 void wxToolBar::DoSetToggle(wxToolBarToolBase
* WXUNUSED(tool
),
729 bool WXUNUSED(toggle
))
731 // VZ: absolutely no idea about how to do it
732 wxFAIL_MSG( _T("not implemented") );
735 // ----------------------------------------------------------------------------
736 // wxToolBar geometry
737 // ----------------------------------------------------------------------------
739 wxToolBarToolBase
*wxToolBar::FindToolForPosition(wxCoord
WXUNUSED(x
),
740 wxCoord
WXUNUSED(y
)) const
742 // VZ: GTK+ doesn't seem to have such thing
743 wxFAIL_MSG( _T("wxToolBar::FindToolForPosition() not implemented") );
745 return (wxToolBarToolBase
*)NULL
;
748 void wxToolBar::SetMargins( int x
, int y
)
750 wxCHECK_RET( GetToolsCount() == 0,
751 wxT("wxToolBar::SetMargins must be called before adding tools.") );
757 void wxToolBar::SetToolSeparation( int separation
)
759 // FIXME: this function disappeared
761 gtk_toolbar_set_space_size( m_toolbar
, separation
);
764 m_toolSeparation
= separation
;
767 void wxToolBar::SetToolShortHelp( int id
, const wxString
& helpString
)
769 wxToolBarTool
* tool
= wx_static_cast(wxToolBarTool
*, FindById(id
));
773 (void)tool
->SetShortHelp(helpString
);
774 gtk_tooltips_set_tip(m_toolbar
->tooltips
, tool
->m_item
,
775 wxGTK_CONV( helpString
), "");
779 void wxToolBar::SetToolNormalBitmap( int id
, const wxBitmap
& bitmap
)
781 wxToolBarTool
* tool
= wx_static_cast(wxToolBarTool
*, FindById(id
));
784 wxCHECK_RET( tool
->IsButton(), wxT("Can only set bitmap on button tools."));
786 tool
->SetNormalBitmap(bitmap
);
787 tool
->SetImage(tool
->GetBitmap());
791 void wxToolBar::SetToolDisabledBitmap( int id
, const wxBitmap
& bitmap
)
793 wxToolBarTool
* tool
= wx_static_cast(wxToolBarTool
*, FindById(id
));
796 wxCHECK_RET( tool
->IsButton(), wxT("Can only set bitmap on button tools."));
798 tool
->SetDisabledBitmap(bitmap
);
799 tool
->SetImage(tool
->GetBitmap());
803 // ----------------------------------------------------------------------------
804 // wxToolBar idle handling
805 // ----------------------------------------------------------------------------
807 void wxToolBar::OnInternalIdle()
809 // Check if we have to show window now
810 if (GtkShowFromOnIdle()) return;
812 wxCursor cursor
= m_cursor
;
813 if (g_globalCursor
.Ok()) cursor
= g_globalCursor
;
817 /* I now set the cursor the anew in every OnInternalIdle call
818 as setting the cursor in a parent window also effects the
819 windows above so that checking for the current cursor is
822 if (HasFlag(wxTB_DOCKABLE
) && (m_widget
->window
))
824 /* if the toolbar is dockable, then m_widget stands for the
825 GtkHandleBox widget, which uses its own window so that we
826 can set the cursor for it. if the toolbar is not dockable,
827 m_widget comes from m_toolbar which uses its parent's
828 window ("windowless windows") and thus we cannot set the
830 gdk_window_set_cursor( m_widget
->window
, cursor
.GetCursor() );
833 wxToolBarToolsList::compatibility_iterator node
= m_tools
.GetFirst();
836 wxToolBarTool
*tool
= (wxToolBarTool
*)node
->GetData();
837 node
= node
->GetNext();
839 GtkWidget
*item
= tool
->m_item
;
842 GdkWindow
*window
= item
->window
;
846 gdk_window_set_cursor( window
, cursor
.GetCursor() );
852 if (wxUpdateUIEvent::CanUpdate(this))
853 UpdateWindowUI(wxUPDATE_UI_FROMIDLE
);
857 // ----------------------------------------------------------------------------
861 wxToolBar::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
863 return GetDefaultAttributesFromGTKWidget(gtk_toolbar_new
);
866 #endif // wxUSE_TOOLBAR_NATIVE