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 // For compilers that support precompilation, includes "wx.h".
20 #include "wx/wxprec.h"
22 #include "wx/toolbar.h"
24 #if wxUSE_TOOLBAR_NATIVE
29 #include "wx/gtk/private.h"
31 // ----------------------------------------------------------------------------
33 // ----------------------------------------------------------------------------
36 extern void wxapp_install_idle_handler();
40 extern bool g_blockEventsOnDrag
;
41 extern wxCursor g_globalCursor
;
43 // ----------------------------------------------------------------------------
45 // ----------------------------------------------------------------------------
47 // translate wxWidgets toolbar style flags to GTK orientation and style
48 static void GetGtkStyle(long style
,
49 GtkOrientation
*orient
, GtkToolbarStyle
*gtkStyle
)
51 *orient
= style
& wxTB_VERTICAL
? GTK_ORIENTATION_VERTICAL
52 : GTK_ORIENTATION_HORIZONTAL
;
55 if ( style
& wxTB_TEXT
)
57 *gtkStyle
= style
& wxTB_NOICONS
61 style
& wxTB_HORZ_LAYOUT
? GTK_TOOLBAR_BOTH_HORIZ
:
65 else // no text, hence we must have the icons or what would we show?
67 *gtkStyle
= GTK_TOOLBAR_ICONS
;
71 // ----------------------------------------------------------------------------
73 // ----------------------------------------------------------------------------
75 class wxToolBarTool
: public wxToolBarToolBase
78 wxToolBarTool(wxToolBar
*tbar
,
80 const wxString
& label
,
81 const wxBitmap
& bitmap1
,
82 const wxBitmap
& bitmap2
,
85 const wxString
& shortHelpString
,
86 const wxString
& longHelpString
)
87 : wxToolBarToolBase(tbar
, id
, label
, bitmap1
, bitmap2
, kind
,
88 clientData
, shortHelpString
, longHelpString
)
93 wxToolBarTool(wxToolBar
*tbar
, wxControl
*control
)
94 : wxToolBarToolBase(tbar
, control
)
99 // is this a radio button?
101 // unlike GetKind(), can be called for any kind of tools, not just buttons
102 bool IsRadio() const { return IsButton() && GetKind() == wxITEM_RADIO
; }
104 // this is only called for the normal buttons, i.e. not separators nor
106 GtkToolbarChildType
GetGtkChildType() const
111 return GTK_TOOLBAR_CHILD_TOGGLEBUTTON
;
114 return GTK_TOOLBAR_CHILD_RADIOBUTTON
;
117 wxFAIL_MSG( _T("unknown toolbar child type") );
121 return GTK_TOOLBAR_CHILD_BUTTON
;
125 void SetPixmap(const wxBitmap
& bitmap
)
129 GdkBitmap
*mask
= bitmap
.GetMask() ? bitmap
.GetMask()->GetBitmap()
132 if (bitmap
.HasPixbuf())
133 gtk_image_set_from_pixbuf( GTK_IMAGE(m_pixmap
), bitmap
.GetPixbuf() );
135 #endif // !__WXGTK20__
136 gtk_pixmap_set( GTK_PIXMAP(m_pixmap
), bitmap
.GetPixmap(), mask
);
147 // ----------------------------------------------------------------------------
149 // ----------------------------------------------------------------------------
151 IMPLEMENT_DYNAMIC_CLASS(wxToolBar
, wxControl
)
153 // ============================================================================
155 // ============================================================================
157 //-----------------------------------------------------------------------------
158 // "clicked" (internal from gtk_toolbar)
159 //-----------------------------------------------------------------------------
162 static void gtk_toolbar_callback( GtkWidget
*WXUNUSED(widget
),
163 wxToolBarTool
*tool
)
166 wxapp_install_idle_handler();
168 wxToolBar
*tbar
= (wxToolBar
*)tool
->GetToolBar();
170 if (tbar
->m_blockEvent
) return;
172 if (g_blockEventsOnDrag
) return;
173 if (!tool
->IsEnabled()) return;
175 if (tool
->CanBeToggled())
179 tool
->SetPixmap(tool
->GetBitmap());
181 if ( tool
->IsRadio() && !tool
->IsToggled() )
183 // radio button went up, don't report this as a wxWin event
188 if( !tbar
->OnLeftClick( tool
->GetId(), tool
->IsToggled() ) && tool
->CanBeToggled() )
193 tool
->SetPixmap(tool
->GetBitmap());
198 //-----------------------------------------------------------------------------
199 // "enter_notify_event" / "leave_notify_event"
200 //-----------------------------------------------------------------------------
203 static gint
gtk_toolbar_tool_callback( GtkWidget
*WXUNUSED(widget
),
204 GdkEventCrossing
*gdk_event
,
205 wxToolBarTool
*tool
)
207 if (g_isIdle
) wxapp_install_idle_handler();
209 if (g_blockEventsOnDrag
) return TRUE
;
211 wxToolBar
*tb
= (wxToolBar
*)tool
->GetToolBar();
214 if( gdk_event
->type
== GDK_ENTER_NOTIFY
)
215 tb
->OnMouseEnter( tool
->GetId() );
217 tb
->OnMouseEnter( -1 );
223 //-----------------------------------------------------------------------------
224 // InsertChild callback for wxToolBar
225 //-----------------------------------------------------------------------------
227 static void wxInsertChildInToolBar( wxToolBar
* WXUNUSED(parent
),
228 wxWindow
* WXUNUSED(child
) )
230 // we don't do anything here
233 // ----------------------------------------------------------------------------
235 // ----------------------------------------------------------------------------
237 void wxToolBarTool::Init()
240 m_pixmap
= (GtkWidget
*)NULL
;
243 wxToolBarToolBase
*wxToolBar::CreateTool(int id
,
244 const wxString
& text
,
245 const wxBitmap
& bitmap1
,
246 const wxBitmap
& bitmap2
,
248 wxObject
*clientData
,
249 const wxString
& shortHelpString
,
250 const wxString
& longHelpString
)
252 return new wxToolBarTool(this, id
, text
, bitmap1
, bitmap2
, kind
,
253 clientData
, shortHelpString
, longHelpString
);
256 wxToolBarToolBase
*wxToolBar::CreateTool(wxControl
*control
)
258 return new wxToolBarTool(this, control
);
261 //-----------------------------------------------------------------------------
262 // wxToolBar construction
263 //-----------------------------------------------------------------------------
265 void wxToolBar::Init()
267 m_toolbar
= (GtkToolbar
*)NULL
;
268 m_blockEvent
= false;
270 m_defaultHeight
= 32;
273 wxToolBar::~wxToolBar()
277 bool wxToolBar::Create( wxWindow
*parent
,
282 const wxString
& name
)
285 m_insertCallback
= (wxInsertChildFunction
)wxInsertChildInToolBar
;
287 if ( !PreCreation( parent
, pos
, size
) ||
288 !CreateBase( parent
, id
, pos
, size
, style
, wxDefaultValidator
, name
))
290 wxFAIL_MSG( wxT("wxToolBar creation failed") );
296 m_toolbar
= GTK_TOOLBAR( gtk_toolbar_new() );
299 // Doesn't work this way.
300 // GtkToolbarSpaceStyle space_style = GTK_TOOLBAR_SPACE_EMPTY;
301 // gtk_widget_style_set (GTK_WIDGET (m_toolbar), "space_style", &space_style, NULL);
303 GtkOrientation orient
;
304 GtkToolbarStyle gtkStyle
;
305 GetGtkStyle(style
, &orient
, >kStyle
);
307 m_toolbar
= GTK_TOOLBAR( gtk_toolbar_new(orient
, gtkStyle
) );
310 SetToolSeparation(7);
312 if (style
& wxTB_DOCKABLE
)
314 m_widget
= gtk_handle_box_new();
315 gtk_container_add( GTK_CONTAINER(m_widget
), GTK_WIDGET(m_toolbar
) );
316 gtk_widget_show( GTK_WIDGET(m_toolbar
) );
318 if (style
& wxTB_FLAT
)
319 gtk_handle_box_set_shadow_type( GTK_HANDLE_BOX(m_widget
), GTK_SHADOW_NONE
);
323 m_widget
= gtk_event_box_new();
324 gtk_container_add( GTK_CONTAINER(m_widget
), GTK_WIDGET(m_toolbar
) );
325 ConnectWidget( m_widget
);
326 gtk_widget_show(GTK_WIDGET(m_toolbar
));
329 gtk_toolbar_set_tooltips( GTK_TOOLBAR(m_toolbar
), TRUE
);
331 // FIXME: there is no such function for toolbars in 2.0
333 if (style
& wxTB_FLAT
)
334 gtk_toolbar_set_button_relief( GTK_TOOLBAR(m_toolbar
), GTK_RELIEF_NONE
);
337 m_parent
->DoAddChild( this );
344 void wxToolBar::GtkSetStyle()
346 GtkOrientation orient
;
347 GtkToolbarStyle style
;
348 GetGtkStyle(GetWindowStyle(), &orient
, &style
);
350 gtk_toolbar_set_orientation(m_toolbar
, orient
);
351 gtk_toolbar_set_style(m_toolbar
, style
);
354 void wxToolBar::SetWindowStyleFlag( long style
)
356 wxToolBarBase::SetWindowStyleFlag(style
);
362 bool wxToolBar::DoInsertTool(size_t pos
, wxToolBarToolBase
*toolBase
)
364 wxToolBarTool
*tool
= (wxToolBarTool
*)toolBase
;
367 // if we have inserted a space before all the tools we must change the GTK
369 size_t posGtk
= m_xMargin
> 1 ? pos
+ 1 : pos
;
374 if ( tool
->IsButton() )
376 if ( !HasFlag(wxTB_NOICONS
) )
378 wxBitmap bitmap
= tool
->GetNormalBitmap();
380 wxCHECK_MSG( bitmap
.Ok(), false,
381 wxT("invalid bitmap for wxToolBar icon") );
383 wxCHECK_MSG( bitmap
.GetBitmap() == NULL
, false,
384 wxT("wxToolBar doesn't support GdkBitmap") );
386 wxCHECK_MSG( bitmap
.GetPixmap() != NULL
, false,
387 wxT("wxToolBar::Add needs a wxBitmap") );
389 GtkWidget
*tool_pixmap
= (GtkWidget
*)NULL
;
393 if (bitmap
.HasPixbuf())
395 tool_pixmap
= gtk_image_new();
396 tool
->m_pixmap
= tool_pixmap
;
397 tool
->SetPixmap(bitmap
);
402 GdkPixmap
*pixmap
= bitmap
.GetPixmap();
404 GdkBitmap
*mask
= (GdkBitmap
*)NULL
;
405 if ( bitmap
.GetMask() )
406 mask
= bitmap
.GetMask()->GetBitmap();
408 tool_pixmap
= gtk_pixmap_new( pixmap
, mask
);
409 gtk_pixmap_set_build_insensitive( GTK_PIXMAP(tool_pixmap
), TRUE
);
412 gtk_misc_set_alignment( GTK_MISC(tool_pixmap
), 0.5, 0.5 );
414 tool
->m_pixmap
= tool_pixmap
;
418 switch ( tool
->GetStyle() )
420 case wxTOOL_STYLE_BUTTON
:
421 // for a radio button we need the widget which starts the radio
422 // group it belongs to, i.e. the first radio button immediately
423 // preceding this one
425 GtkWidget
*widget
= NULL
;
427 if ( tool
->IsRadio() )
429 wxToolBarToolsList::compatibility_iterator node
430 = wxToolBarToolsList::compatibility_iterator();
431 if ( pos
) node
= m_tools
.Item(pos
- 1);
435 wxToolBarTool
*tool
= (wxToolBarTool
*)node
->GetData();
436 if ( !tool
->IsRadio() )
439 widget
= tool
->m_item
;
441 node
= node
->GetPrevious();
446 // this is the first button in the radio button group,
447 // it will be toggled automatically by GTK so bring the
448 // internal flag in sync
453 tool
->m_item
= gtk_toolbar_insert_element
456 tool
->GetGtkChildType(),
458 tool
->GetLabel().empty()
460 : (const char*) wxGTK_CONV( tool
->GetLabel() ),
461 tool
->GetShortHelp().empty()
463 : (const char*) wxGTK_CONV( tool
->GetShortHelp() ),
464 "", // tooltip_private_text (?)
466 (GtkSignalFunc
)gtk_toolbar_callback
,
473 wxFAIL_MSG( _T("gtk_toolbar_insert_element() failed") );
478 gtk_signal_connect( GTK_OBJECT(tool
->m_item
),
479 "enter_notify_event",
480 GTK_SIGNAL_FUNC(gtk_toolbar_tool_callback
),
482 gtk_signal_connect( GTK_OBJECT(tool
->m_item
),
483 "leave_notify_event",
484 GTK_SIGNAL_FUNC(gtk_toolbar_tool_callback
),
489 case wxTOOL_STYLE_SEPARATOR
:
490 gtk_toolbar_insert_space( m_toolbar
, posGtk
);
495 case wxTOOL_STYLE_CONTROL
:
496 gtk_toolbar_insert_widget(
498 tool
->GetControl()->m_widget
,
507 (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget
) )->size_request
)
509 m_width
= req
.width
+ m_xMargin
;
510 m_height
= req
.height
+ 2*m_yMargin
;
511 InvalidateBestSize();
516 bool wxToolBar::DoDeleteTool(size_t pos
, wxToolBarToolBase
*toolBase
)
518 wxToolBarTool
*tool
= (wxToolBarTool
*)toolBase
;
520 switch ( tool
->GetStyle() )
522 case wxTOOL_STYLE_CONTROL
:
523 tool
->GetControl()->Destroy();
526 case wxTOOL_STYLE_BUTTON
:
527 gtk_widget_destroy( tool
->m_item
);
531 case wxTOOL_STYLE_SEPARATOR
:
532 gtk_toolbar_remove_space( m_toolbar
, pos
);
537 InvalidateBestSize();
541 // ----------------------------------------------------------------------------
542 // wxToolBar tools state
543 // ----------------------------------------------------------------------------
545 void wxToolBar::DoEnableTool(wxToolBarToolBase
*toolBase
, bool enable
)
547 wxToolBarTool
*tool
= (wxToolBarTool
*)toolBase
;
551 gtk_widget_set_sensitive( tool
->m_item
, enable
);
555 void wxToolBar::DoToggleTool( wxToolBarToolBase
*toolBase
, bool toggle
)
557 wxToolBarTool
*tool
= (wxToolBarTool
*)toolBase
;
559 GtkWidget
*item
= tool
->m_item
;
560 if ( item
&& GTK_IS_TOGGLE_BUTTON(item
) )
562 tool
->SetPixmap(tool
->GetBitmap());
566 gtk_toggle_button_set_state( GTK_TOGGLE_BUTTON(item
), toggle
);
568 m_blockEvent
= false;
572 void wxToolBar::DoSetToggle(wxToolBarToolBase
* WXUNUSED(tool
),
573 bool WXUNUSED(toggle
))
575 // VZ: absolutely no idea about how to do it
576 wxFAIL_MSG( _T("not implemented") );
579 // ----------------------------------------------------------------------------
580 // wxToolBar geometry
581 // ----------------------------------------------------------------------------
583 wxToolBarToolBase
*wxToolBar::FindToolForPosition(wxCoord
WXUNUSED(x
),
584 wxCoord
WXUNUSED(y
)) const
586 // VZ: GTK+ doesn't seem to have such thing
587 wxFAIL_MSG( _T("wxToolBar::FindToolForPosition() not implemented") );
589 return (wxToolBarToolBase
*)NULL
;
592 void wxToolBar::SetMargins( int x
, int y
)
594 wxCHECK_RET( GetToolsCount() == 0,
595 wxT("wxToolBar::SetMargins must be called before adding tools.") );
599 gtk_toolbar_append_space( m_toolbar
); // oh well
606 void wxToolBar::SetToolSeparation( int separation
)
608 // FIXME: this function disappeared
610 gtk_toolbar_set_space_size( m_toolbar
, separation
);
613 m_toolSeparation
= separation
;
616 void wxToolBar::SetToolShortHelp( int id
, const wxString
& helpString
)
618 wxToolBarTool
*tool
= (wxToolBarTool
*)FindById(id
);
622 (void)tool
->SetShortHelp(helpString
);
623 gtk_tooltips_set_tip(m_toolbar
->tooltips
, tool
->m_item
,
624 wxGTK_CONV( helpString
), "");
628 // ----------------------------------------------------------------------------
629 // wxToolBar idle handling
630 // ----------------------------------------------------------------------------
632 void wxToolBar::OnInternalIdle()
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
))
686 return GetDefaultAttributesFromGTKWidget(gtk_toolbar_new
);
688 wxVisualAttributes attr
;
689 GtkWidget
* widget
= gtk_toolbar_new(GTK_ORIENTATION_HORIZONTAL
, GTK_TOOLBAR_BOTH
);
690 attr
= GetDefaultAttributesFromGTKWidget(widget
);
691 gtk_widget_destroy(widget
);
696 #endif // wxUSE_TOOLBAR_NATIVE