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
;
138 // ----------------------------------------------------------------------------
140 // ----------------------------------------------------------------------------
142 IMPLEMENT_DYNAMIC_CLASS(wxToolBar
, wxControl
)
144 // ============================================================================
146 // ============================================================================
148 //-----------------------------------------------------------------------------
149 // "clicked" (internal from gtk_toolbar)
150 //-----------------------------------------------------------------------------
152 static void gtk_toolbar_callback( GtkWidget
*WXUNUSED(widget
),
153 wxToolBarTool
*tool
)
156 wxapp_install_idle_handler();
158 wxToolBar
*tbar
= (wxToolBar
*)tool
->GetToolBar();
160 if (tbar
->m_blockEvent
) return;
162 if (g_blockEventsOnDrag
) return;
163 if (!tool
->IsEnabled()) return;
165 if (tool
->CanBeToggled())
169 wxBitmap bitmap
= tool
->GetBitmap();
172 GtkPixmap
*pixmap
= GTK_PIXMAP( tool
->m_pixmap
);
174 GdkBitmap
*mask
= bitmap
.GetMask() ? bitmap
.GetMask()->GetBitmap()
177 gtk_pixmap_set( pixmap
, bitmap
.GetPixmap(), mask
);
180 if ( tool
->IsRadio() && !tool
->IsToggled() )
182 // radio button went up, don't report this as a wxWin event
187 if( !tbar
->OnLeftClick( tool
->GetId(), tool
->IsToggled() ) && tool
->CanBeToggled() )
192 wxBitmap bitmap
= tool
->GetBitmap();
195 GtkPixmap
*pixmap
= GTK_PIXMAP( tool
->m_pixmap
);
197 GdkBitmap
*mask
= bitmap
.GetMask() ? bitmap
.GetMask()->GetBitmap()
200 gtk_pixmap_set( pixmap
, bitmap
.GetPixmap(), mask
);
205 //-----------------------------------------------------------------------------
206 // "enter_notify_event" / "leave_notify_event"
207 //-----------------------------------------------------------------------------
209 static gint
gtk_toolbar_tool_callback( GtkWidget
*WXUNUSED(widget
),
210 GdkEventCrossing
*gdk_event
,
211 wxToolBarTool
*tool
)
213 if (g_isIdle
) wxapp_install_idle_handler();
215 if (g_blockEventsOnDrag
) return TRUE
;
217 wxToolBar
*tb
= (wxToolBar
*)tool
->GetToolBar();
220 if( gdk_event
->type
== GDK_ENTER_NOTIFY
)
221 tb
->OnMouseEnter( tool
->GetId() );
223 tb
->OnMouseEnter( -1 );
228 //-----------------------------------------------------------------------------
229 // InsertChild callback for wxToolBar
230 //-----------------------------------------------------------------------------
232 static void wxInsertChildInToolBar( wxToolBar
* WXUNUSED(parent
),
233 wxWindow
* WXUNUSED(child
) )
235 // we don't do anything here
238 // ----------------------------------------------------------------------------
240 // ----------------------------------------------------------------------------
242 void wxToolBarTool::Init()
245 m_pixmap
= (GtkWidget
*)NULL
;
248 wxToolBarToolBase
*wxToolBar::CreateTool(int id
,
249 const wxString
& text
,
250 const wxBitmap
& bitmap1
,
251 const wxBitmap
& bitmap2
,
253 wxObject
*clientData
,
254 const wxString
& shortHelpString
,
255 const wxString
& longHelpString
)
257 return new wxToolBarTool(this, id
, text
, bitmap1
, bitmap2
, kind
,
258 clientData
, shortHelpString
, longHelpString
);
261 wxToolBarToolBase
*wxToolBar::CreateTool(wxControl
*control
)
263 return new wxToolBarTool(this, control
);
266 //-----------------------------------------------------------------------------
267 // wxToolBar construction
268 //-----------------------------------------------------------------------------
270 void wxToolBar::Init()
272 m_toolbar
= (GtkToolbar
*)NULL
;
273 m_blockEvent
= FALSE
;
275 m_defaultHeight
= 32;
278 wxToolBar::~wxToolBar()
282 bool wxToolBar::Create( wxWindow
*parent
,
287 const wxString
& name
)
290 m_insertCallback
= (wxInsertChildFunction
)wxInsertChildInToolBar
;
292 if ( !PreCreation( parent
, pos
, size
) ||
293 !CreateBase( parent
, id
, pos
, size
, style
, wxDefaultValidator
, name
))
295 wxFAIL_MSG( wxT("wxToolBar creation failed") );
301 m_toolbar
= GTK_TOOLBAR( gtk_toolbar_new() );
304 // Doesn't work this way.
305 // GtkToolbarSpaceStyle space_style = GTK_TOOLBAR_SPACE_EMPTY;
306 // gtk_widget_style_set (GTK_WIDGET (m_toolbar), "space_style", &space_style, NULL);
308 GtkOrientation orient
;
309 GtkToolbarStyle gtkStyle
;
310 GetGtkStyle(style
, &orient
, >kStyle
);
312 m_toolbar
= GTK_TOOLBAR( gtk_toolbar_new(orient
, gtkStyle
) );
315 SetToolSeparation(7);
317 if (style
& wxTB_DOCKABLE
)
319 m_widget
= gtk_handle_box_new();
320 gtk_container_add( GTK_CONTAINER(m_widget
), GTK_WIDGET(m_toolbar
) );
321 gtk_widget_show( GTK_WIDGET(m_toolbar
) );
323 if (style
& wxTB_FLAT
)
324 gtk_handle_box_set_shadow_type( GTK_HANDLE_BOX(m_widget
), GTK_SHADOW_NONE
);
328 m_widget
= gtk_event_box_new();
329 gtk_container_add( GTK_CONTAINER(m_widget
), GTK_WIDGET(m_toolbar
) );
330 ConnectWidget( m_widget
);
331 gtk_widget_show(GTK_WIDGET(m_toolbar
));
334 gtk_toolbar_set_tooltips( GTK_TOOLBAR(m_toolbar
), TRUE
);
336 // FIXME: there is no such function for toolbars in 2.0
338 if (style
& wxTB_FLAT
)
339 gtk_toolbar_set_button_relief( GTK_TOOLBAR(m_toolbar
), GTK_RELIEF_NONE
);
342 m_parent
->DoAddChild( this );
349 void wxToolBar::GtkSetStyle()
351 GtkOrientation orient
;
352 GtkToolbarStyle style
;
353 GetGtkStyle(GetWindowStyle(), &orient
, &style
);
355 gtk_toolbar_set_orientation(m_toolbar
, orient
);
356 gtk_toolbar_set_style(m_toolbar
, style
);
359 void wxToolBar::SetWindowStyleFlag( long style
)
361 wxToolBarBase::SetWindowStyleFlag(style
);
367 bool wxToolBar::DoInsertTool(size_t pos
, wxToolBarToolBase
*toolBase
)
369 wxToolBarTool
*tool
= (wxToolBarTool
*)toolBase
;
372 // if we have inserted a space before all the tools we must change the GTK
374 size_t posGtk
= m_xMargin
> 1 ? pos
+ 1 : pos
;
379 if ( tool
->IsButton() )
381 if ( !HasFlag(wxTB_NOICONS
) )
383 wxBitmap bitmap
= tool
->GetNormalBitmap();
385 wxCHECK_MSG( bitmap
.Ok(), FALSE
,
386 wxT("invalid bitmap for wxToolBar icon") );
388 wxCHECK_MSG( bitmap
.GetBitmap() == NULL
, FALSE
,
389 wxT("wxToolBar doesn't support GdkBitmap") );
391 wxCHECK_MSG( bitmap
.GetPixmap() != NULL
, FALSE
,
392 wxT("wxToolBar::Add needs a wxBitmap") );
394 GtkWidget
*tool_pixmap
= (GtkWidget
*)NULL
;
396 GdkPixmap
*pixmap
= bitmap
.GetPixmap();
398 GdkBitmap
*mask
= (GdkBitmap
*)NULL
;
399 if ( bitmap
.GetMask() )
400 mask
= bitmap
.GetMask()->GetBitmap();
402 tool_pixmap
= gtk_pixmap_new( pixmap
, mask
);
403 gtk_pixmap_set_build_insensitive( GTK_PIXMAP(tool_pixmap
), TRUE
);
405 gtk_misc_set_alignment( GTK_MISC(tool_pixmap
), 0.5, 0.5 );
407 tool
->m_pixmap
= tool_pixmap
;
411 switch ( tool
->GetStyle() )
413 case wxTOOL_STYLE_BUTTON
:
414 // for a radio button we need the widget which starts the radio
415 // group it belongs to, i.e. the first radio button immediately
416 // preceding this one
418 GtkWidget
*widget
= NULL
;
420 if ( tool
->IsRadio() )
422 wxToolBarToolsList::compatibility_iterator node
423 = wxToolBarToolsList::compatibility_iterator();
424 if ( pos
) node
= m_tools
.Item(pos
- 1);
428 wxToolBarTool
*tool
= (wxToolBarTool
*)node
->GetData();
429 if ( !tool
->IsRadio() )
432 widget
= tool
->m_item
;
434 node
= node
->GetPrevious();
439 // this is the first button in the radio button group,
440 // it will be toggled automatically by GTK so bring the
441 // internal flag in sync
446 tool
->m_item
= gtk_toolbar_insert_element
449 tool
->GetGtkChildType(),
451 tool
->GetLabel().empty()
453 : (const char*) wxGTK_CONV( tool
->GetLabel() ),
454 tool
->GetShortHelp().empty()
456 : (const char*) wxGTK_CONV( tool
->GetShortHelp() ),
457 "", // tooltip_private_text (?)
459 (GtkSignalFunc
)gtk_toolbar_callback
,
466 wxFAIL_MSG( _T("gtk_toolbar_insert_element() failed") );
471 gtk_signal_connect( GTK_OBJECT(tool
->m_item
),
472 "enter_notify_event",
473 GTK_SIGNAL_FUNC(gtk_toolbar_tool_callback
),
475 gtk_signal_connect( GTK_OBJECT(tool
->m_item
),
476 "leave_notify_event",
477 GTK_SIGNAL_FUNC(gtk_toolbar_tool_callback
),
482 case wxTOOL_STYLE_SEPARATOR
:
483 gtk_toolbar_insert_space( m_toolbar
, posGtk
);
488 case wxTOOL_STYLE_CONTROL
:
489 gtk_toolbar_insert_widget(
491 tool
->GetControl()->m_widget
,
500 (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget
) )->size_request
)
502 m_width
= req
.width
+ m_xMargin
;
503 m_height
= req
.height
+ 2*m_yMargin
;
508 bool wxToolBar::DoDeleteTool(size_t WXUNUSED(pos
), wxToolBarToolBase
*toolBase
)
510 wxToolBarTool
*tool
= (wxToolBarTool
*)toolBase
;
512 switch ( tool
->GetStyle() )
514 case wxTOOL_STYLE_CONTROL
:
515 tool
->GetControl()->Destroy();
518 case wxTOOL_STYLE_BUTTON
:
519 gtk_widget_destroy( tool
->m_item
);
522 //case wxTOOL_STYLE_SEPARATOR: -- nothing to do
528 // ----------------------------------------------------------------------------
529 // wxToolBar tools state
530 // ----------------------------------------------------------------------------
532 void wxToolBar::DoEnableTool(wxToolBarToolBase
*toolBase
, bool enable
)
534 wxToolBarTool
*tool
= (wxToolBarTool
*)toolBase
;
538 gtk_widget_set_sensitive( tool
->m_item
, enable
);
542 void wxToolBar::DoToggleTool( wxToolBarToolBase
*toolBase
, bool toggle
)
544 wxToolBarTool
*tool
= (wxToolBarTool
*)toolBase
;
546 GtkWidget
*item
= tool
->m_item
;
547 if ( item
&& GTK_IS_TOGGLE_BUTTON(item
) )
549 wxBitmap bitmap
= tool
->GetBitmap();
552 GtkPixmap
*pixmap
= GTK_PIXMAP( tool
->m_pixmap
);
554 GdkBitmap
*mask
= bitmap
.GetMask() ? bitmap
.GetMask()->GetBitmap()
557 gtk_pixmap_set( pixmap
, bitmap
.GetPixmap(), mask
);
562 gtk_toggle_button_set_state( GTK_TOGGLE_BUTTON(item
), toggle
);
564 m_blockEvent
= FALSE
;
568 void wxToolBar::DoSetToggle(wxToolBarToolBase
* WXUNUSED(tool
),
569 bool WXUNUSED(toggle
))
571 // VZ: absolutely no idea about how to do it
572 wxFAIL_MSG( _T("not implemented") );
575 // ----------------------------------------------------------------------------
576 // wxToolBar geometry
577 // ----------------------------------------------------------------------------
579 wxToolBarToolBase
*wxToolBar::FindToolForPosition(wxCoord
WXUNUSED(x
),
580 wxCoord
WXUNUSED(y
)) const
582 // VZ: GTK+ doesn't seem to have such thing
583 wxFAIL_MSG( _T("wxToolBar::FindToolForPosition() not implemented") );
585 return (wxToolBarToolBase
*)NULL
;
588 void wxToolBar::SetMargins( int x
, int y
)
590 wxCHECK_RET( GetToolsCount() == 0,
591 wxT("wxToolBar::SetMargins must be called before adding tools.") );
595 gtk_toolbar_append_space( m_toolbar
); // oh well
602 void wxToolBar::SetToolSeparation( int separation
)
604 // FIXME: this function disappeared
606 gtk_toolbar_set_space_size( m_toolbar
, separation
);
609 m_toolSeparation
= separation
;
612 void wxToolBar::SetToolShortHelp( int id
, const wxString
& helpString
)
614 wxToolBarTool
*tool
= (wxToolBarTool
*)FindById(id
);
618 (void)tool
->SetShortHelp(helpString
);
619 gtk_tooltips_set_tip(m_toolbar
->tooltips
, tool
->m_item
,
620 wxGTK_CONV( helpString
), "");
624 // ----------------------------------------------------------------------------
625 // wxToolBar idle handling
626 // ----------------------------------------------------------------------------
628 void wxToolBar::OnInternalIdle()
630 wxCursor cursor
= m_cursor
;
631 if (g_globalCursor
.Ok()) cursor
= g_globalCursor
;
635 /* I now set the cursor the anew in every OnInternalIdle call
636 as setting the cursor in a parent window also effects the
637 windows above so that checking for the current cursor is
640 if (HasFlag(wxTB_DOCKABLE
) && (m_widget
->window
))
642 /* if the toolbar is dockable, then m_widget stands for the
643 GtkHandleBox widget, which uses its own window so that we
644 can set the cursor for it. if the toolbar is not dockable,
645 m_widget comes from m_toolbar which uses its parent's
646 window ("windowless windows") and thus we cannot set the
648 gdk_window_set_cursor( m_widget
->window
, cursor
.GetCursor() );
651 wxToolBarToolsList::compatibility_iterator node
= m_tools
.GetFirst();
654 wxToolBarTool
*tool
= (wxToolBarTool
*)node
->GetData();
655 node
= node
->GetNext();
657 GtkWidget
*item
= tool
->m_item
;
660 GdkWindow
*window
= item
->window
;
664 gdk_window_set_cursor( window
, cursor
.GetCursor() );
670 if (wxUpdateUIEvent::CanUpdate(this))
671 UpdateWindowUI(wxUPDATE_UI_FROMIDLE
);
675 // ----------------------------------------------------------------------------
679 wxToolBar::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
682 return GetDefaultAttributesFromGTKWidget(gtk_toolbar_new
);
684 wxVisualAttributes attr
;
685 GtkWidget
* widget
= gtk_toolbar_new(GTK_ORIENTATION_HORIZONTAL
, GTK_TOOLBAR_BOTH
);
686 attr
= GetDefaultAttributesFromGTKWidget(widget
);
687 gtk_widget_destroy(widget
);
692 #endif // wxUSE_TOOLBAR_NATIVE