1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/gtk1/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"
31 #include "wx/gtk1/private.h"
33 // ----------------------------------------------------------------------------
35 // ----------------------------------------------------------------------------
38 extern void wxapp_install_idle_handler();
42 extern bool g_blockEventsOnDrag
;
43 extern wxCursor g_globalCursor
;
45 // ----------------------------------------------------------------------------
47 // ----------------------------------------------------------------------------
49 // translate wxWidgets toolbar style flags to GTK orientation and style
50 static void GetGtkStyle(long style
,
51 GtkOrientation
*orient
, GtkToolbarStyle
*gtkStyle
)
53 *orient
= style
& wxTB_VERTICAL
? GTK_ORIENTATION_VERTICAL
54 : GTK_ORIENTATION_HORIZONTAL
;
57 if ( style
& wxTB_TEXT
)
59 *gtkStyle
= style
& wxTB_NOICONS
63 else // no text, hence we must have the icons or what would we show?
65 *gtkStyle
= GTK_TOOLBAR_ICONS
;
69 // ----------------------------------------------------------------------------
71 // ----------------------------------------------------------------------------
73 class wxToolBarTool
: public wxToolBarToolBase
76 wxToolBarTool(wxToolBar
*tbar
,
78 const wxString
& label
,
79 const wxBitmap
& bitmap1
,
80 const wxBitmap
& bitmap2
,
83 const wxString
& shortHelpString
,
84 const wxString
& longHelpString
)
85 : wxToolBarToolBase(tbar
, id
, label
, bitmap1
, bitmap2
, kind
,
86 clientData
, shortHelpString
, longHelpString
)
91 wxToolBarTool(wxToolBar
*tbar
, wxControl
*control
, const wxString
& label
)
92 : wxToolBarToolBase(tbar
, control
, label
)
97 // is this a radio button?
99 // unlike GetKind(), can be called for any kind of tools, not just buttons
100 bool IsRadio() const { return IsButton() && GetKind() == wxITEM_RADIO
; }
102 // this is only called for the normal buttons, i.e. not separators nor
104 GtkToolbarChildType
GetGtkChildType() const
109 return GTK_TOOLBAR_CHILD_TOGGLEBUTTON
;
112 return GTK_TOOLBAR_CHILD_RADIOBUTTON
;
115 wxFAIL_MSG( _T("unknown toolbar child type") );
119 return GTK_TOOLBAR_CHILD_BUTTON
;
123 void SetPixmap(const wxBitmap
& bitmap
)
127 GdkBitmap
*mask
= bitmap
.GetMask() ? bitmap
.GetMask()->GetBitmap()
129 gtk_pixmap_set( GTK_PIXMAP(m_pixmap
), bitmap
.GetPixmap(), mask
);
140 // ----------------------------------------------------------------------------
142 // ----------------------------------------------------------------------------
144 IMPLEMENT_DYNAMIC_CLASS(wxToolBar
, wxControl
)
146 // ============================================================================
148 // ============================================================================
150 //-----------------------------------------------------------------------------
151 // "clicked" (internal from gtk_toolbar)
152 //-----------------------------------------------------------------------------
155 static void gtk_toolbar_callback( GtkWidget
*WXUNUSED(widget
),
156 wxToolBarTool
*tool
)
159 wxapp_install_idle_handler();
161 wxToolBar
*tbar
= (wxToolBar
*)tool
->GetToolBar();
163 if (tbar
->m_blockEvent
) return;
165 if (g_blockEventsOnDrag
) return;
166 if (!tool
->IsEnabled()) return;
168 if (tool
->CanBeToggled())
172 tool
->SetPixmap(tool
->GetBitmap());
174 if ( tool
->IsRadio() && !tool
->IsToggled() )
176 // radio button went up, don't report this as a wxWin event
181 if( !tbar
->OnLeftClick( tool
->GetId(), tool
->IsToggled() ) && tool
->CanBeToggled() )
186 tool
->SetPixmap(tool
->GetBitmap());
191 //-----------------------------------------------------------------------------
192 // "enter_notify_event" / "leave_notify_event"
193 //-----------------------------------------------------------------------------
196 static gint
gtk_toolbar_tool_callback( GtkWidget
*WXUNUSED(widget
),
197 GdkEventCrossing
*gdk_event
,
198 wxToolBarTool
*tool
)
200 if (g_isIdle
) wxapp_install_idle_handler();
202 if (g_blockEventsOnDrag
) return TRUE
;
204 wxToolBar
*tb
= (wxToolBar
*)tool
->GetToolBar();
207 if( gdk_event
->type
== GDK_ENTER_NOTIFY
)
208 tb
->OnMouseEnter( tool
->GetId() );
210 tb
->OnMouseEnter( -1 );
216 //-----------------------------------------------------------------------------
217 // InsertChild callback for wxToolBar
218 //-----------------------------------------------------------------------------
220 static void wxInsertChildInToolBar( wxToolBar
* WXUNUSED(parent
),
221 wxWindow
* WXUNUSED(child
) )
223 // we don't do anything here
226 // ----------------------------------------------------------------------------
228 // ----------------------------------------------------------------------------
230 void wxToolBarTool::Init()
233 m_pixmap
= (GtkWidget
*)NULL
;
236 wxToolBarToolBase
*wxToolBar::CreateTool(int id
,
237 const wxString
& text
,
238 const wxBitmap
& bitmap1
,
239 const wxBitmap
& bitmap2
,
241 wxObject
*clientData
,
242 const wxString
& shortHelpString
,
243 const wxString
& longHelpString
)
245 return new wxToolBarTool(this, id
, text
, bitmap1
, bitmap2
, kind
,
246 clientData
, shortHelpString
, longHelpString
);
250 wxToolBar::CreateTool(wxControl
*control
, const wxString
& label
)
252 return new wxToolBarTool(this, control
, label
);
255 //-----------------------------------------------------------------------------
256 // wxToolBar construction
257 //-----------------------------------------------------------------------------
259 void wxToolBar::Init()
261 m_toolbar
= (GtkToolbar
*)NULL
;
262 m_blockEvent
= false;
264 m_defaultHeight
= 32;
267 wxToolBar::~wxToolBar()
271 bool wxToolBar::Create( wxWindow
*parent
,
276 const wxString
& name
)
279 m_insertCallback
= (wxInsertChildFunction
)wxInsertChildInToolBar
;
281 if ( !PreCreation( parent
, pos
, size
) ||
282 !CreateBase( parent
, id
, pos
, size
, style
, wxDefaultValidator
, name
))
284 wxFAIL_MSG( wxT("wxToolBar creation failed") );
291 GtkOrientation orient
;
292 GtkToolbarStyle gtkStyle
;
293 GetGtkStyle(style
, &orient
, >kStyle
);
295 m_toolbar
= GTK_TOOLBAR( gtk_toolbar_new(orient
, gtkStyle
) );
297 SetToolSeparation(7);
299 if (style
& wxTB_DOCKABLE
)
301 m_widget
= gtk_handle_box_new();
302 gtk_container_add( GTK_CONTAINER(m_widget
), GTK_WIDGET(m_toolbar
) );
303 gtk_widget_show( GTK_WIDGET(m_toolbar
) );
305 if (style
& wxTB_FLAT
)
306 gtk_handle_box_set_shadow_type( GTK_HANDLE_BOX(m_widget
), GTK_SHADOW_NONE
);
310 m_widget
= gtk_event_box_new();
311 gtk_container_add( GTK_CONTAINER(m_widget
), GTK_WIDGET(m_toolbar
) );
312 ConnectWidget( m_widget
);
313 gtk_widget_show(GTK_WIDGET(m_toolbar
));
316 gtk_toolbar_set_tooltips( GTK_TOOLBAR(m_toolbar
), TRUE
);
318 if (style
& wxTB_FLAT
)
319 gtk_toolbar_set_button_relief( GTK_TOOLBAR(m_toolbar
), GTK_RELIEF_NONE
);
321 m_parent
->DoAddChild( this );
328 void wxToolBar::GtkSetStyle()
330 GtkOrientation orient
;
331 GtkToolbarStyle style
;
332 GetGtkStyle(GetWindowStyle(), &orient
, &style
);
334 gtk_toolbar_set_orientation(m_toolbar
, orient
);
335 gtk_toolbar_set_style(m_toolbar
, style
);
338 void wxToolBar::SetWindowStyleFlag( long style
)
340 wxToolBarBase::SetWindowStyleFlag(style
);
346 bool wxToolBar::DoInsertTool(size_t pos
, wxToolBarToolBase
*toolBase
)
348 wxToolBarTool
*tool
= (wxToolBarTool
*)toolBase
;
350 // if we have inserted a space before all the tools we must change the GTK
352 size_t posGtk
= m_xMargin
> 1 ? pos
+ 1 : pos
;
354 if ( tool
->IsButton() )
356 if ( !HasFlag(wxTB_NOICONS
) )
358 wxBitmap bitmap
= tool
->GetNormalBitmap();
360 wxCHECK_MSG( bitmap
.Ok(), false,
361 wxT("invalid bitmap for wxToolBar icon") );
363 wxCHECK_MSG( bitmap
.GetBitmap() == NULL
, false,
364 wxT("wxToolBar doesn't support GdkBitmap") );
366 wxCHECK_MSG( bitmap
.GetPixmap() != NULL
, false,
367 wxT("wxToolBar::Add needs a wxBitmap") );
369 GtkWidget
*tool_pixmap
= (GtkWidget
*)NULL
;
371 GdkPixmap
*pixmap
= bitmap
.GetPixmap();
373 GdkBitmap
*mask
= (GdkBitmap
*)NULL
;
374 if ( bitmap
.GetMask() )
375 mask
= bitmap
.GetMask()->GetBitmap();
377 tool_pixmap
= gtk_pixmap_new( pixmap
, mask
);
378 gtk_pixmap_set_build_insensitive( GTK_PIXMAP(tool_pixmap
), TRUE
);
380 gtk_misc_set_alignment( GTK_MISC(tool_pixmap
), 0.5, 0.5 );
382 tool
->m_pixmap
= tool_pixmap
;
386 switch ( tool
->GetStyle() )
388 case wxTOOL_STYLE_BUTTON
:
389 // for a radio button we need the widget which starts the radio
390 // group it belongs to, i.e. the first radio button immediately
391 // preceding this one
393 GtkWidget
*widget
= NULL
;
395 if ( tool
->IsRadio() )
397 wxToolBarToolsList::compatibility_iterator node
398 = wxToolBarToolsList::compatibility_iterator();
400 node
= m_tools
.Item(pos
- 1);
404 wxToolBarTool
*toolNext
= (wxToolBarTool
*)node
->GetData();
405 if ( !toolNext
->IsRadio() )
408 widget
= toolNext
->m_item
;
410 node
= node
->GetPrevious();
415 // this is the first button in the radio button group,
416 // it will be toggled automatically by GTK so bring the
417 // internal flag in sync
422 tool
->m_item
= gtk_toolbar_insert_element
425 tool
->GetGtkChildType(),
427 tool
->GetLabel().empty()
429 : (const char*) wxGTK_CONV( tool
->GetLabel() ),
430 tool
->GetShortHelp().empty()
432 : (const char*) wxGTK_CONV( tool
->GetShortHelp() ),
433 "", // tooltip_private_text (?)
435 (GtkSignalFunc
)gtk_toolbar_callback
,
442 wxFAIL_MSG( _T("gtk_toolbar_insert_element() failed") );
447 gtk_signal_connect( GTK_OBJECT(tool
->m_item
),
448 "enter_notify_event",
449 GTK_SIGNAL_FUNC(gtk_toolbar_tool_callback
),
451 gtk_signal_connect( GTK_OBJECT(tool
->m_item
),
452 "leave_notify_event",
453 GTK_SIGNAL_FUNC(gtk_toolbar_tool_callback
),
458 case wxTOOL_STYLE_SEPARATOR
:
459 gtk_toolbar_insert_space( m_toolbar
, posGtk
);
464 case wxTOOL_STYLE_CONTROL
:
465 gtk_toolbar_insert_widget(
467 tool
->GetControl()->m_widget
,
476 (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget
) )->size_request
)
478 m_width
= req
.width
+ m_xMargin
;
479 m_height
= req
.height
+ 2*m_yMargin
;
480 InvalidateBestSize();
485 bool wxToolBar::DoDeleteTool(size_t WXUNUSED(pos
), wxToolBarToolBase
*toolBase
)
487 wxToolBarTool
*tool
= (wxToolBarTool
*)toolBase
;
489 switch ( tool
->GetStyle() )
491 case wxTOOL_STYLE_CONTROL
:
492 // don't destroy the control here as we can be called from
493 // RemoveTool() and then we need to keep the control alive;
494 // while if we're called from DeleteTool() the control will
495 // be destroyed when wxToolBarToolBase itself is deleted
498 case wxTOOL_STYLE_BUTTON
:
499 gtk_widget_destroy( tool
->m_item
);
503 wxFAIL_MSG( "unknown tool style" );
507 InvalidateBestSize();
511 // ----------------------------------------------------------------------------
512 // wxToolBar tools state
513 // ----------------------------------------------------------------------------
515 void wxToolBar::DoEnableTool(wxToolBarToolBase
*toolBase
, bool enable
)
517 wxToolBarTool
*tool
= (wxToolBarTool
*)toolBase
;
521 gtk_widget_set_sensitive( tool
->m_item
, enable
);
525 void wxToolBar::DoToggleTool( wxToolBarToolBase
*toolBase
, bool toggle
)
527 wxToolBarTool
*tool
= (wxToolBarTool
*)toolBase
;
529 GtkWidget
*item
= tool
->m_item
;
530 if ( item
&& GTK_IS_TOGGLE_BUTTON(item
) )
532 tool
->SetPixmap(tool
->GetBitmap());
536 gtk_toggle_button_set_state( GTK_TOGGLE_BUTTON(item
), toggle
);
538 m_blockEvent
= false;
542 void wxToolBar::DoSetToggle(wxToolBarToolBase
* WXUNUSED(tool
),
543 bool WXUNUSED(toggle
))
545 // VZ: absolutely no idea about how to do it
546 wxFAIL_MSG( _T("not implemented") );
549 // ----------------------------------------------------------------------------
550 // wxToolBar geometry
551 // ----------------------------------------------------------------------------
553 wxToolBarToolBase
*wxToolBar::FindToolForPosition(wxCoord
WXUNUSED(x
),
554 wxCoord
WXUNUSED(y
)) const
556 // VZ: GTK+ doesn't seem to have such thing
557 wxFAIL_MSG( _T("wxToolBar::FindToolForPosition() not implemented") );
559 return (wxToolBarToolBase
*)NULL
;
562 void wxToolBar::SetMargins( int x
, int y
)
564 wxCHECK_RET( GetToolsCount() == 0,
565 wxT("wxToolBar::SetMargins must be called before adding tools.") );
568 gtk_toolbar_append_space( m_toolbar
); // oh well
574 void wxToolBar::SetToolSeparation( int separation
)
576 gtk_toolbar_set_space_size( m_toolbar
, separation
);
578 m_toolSeparation
= separation
;
581 void wxToolBar::SetToolShortHelp( int id
, const wxString
& helpString
)
583 wxToolBarTool
*tool
= (wxToolBarTool
*)FindById(id
);
587 (void)tool
->SetShortHelp(helpString
);
588 gtk_tooltips_set_tip(m_toolbar
->tooltips
, tool
->m_item
,
589 wxGTK_CONV( helpString
), "");
593 // ----------------------------------------------------------------------------
594 // wxToolBar idle handling
595 // ----------------------------------------------------------------------------
597 void wxToolBar::OnInternalIdle()
599 wxCursor cursor
= m_cursor
;
600 if (g_globalCursor
.Ok()) cursor
= g_globalCursor
;
604 /* I now set the cursor the anew in every OnInternalIdle call
605 as setting the cursor in a parent window also effects the
606 windows above so that checking for the current cursor is
609 if (HasFlag(wxTB_DOCKABLE
) && (m_widget
->window
))
611 /* if the toolbar is dockable, then m_widget stands for the
612 GtkHandleBox widget, which uses its own window so that we
613 can set the cursor for it. if the toolbar is not dockable,
614 m_widget comes from m_toolbar which uses its parent's
615 window ("windowless windows") and thus we cannot set the
617 gdk_window_set_cursor( m_widget
->window
, cursor
.GetCursor() );
620 wxToolBarToolsList::compatibility_iterator node
= m_tools
.GetFirst();
623 wxToolBarTool
*tool
= (wxToolBarTool
*)node
->GetData();
624 node
= node
->GetNext();
626 GtkWidget
*item
= tool
->m_item
;
629 GdkWindow
*window
= item
->window
;
633 gdk_window_set_cursor( window
, cursor
.GetCursor() );
639 if (wxUpdateUIEvent::CanUpdate(this))
640 UpdateWindowUI(wxUPDATE_UI_FROMIDLE
);
644 // ----------------------------------------------------------------------------
648 wxToolBar::GetClassDefaultAttributes(wxWindowVariant
WXUNUSED(variant
))
650 wxVisualAttributes attr
;
651 GtkWidget
* widget
= gtk_toolbar_new(GTK_ORIENTATION_HORIZONTAL
, GTK_TOOLBAR_BOTH
);
652 attr
= GetDefaultAttributesFromGTKWidget(widget
);
653 gtk_widget_destroy(widget
);
657 #endif // wxUSE_TOOLBAR_NATIVE