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"
39 // ----------------------------------------------------------------------------
41 // ----------------------------------------------------------------------------
44 extern bool g_blockEventsOnDrag
;
45 extern wxCursor g_globalCursor
;
47 // ----------------------------------------------------------------------------
49 // ----------------------------------------------------------------------------
51 // translate wxWidgets toolbar style flags to GTK orientation and style
52 static void GetGtkStyle(long style
,
53 GtkOrientation
*orient
, GtkToolbarStyle
*gtkStyle
)
55 *orient
= ( style
& wxTB_LEFT
|| style
& wxTB_RIGHT
) ? GTK_ORIENTATION_VERTICAL
: GTK_ORIENTATION_HORIZONTAL
;
58 if ( style
& wxTB_TEXT
)
60 *gtkStyle
= style
& wxTB_NOICONS
63 style
& wxTB_HORZ_LAYOUT
? GTK_TOOLBAR_BOTH_HORIZ
:
66 else // no text, hence we must have the icons or what would we show?
68 *gtkStyle
= GTK_TOOLBAR_ICONS
;
72 // ----------------------------------------------------------------------------
74 // ----------------------------------------------------------------------------
76 class wxToolBarTool
: public wxToolBarToolBase
79 wxToolBarTool(wxToolBar
*tbar
,
81 const wxString
& label
,
82 const wxBitmap
& bitmap1
,
83 const wxBitmap
& bitmap2
,
86 const wxString
& shortHelpString
,
87 const wxString
& longHelpString
)
88 : wxToolBarToolBase(tbar
, id
, label
, bitmap1
, bitmap2
, kind
,
89 clientData
, shortHelpString
, longHelpString
)
94 wxToolBarTool(wxToolBar
*tbar
, wxControl
*control
, const wxString
& label
)
95 : wxToolBarToolBase(tbar
, control
, label
)
100 // is this a radio button?
102 // unlike GetKind(), can be called for any kind of tools, not just buttons
103 bool IsRadio() const { return IsButton() && GetKind() == wxITEM_RADIO
; }
105 // this is only called for the normal buttons, i.e. not separators nor
107 GtkToolbarChildType
GetGtkChildType() const
112 return GTK_TOOLBAR_CHILD_TOGGLEBUTTON
;
115 return GTK_TOOLBAR_CHILD_RADIOBUTTON
;
118 wxFAIL_MSG( _T("unknown toolbar child type") );
122 return GTK_TOOLBAR_CHILD_BUTTON
;
126 void SetImage(const wxBitmap
& bitmap
)
130 // setting from pixmap doesn't seem to work right, but pixbuf works well
131 gtk_image_set_from_pixbuf((GtkImage
*)m_image
, bitmap
.GetPixbuf());
142 // ----------------------------------------------------------------------------
144 // ----------------------------------------------------------------------------
146 IMPLEMENT_DYNAMIC_CLASS(wxToolBar
, wxControl
)
148 // ============================================================================
150 // ============================================================================
152 //-----------------------------------------------------------------------------
153 // "clicked" (internal from gtk_toolbar)
154 //-----------------------------------------------------------------------------
157 static void gtk_toolbar_callback( GtkWidget
*WXUNUSED(widget
),
158 wxToolBarTool
*tool
)
161 wxapp_install_idle_handler();
163 wxToolBar
*tbar
= (wxToolBar
*)tool
->GetToolBar();
165 if (tbar
->m_blockEvent
) return;
167 if (g_blockEventsOnDrag
) return;
168 if (!tool
->IsEnabled()) return;
170 if (tool
->CanBeToggled())
174 tool
->SetImage(tool
->GetBitmap());
176 if ( tool
->IsRadio() && !tool
->IsToggled() )
178 // radio button went up, don't report this as a wxWin event
183 if( !tbar
->OnLeftClick( tool
->GetId(), tool
->IsToggled() ) && tool
->CanBeToggled() )
188 tool
->SetImage(tool
->GetBitmap());
193 //-----------------------------------------------------------------------------
194 // "enter_notify_event" / "leave_notify_event"
195 //-----------------------------------------------------------------------------
198 static gint
gtk_toolbar_tool_callback( GtkWidget
*WXUNUSED(widget
),
199 GdkEventCrossing
*gdk_event
,
200 wxToolBarTool
*tool
)
202 // don't need to install idle handler, its done from "event" signal
204 if (g_blockEventsOnDrag
) return TRUE
;
206 wxToolBar
*tb
= (wxToolBar
*)tool
->GetToolBar();
209 if( gdk_event
->type
== GDK_ENTER_NOTIFY
)
210 tb
->OnMouseEnter( tool
->GetId() );
212 tb
->OnMouseEnter( -1 );
220 void gtktoolwidget_size_callback( GtkWidget
*widget
,
221 GtkAllocation
*alloc
,
224 // this shouldn't happen...
225 if (win
->GetParent()->m_wxwindow
) return;
227 wxSize size
= win
->GetEffectiveMinSize();
228 if (size
.y
!= alloc
->height
)
230 GtkAllocation alloc2
;
232 alloc2
.y
= (alloc
->height
- size
.y
+ 3) / 2;
233 alloc2
.width
= alloc
->width
;
234 alloc2
.height
= size
.y
;
235 gtk_widget_size_allocate( widget
, &alloc2
);
239 //-----------------------------------------------------------------------------
240 // InsertChild callback for wxToolBar
241 //-----------------------------------------------------------------------------
243 static void wxInsertChildInToolBar( wxToolBar
* WXUNUSED(parent
),
244 wxWindow
* WXUNUSED(child
) )
246 // we don't do anything here
249 // ----------------------------------------------------------------------------
251 // ----------------------------------------------------------------------------
253 void wxToolBarTool::Init()
259 wxToolBarToolBase
*wxToolBar::CreateTool(int id
,
260 const wxString
& text
,
261 const wxBitmap
& bitmap1
,
262 const wxBitmap
& bitmap2
,
264 wxObject
*clientData
,
265 const wxString
& shortHelpString
,
266 const wxString
& longHelpString
)
268 return new wxToolBarTool(this, id
, text
, bitmap1
, bitmap2
, kind
,
269 clientData
, shortHelpString
, longHelpString
);
273 wxToolBar::CreateTool(wxControl
*control
, const wxString
& label
)
275 return new wxToolBarTool(this, control
, label
);
278 //-----------------------------------------------------------------------------
279 // wxToolBar construction
280 //-----------------------------------------------------------------------------
282 void wxToolBar::Init()
284 m_toolbar
= (GtkToolbar
*)NULL
;
285 m_blockEvent
= false;
287 m_defaultHeight
= 32;
290 wxToolBar::~wxToolBar()
294 bool wxToolBar::Create( wxWindow
*parent
,
299 const wxString
& name
)
302 m_insertCallback
= (wxInsertChildFunction
)wxInsertChildInToolBar
;
304 if ( !PreCreation( parent
, pos
, size
) ||
305 !CreateBase( parent
, id
, pos
, size
, style
, wxDefaultValidator
, name
))
307 wxFAIL_MSG( wxT("wxToolBar creation failed") );
314 m_toolbar
= GTK_TOOLBAR( gtk_toolbar_new() );
317 // Doesn't work this way.
318 // GtkToolbarSpaceStyle space_style = GTK_TOOLBAR_SPACE_EMPTY;
319 // gtk_widget_style_set (GTK_WIDGET (m_toolbar), "space_style", &space_style, NULL);
321 SetToolSeparation(7);
323 if (style
& wxTB_DOCKABLE
)
325 m_widget
= gtk_handle_box_new();
326 gtk_container_add( GTK_CONTAINER(m_widget
), GTK_WIDGET(m_toolbar
) );
327 gtk_widget_show( GTK_WIDGET(m_toolbar
) );
329 if (style
& wxTB_FLAT
)
330 gtk_handle_box_set_shadow_type( GTK_HANDLE_BOX(m_widget
), GTK_SHADOW_NONE
);
334 m_widget
= gtk_event_box_new();
335 gtk_container_add( GTK_CONTAINER(m_widget
), GTK_WIDGET(m_toolbar
) );
336 ConnectWidget( m_widget
);
337 gtk_widget_show(GTK_WIDGET(m_toolbar
));
340 // FIXME: there is no such function for toolbars in 2.0
342 if (style
& wxTB_FLAT
)
343 gtk_toolbar_set_button_relief( GTK_TOOLBAR(m_toolbar
), GTK_RELIEF_NONE
);
346 m_parent
->DoAddChild( this );
353 GdkWindow
*wxToolBar::GTKGetWindow(wxArrayGdkWindows
& windows
) const
355 return GTK_WIDGET(m_toolbar
)->window
;
358 void wxToolBar::GtkSetStyle()
360 GtkOrientation orient
;
361 GtkToolbarStyle style
;
362 GetGtkStyle(GetWindowStyle(), &orient
, &style
);
364 gtk_toolbar_set_orientation(m_toolbar
, orient
);
365 gtk_toolbar_set_style(m_toolbar
, style
);
366 gtk_toolbar_set_tooltips(m_toolbar
, !(style
& wxTB_NO_TOOLTIPS
));
369 void wxToolBar::SetWindowStyleFlag( long style
)
371 wxToolBarBase::SetWindowStyleFlag(style
);
377 bool wxToolBar::DoInsertTool(size_t pos
, wxToolBarToolBase
*toolBase
)
379 wxToolBarTool
* tool
= wx_static_cast(wxToolBarTool
*, toolBase
);
381 if ( tool
->IsButton() )
383 if ( !HasFlag(wxTB_NOICONS
) )
385 wxBitmap bitmap
= tool
->GetNormalBitmap();
387 wxCHECK_MSG( bitmap
.Ok(), false,
388 wxT("invalid bitmap for wxToolBar icon") );
390 tool
->m_image
= gtk_image_new();
391 tool
->SetImage(bitmap
);
393 gtk_misc_set_alignment((GtkMisc
*)tool
->m_image
, 0.5, 0.5);
397 const int posGtk
= int(pos
);
399 switch ( tool
->GetStyle() )
401 case wxTOOL_STYLE_BUTTON
:
402 // for a radio button we need the widget which starts the radio
403 // group it belongs to, i.e. the first radio button immediately
404 // preceding this one
406 GtkWidget
*widget
= NULL
;
408 if ( tool
->IsRadio() )
410 wxToolBarToolsList::compatibility_iterator node
411 = wxToolBarToolsList::compatibility_iterator();
413 node
= m_tools
.Item(pos
- 1);
417 wxToolBarTool
*toolNext
= (wxToolBarTool
*)node
->GetData();
418 if ( !toolNext
->IsRadio() )
421 widget
= toolNext
->m_item
;
423 node
= node
->GetPrevious();
428 // this is the first button in the radio button group,
429 // it will be toggled automatically by GTK so bring the
430 // internal flag in sync
435 tool
->m_item
= gtk_toolbar_insert_element
438 tool
->GetGtkChildType(),
440 tool
->GetLabel().empty()
442 : (const char*) wxGTK_CONV( tool
->GetLabel() ),
443 tool
->GetShortHelp().empty()
445 : (const char*) wxGTK_CONV( tool
->GetShortHelp() ),
446 "", // tooltip_private_text (?)
448 (GtkSignalFunc
)gtk_toolbar_callback
,
453 wxCHECK_MSG(tool
->m_item
!= NULL
, false, _T("gtk_toolbar_insert_element() failed"));
455 g_signal_connect (tool
->m_item
, "enter_notify_event",
456 G_CALLBACK (gtk_toolbar_tool_callback
),
458 g_signal_connect (tool
->m_item
, "leave_notify_event",
459 G_CALLBACK (gtk_toolbar_tool_callback
),
464 case wxTOOL_STYLE_SEPARATOR
:
465 gtk_toolbar_insert_space( m_toolbar
, posGtk
);
470 case wxTOOL_STYLE_CONTROL
:
471 gtk_toolbar_insert_widget(
473 tool
->GetControl()->m_widget
,
479 // connect after in order to correct size_allocate events
480 g_signal_connect_after (tool
->GetControl()->m_widget
, "size_allocate",
481 G_CALLBACK (gtktoolwidget_size_callback
), tool
->GetControl());
487 (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget
) )->size_request
)
489 m_width
= req
.width
+ m_xMargin
;
490 m_height
= req
.height
+ 2*m_yMargin
;
491 InvalidateBestSize();
496 bool wxToolBar::DoDeleteTool(size_t pos
, wxToolBarToolBase
*toolBase
)
498 wxToolBarTool
* tool
= wx_static_cast(wxToolBarTool
*, toolBase
);
500 switch ( tool
->GetStyle() )
502 case wxTOOL_STYLE_CONTROL
:
503 tool
->GetControl()->Destroy();
506 case wxTOOL_STYLE_BUTTON
:
507 gtk_widget_destroy( tool
->m_item
);
510 case wxTOOL_STYLE_SEPARATOR
:
511 gtk_toolbar_remove_space( m_toolbar
, pos
);
515 InvalidateBestSize();
519 // ----------------------------------------------------------------------------
520 // wxToolBar tools state
521 // ----------------------------------------------------------------------------
523 void wxToolBar::DoEnableTool(wxToolBarToolBase
*toolBase
, bool enable
)
525 wxToolBarTool
* tool
= wx_static_cast(wxToolBarTool
*, toolBase
);
529 gtk_widget_set_sensitive( tool
->m_item
, enable
);
533 void wxToolBar::DoToggleTool( wxToolBarToolBase
*toolBase
, bool toggle
)
535 wxToolBarTool
* tool
= wx_static_cast(wxToolBarTool
*, toolBase
);
537 GtkWidget
*item
= tool
->m_item
;
538 if ( item
&& GTK_IS_TOGGLE_BUTTON(item
) )
540 tool
->SetImage(tool
->GetBitmap());
544 gtk_toggle_button_set_active( GTK_TOGGLE_BUTTON(item
), toggle
);
546 m_blockEvent
= false;
550 void wxToolBar::DoSetToggle(wxToolBarToolBase
* WXUNUSED(tool
),
551 bool WXUNUSED(toggle
))
553 // VZ: absolutely no idea about how to do it
554 wxFAIL_MSG( _T("not implemented") );
557 // ----------------------------------------------------------------------------
558 // wxToolBar geometry
559 // ----------------------------------------------------------------------------
561 wxToolBarToolBase
*wxToolBar::FindToolForPosition(wxCoord
WXUNUSED(x
),
562 wxCoord
WXUNUSED(y
)) const
564 // VZ: GTK+ doesn't seem to have such thing
565 wxFAIL_MSG( _T("wxToolBar::FindToolForPosition() not implemented") );
567 return (wxToolBarToolBase
*)NULL
;
570 void wxToolBar::SetMargins( int x
, int y
)
572 wxCHECK_RET( GetToolsCount() == 0,
573 wxT("wxToolBar::SetMargins must be called before adding tools.") );
579 void wxToolBar::SetToolSeparation( int separation
)
581 // FIXME: this function disappeared
583 gtk_toolbar_set_space_size( m_toolbar
, separation
);
586 m_toolSeparation
= separation
;
589 void wxToolBar::SetToolShortHelp( int id
, const wxString
& helpString
)
591 wxToolBarTool
* tool
= wx_static_cast(wxToolBarTool
*, FindById(id
));
595 (void)tool
->SetShortHelp(helpString
);
596 gtk_tooltips_set_tip(m_toolbar
->tooltips
, tool
->m_item
,
597 wxGTK_CONV( helpString
), "");
601 void wxToolBar::SetToolNormalBitmap( int id
, const wxBitmap
& bitmap
)
603 wxToolBarTool
* tool
= wx_static_cast(wxToolBarTool
*, FindById(id
));
606 wxCHECK_RET( tool
->IsButton(), wxT("Can only set bitmap on button tools."));
608 tool
->SetNormalBitmap(bitmap
);
609 tool
->SetImage(tool
->GetBitmap());
613 void wxToolBar::SetToolDisabledBitmap( int id
, const wxBitmap
& bitmap
)
615 wxToolBarTool
* tool
= wx_static_cast(wxToolBarTool
*, FindById(id
));
618 wxCHECK_RET( tool
->IsButton(), wxT("Can only set bitmap on button tools."));
620 tool
->SetDisabledBitmap(bitmap
);
621 tool
->SetImage(tool
->GetBitmap());
625 // ----------------------------------------------------------------------------
626 // wxToolBar idle handling
627 // ----------------------------------------------------------------------------
629 void wxToolBar::OnInternalIdle()
631 // Check if we have to show window now
632 if (GtkShowFromOnIdle()) return;
634 wxCursor cursor
= m_cursor
;
635 if (g_globalCursor
.Ok()) cursor
= g_globalCursor
;
639 /* I now set the cursor the anew in every OnInternalIdle call
640 as setting the cursor in a parent window also effects the
641 windows above so that checking for the current cursor is
644 if (HasFlag(wxTB_DOCKABLE
) && (m_widget
->window
))
646 /* if the toolbar is dockable, then m_widget stands for the
647 GtkHandleBox widget, which uses its own window so that we
648 can set the cursor for it. if the toolbar is not dockable,
649 m_widget comes from m_toolbar which uses its parent's
650 window ("windowless windows") and thus we cannot set the
652 gdk_window_set_cursor( m_widget
->window
, cursor
.GetCursor() );
655 wxToolBarToolsList::compatibility_iterator node
= m_tools
.GetFirst();
658 wxToolBarTool
*tool
= (wxToolBarTool
*)node
->GetData();
659 node
= node
->GetNext();
661 GtkWidget
*item
= tool
->m_item
;
664 GdkWindow
*window
= item
->window
;
668 gdk_window_set_cursor( window
, cursor
.GetCursor() );
674 if (wxUpdateUIEvent::CanUpdate(this))
675 UpdateWindowUI(wxUPDATE_UI_FROMIDLE
);
679 // ----------------------------------------------------------------------------
683 wxToolBar::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
685 return GetDefaultAttributesFromGTKWidget(gtk_toolbar_new
);
688 #endif // wxUSE_TOOLBAR_NATIVE