]> git.saurik.com Git - wxWidgets.git/blob - src/gtk1/tbargtk.cpp
Some doc corrections
[wxWidgets.git] / src / gtk1 / tbargtk.cpp
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: tbargtk.cpp
3 // Purpose: GTK toolbar
4 // Author: Robert Roebling
5 // Modified: 13.12.99 by VZ to derive from wxToolBarBase
6 // RCS-ID: $Id$
7 // Copyright: (c) Robert Roebling
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
10
11 // ============================================================================
12 // declarations
13 // ============================================================================
14
15 // ----------------------------------------------------------------------------
16 // headers
17 // ----------------------------------------------------------------------------
18
19 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
20 #pragma implementation "tbargtk.h"
21 #endif
22
23 // For compilers that support precompilation, includes "wx.h".
24 #include "wx/wxprec.h"
25
26 #include "wx/toolbar.h"
27
28 #if wxUSE_TOOLBAR_NATIVE
29
30 #include "wx/frame.h"
31
32 #include <glib.h>
33 #include "wx/gtk/private.h"
34
35 extern GdkFont *GtkGetDefaultGuiFont();
36
37 // ----------------------------------------------------------------------------
38 // globals
39 // ----------------------------------------------------------------------------
40
41 // idle system
42 extern void wxapp_install_idle_handler();
43 extern bool g_isIdle;
44
45 // data
46 extern bool g_blockEventsOnDrag;
47 extern wxCursor g_globalCursor;
48
49 // ----------------------------------------------------------------------------
50 // private functions
51 // ----------------------------------------------------------------------------
52
53 // translate wxWindows toolbar style flags to GTK orientation and style
54 static void GetGtkStyle(long style,
55 GtkOrientation *orient, GtkToolbarStyle *gtkStyle)
56 {
57 *orient = style & wxTB_VERTICAL ? GTK_ORIENTATION_VERTICAL
58 : GTK_ORIENTATION_HORIZONTAL;
59
60
61 if ( style & wxTB_TEXT )
62 {
63 *gtkStyle = style & wxTB_NOICONS
64 ? GTK_TOOLBAR_TEXT
65 : (
66 #ifdef __WXGTK20__
67 style & wxTB_HORZ_LAYOUT ? GTK_TOOLBAR_BOTH_HORIZ :
68 #endif // __WXGTK20__
69 GTK_TOOLBAR_BOTH);
70 }
71 else // no text, hence we must have the icons or what would we show?
72 {
73 *gtkStyle = GTK_TOOLBAR_ICONS;
74 }
75 }
76
77 // ----------------------------------------------------------------------------
78 // wxToolBarTool
79 // ----------------------------------------------------------------------------
80
81 class wxToolBarTool : public wxToolBarToolBase
82 {
83 public:
84 wxToolBarTool(wxToolBar *tbar,
85 int id,
86 const wxString& label,
87 const wxBitmap& bitmap1,
88 const wxBitmap& bitmap2,
89 wxItemKind kind,
90 wxObject *clientData,
91 const wxString& shortHelpString,
92 const wxString& longHelpString)
93 : wxToolBarToolBase(tbar, id, label, bitmap1, bitmap2, kind,
94 clientData, shortHelpString, longHelpString)
95 {
96 Init();
97 }
98
99 wxToolBarTool(wxToolBar *tbar, wxControl *control)
100 : wxToolBarToolBase(tbar, control)
101 {
102 Init();
103 }
104
105 // is this a radio button?
106 //
107 // unlike GetKind(), can be called for any kind of tools, not just buttons
108 bool IsRadio() const { return IsButton() && GetKind() == wxITEM_RADIO; }
109
110 // this is only called for the normal buttons, i.e. not separators nor
111 // controls
112 GtkToolbarChildType GetGtkChildType() const
113 {
114 switch ( GetKind() )
115 {
116 case wxITEM_CHECK:
117 return GTK_TOOLBAR_CHILD_TOGGLEBUTTON;
118
119 case wxITEM_RADIO:
120 return GTK_TOOLBAR_CHILD_RADIOBUTTON;
121
122 default:
123 wxFAIL_MSG( _T("unknown toolbar child type") );
124 // fall through
125
126 case wxITEM_NORMAL:
127 return GTK_TOOLBAR_CHILD_BUTTON;
128 }
129 }
130
131 GtkWidget *m_item;
132 GtkWidget *m_pixmap;
133
134 protected:
135 void Init();
136 };
137
138 // ----------------------------------------------------------------------------
139 // wxWin macros
140 // ----------------------------------------------------------------------------
141
142 IMPLEMENT_DYNAMIC_CLASS(wxToolBar, wxControl)
143
144 // ============================================================================
145 // implementation
146 // ============================================================================
147
148 //-----------------------------------------------------------------------------
149 // "clicked" (internal from gtk_toolbar)
150 //-----------------------------------------------------------------------------
151
152 static void gtk_toolbar_callback( GtkWidget *WXUNUSED(widget),
153 wxToolBarTool *tool )
154 {
155 if (g_isIdle)
156 wxapp_install_idle_handler();
157
158 wxToolBar *tbar = (wxToolBar *)tool->GetToolBar();
159
160 if (tbar->m_blockEvent) return;
161
162 if (g_blockEventsOnDrag) return;
163 if (!tool->IsEnabled()) return;
164
165 if (tool->CanBeToggled())
166 {
167 tool->Toggle();
168
169 wxBitmap bitmap = tool->GetBitmap();
170 if ( bitmap.Ok() )
171 {
172 GtkPixmap *pixmap = GTK_PIXMAP( tool->m_pixmap );
173
174 GdkBitmap *mask = bitmap.GetMask() ? bitmap.GetMask()->GetBitmap()
175 : (GdkBitmap *)NULL;
176
177 gtk_pixmap_set( pixmap, bitmap.GetPixmap(), mask );
178 }
179
180 if ( tool->IsRadio() && !tool->IsToggled() )
181 {
182 // radio button went up, don't report this as a wxWin event
183 return;
184 }
185 }
186
187 if( !tbar->OnLeftClick( tool->GetId(), tool->IsToggled() ) && tool->CanBeToggled() )
188 {
189 // revert back
190 tool->Toggle();
191
192 wxBitmap bitmap = tool->GetBitmap();
193 if ( bitmap.Ok() )
194 {
195 GtkPixmap *pixmap = GTK_PIXMAP( tool->m_pixmap );
196
197 GdkBitmap *mask = bitmap.GetMask() ? bitmap.GetMask()->GetBitmap()
198 : (GdkBitmap *)NULL;
199
200 gtk_pixmap_set( pixmap, bitmap.GetPixmap(), mask );
201 }
202 }
203 }
204
205 //-----------------------------------------------------------------------------
206 // "enter_notify_event" / "leave_notify_event"
207 //-----------------------------------------------------------------------------
208
209 static gint gtk_toolbar_tool_callback( GtkWidget *WXUNUSED(widget),
210 GdkEventCrossing *gdk_event,
211 wxToolBarTool *tool )
212 {
213 if (g_isIdle) wxapp_install_idle_handler();
214
215 if (g_blockEventsOnDrag) return TRUE;
216
217 wxToolBar *tb = (wxToolBar *)tool->GetToolBar();
218
219 // emit the event
220 if( gdk_event->type == GDK_ENTER_NOTIFY )
221 tb->OnMouseEnter( tool->GetId() );
222 else
223 tb->OnMouseEnter( -1 );
224
225 return FALSE;
226 }
227
228 //-----------------------------------------------------------------------------
229 // InsertChild callback for wxToolBar
230 //-----------------------------------------------------------------------------
231
232 static void wxInsertChildInToolBar( wxToolBar* WXUNUSED(parent),
233 wxWindow* WXUNUSED(child) )
234 {
235 // we don't do anything here
236 }
237
238 // ----------------------------------------------------------------------------
239 // wxToolBarTool
240 // ----------------------------------------------------------------------------
241
242 void wxToolBarTool::Init()
243 {
244 m_item =
245 m_pixmap = (GtkWidget *)NULL;
246 }
247
248 wxToolBarToolBase *wxToolBar::CreateTool(int id,
249 const wxString& text,
250 const wxBitmap& bitmap1,
251 const wxBitmap& bitmap2,
252 wxItemKind kind,
253 wxObject *clientData,
254 const wxString& shortHelpString,
255 const wxString& longHelpString)
256 {
257 return new wxToolBarTool(this, id, text, bitmap1, bitmap2, kind,
258 clientData, shortHelpString, longHelpString);
259 }
260
261 wxToolBarToolBase *wxToolBar::CreateTool(wxControl *control)
262 {
263 return new wxToolBarTool(this, control);
264 }
265
266 //-----------------------------------------------------------------------------
267 // wxToolBar construction
268 //-----------------------------------------------------------------------------
269
270 void wxToolBar::Init()
271 {
272 m_fg =
273 m_bg = (GdkColor *)NULL;
274 m_toolbar = (GtkToolbar *)NULL;
275 m_blockEvent = FALSE;
276 m_defaultWidth = 32;
277 m_defaultHeight = 32;
278 }
279
280 wxToolBar::~wxToolBar()
281 {
282 delete m_fg;
283 delete m_bg;
284 }
285
286 bool wxToolBar::Create( wxWindow *parent,
287 wxWindowID id,
288 const wxPoint& pos,
289 const wxSize& size,
290 long style,
291 const wxString& name )
292 {
293 m_needParent = TRUE;
294 m_insertCallback = (wxInsertChildFunction)wxInsertChildInToolBar;
295
296 if ( !PreCreation( parent, pos, size ) ||
297 !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))
298 {
299 wxFAIL_MSG( wxT("wxToolBar creation failed") );
300
301 return FALSE;
302 }
303
304 #ifdef __WXGTK20__
305 m_toolbar = GTK_TOOLBAR( gtk_toolbar_new() );
306 GtkSetStyle();
307
308 // Doesn't work this way.
309 // GtkToolbarSpaceStyle space_style = GTK_TOOLBAR_SPACE_EMPTY;
310 // gtk_widget_style_set (GTK_WIDGET (m_toolbar), "space_style", &space_style, NULL);
311 #else
312 GtkOrientation orient;
313 GtkToolbarStyle gtkStyle;
314 GetGtkStyle(style, &orient, &gtkStyle);
315
316 m_toolbar = GTK_TOOLBAR( gtk_toolbar_new(orient, gtkStyle) );
317 #endif
318
319 SetToolSeparation(7);
320
321 if (style & wxTB_DOCKABLE)
322 {
323 m_widget = gtk_handle_box_new();
324 gtk_container_add( GTK_CONTAINER(m_widget), GTK_WIDGET(m_toolbar) );
325 gtk_widget_show( GTK_WIDGET(m_toolbar) );
326
327 if (style & wxTB_FLAT)
328 gtk_handle_box_set_shadow_type( GTK_HANDLE_BOX(m_widget), GTK_SHADOW_NONE );
329 }
330 else
331 {
332 m_widget = gtk_event_box_new();
333 gtk_container_add( GTK_CONTAINER(m_widget), GTK_WIDGET(m_toolbar) );
334 ConnectWidget( m_widget );
335 gtk_widget_show(GTK_WIDGET(m_toolbar));
336 }
337
338 gtk_toolbar_set_tooltips( GTK_TOOLBAR(m_toolbar), TRUE );
339
340 // FIXME: there is no such function for toolbars in 2.0
341 #ifndef __WXGTK20__
342 if (style & wxTB_FLAT)
343 gtk_toolbar_set_button_relief( GTK_TOOLBAR(m_toolbar), GTK_RELIEF_NONE );
344 #endif
345
346
347 m_fg = new GdkColor;
348 m_fg->red = 0;
349 m_fg->green = 0;
350 m_fg->blue = 0;
351 wxColour fg(0,0,0);
352 fg.CalcPixel( gtk_widget_get_colormap( GTK_WIDGET(m_toolbar) ) );
353 m_fg->pixel = fg.GetPixel();
354
355 m_bg = new GdkColor;
356 m_bg->red = 65535;
357 m_bg->green = 65535;
358 m_bg->blue = 49980;
359 wxColour bg(255,255,196);
360 bg.CalcPixel( gtk_widget_get_colormap( GTK_WIDGET(m_toolbar) ) );
361 m_bg->pixel = bg.GetPixel();
362
363 gtk_tooltips_force_window( GTK_TOOLBAR(m_toolbar)->tooltips );
364
365 GtkStyle *g_style =
366 gtk_style_copy(
367 gtk_widget_get_style(
368 GTK_TOOLBAR(m_toolbar)->tooltips->tip_window ) );
369
370 g_style->bg[GTK_STATE_NORMAL] = *m_bg;
371
372 gtk_widget_set_style( GTK_TOOLBAR(m_toolbar)->tooltips->tip_window, g_style );
373
374 m_parent->DoAddChild( this );
375
376 PostCreation();
377
378 Show( TRUE );
379
380 return TRUE;
381 }
382
383 void wxToolBar::GtkSetStyle()
384 {
385 GtkOrientation orient;
386 GtkToolbarStyle style;
387 GetGtkStyle(GetWindowStyle(), &orient, &style);
388
389 gtk_toolbar_set_orientation(m_toolbar, orient);
390 gtk_toolbar_set_style(m_toolbar, style);
391 }
392
393 void wxToolBar::SetWindowStyleFlag( long style )
394 {
395 wxToolBarBase::SetWindowStyleFlag(style);
396
397 if ( m_toolbar )
398 GtkSetStyle();
399 }
400
401 bool wxToolBar::DoInsertTool(size_t pos, wxToolBarToolBase *toolBase)
402 {
403 wxToolBarTool *tool = (wxToolBarTool *)toolBase;
404
405 #ifndef __WXGTK20__
406 // if we have inserted a space before all the tools we must change the GTK
407 // index by 1
408 size_t posGtk = m_xMargin > 1 ? pos + 1 : pos;
409 #else
410 size_t posGtk = pos;
411 #endif
412
413 if ( tool->IsButton() )
414 {
415 if ( !HasFlag(wxTB_NOICONS) )
416 {
417 wxBitmap bitmap = tool->GetNormalBitmap();
418
419 wxCHECK_MSG( bitmap.Ok(), FALSE,
420 wxT("invalid bitmap for wxToolBar icon") );
421
422 wxCHECK_MSG( bitmap.GetBitmap() == NULL, FALSE,
423 wxT("wxToolBar doesn't support GdkBitmap") );
424
425 wxCHECK_MSG( bitmap.GetPixmap() != NULL, FALSE,
426 wxT("wxToolBar::Add needs a wxBitmap") );
427
428 GtkWidget *tool_pixmap = (GtkWidget *)NULL;
429
430 GdkPixmap *pixmap = bitmap.GetPixmap();
431
432 GdkBitmap *mask = (GdkBitmap *)NULL;
433 if ( bitmap.GetMask() )
434 mask = bitmap.GetMask()->GetBitmap();
435
436 tool_pixmap = gtk_pixmap_new( pixmap, mask );
437 gtk_pixmap_set_build_insensitive( GTK_PIXMAP(tool_pixmap), TRUE );
438
439 gtk_misc_set_alignment( GTK_MISC(tool_pixmap), 0.5, 0.5 );
440
441 tool->m_pixmap = tool_pixmap;
442 }
443 }
444
445 switch ( tool->GetStyle() )
446 {
447 case wxTOOL_STYLE_BUTTON:
448 // for a radio button we need the widget which starts the radio
449 // group it belongs to, i.e. the first radio button immediately
450 // preceding this one
451 {
452 GtkWidget *widget = NULL;
453
454 if ( tool->IsRadio() )
455 {
456 wxToolBarToolsList::compatibility_iterator node
457 = wxToolBarToolsList::compatibility_iterator();
458 if ( pos ) node = m_tools.Item(pos - 1);
459
460 while ( node )
461 {
462 wxToolBarTool *tool = (wxToolBarTool *)node->GetData();
463 if ( !tool->IsRadio() )
464 break;
465
466 widget = tool->m_item;
467
468 node = node->GetPrevious();
469 }
470
471 if ( !widget )
472 {
473 // this is the first button in the radio button group,
474 // it will be toggled automatically by GTK so bring the
475 // internal flag in sync
476 tool->Toggle(TRUE);
477 }
478 }
479
480 tool->m_item = gtk_toolbar_insert_element
481 (
482 m_toolbar,
483 tool->GetGtkChildType(),
484 widget,
485 tool->GetLabel().empty()
486 ? NULL
487 : (const char*) wxGTK_CONV( tool->GetLabel() ),
488 tool->GetShortHelp().empty()
489 ? NULL
490 : (const char*) wxGTK_CONV( tool->GetShortHelp() ),
491 "", // tooltip_private_text (?)
492 tool->m_pixmap,
493 (GtkSignalFunc)gtk_toolbar_callback,
494 (gpointer)tool,
495 posGtk
496 );
497
498 if ( !tool->m_item )
499 {
500 wxFAIL_MSG( _T("gtk_toolbar_insert_element() failed") );
501
502 return FALSE;
503 }
504
505 gtk_signal_connect( GTK_OBJECT(tool->m_item),
506 "enter_notify_event",
507 GTK_SIGNAL_FUNC(gtk_toolbar_tool_callback),
508 (gpointer)tool );
509 gtk_signal_connect( GTK_OBJECT(tool->m_item),
510 "leave_notify_event",
511 GTK_SIGNAL_FUNC(gtk_toolbar_tool_callback),
512 (gpointer)tool );
513 }
514 break;
515
516 case wxTOOL_STYLE_SEPARATOR:
517 gtk_toolbar_insert_space( m_toolbar, posGtk );
518
519 // skip the rest
520 return TRUE;
521
522 case wxTOOL_STYLE_CONTROL:
523 gtk_toolbar_insert_widget(
524 m_toolbar,
525 tool->GetControl()->m_widget,
526 (const char *) NULL,
527 (const char *) NULL,
528 posGtk
529 );
530 break;
531 }
532
533 GtkRequisition req;
534 (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget) )->size_request )
535 (m_widget, &req );
536 m_width = req.width + m_xMargin;
537 m_height = req.height + 2*m_yMargin;
538
539 return TRUE;
540 }
541
542 bool wxToolBar::DoDeleteTool(size_t WXUNUSED(pos), wxToolBarToolBase *toolBase)
543 {
544 wxToolBarTool *tool = (wxToolBarTool *)toolBase;
545
546 switch ( tool->GetStyle() )
547 {
548 case wxTOOL_STYLE_CONTROL:
549 tool->GetControl()->Destroy();
550 break;
551
552 case wxTOOL_STYLE_BUTTON:
553 gtk_widget_destroy( tool->m_item );
554 break;
555
556 //case wxTOOL_STYLE_SEPARATOR: -- nothing to do
557 }
558
559 return TRUE;
560 }
561
562 // ----------------------------------------------------------------------------
563 // wxToolBar tools state
564 // ----------------------------------------------------------------------------
565
566 void wxToolBar::DoEnableTool(wxToolBarToolBase *toolBase, bool enable)
567 {
568 wxToolBarTool *tool = (wxToolBarTool *)toolBase;
569
570 if (tool->m_item)
571 {
572 gtk_widget_set_sensitive( tool->m_item, enable );
573 }
574 }
575
576 void wxToolBar::DoToggleTool( wxToolBarToolBase *toolBase, bool toggle )
577 {
578 wxToolBarTool *tool = (wxToolBarTool *)toolBase;
579
580 GtkWidget *item = tool->m_item;
581 if ( item && GTK_IS_TOGGLE_BUTTON(item) )
582 {
583 wxBitmap bitmap = tool->GetBitmap();
584 if ( bitmap.Ok() )
585 {
586 GtkPixmap *pixmap = GTK_PIXMAP( tool->m_pixmap );
587
588 GdkBitmap *mask = bitmap.GetMask() ? bitmap.GetMask()->GetBitmap()
589 : (GdkBitmap *)NULL;
590
591 gtk_pixmap_set( pixmap, bitmap.GetPixmap(), mask );
592 }
593
594 m_blockEvent = TRUE;
595
596 gtk_toggle_button_set_state( GTK_TOGGLE_BUTTON(item), toggle );
597
598 m_blockEvent = FALSE;
599 }
600 }
601
602 void wxToolBar::DoSetToggle(wxToolBarToolBase * WXUNUSED(tool),
603 bool WXUNUSED(toggle))
604 {
605 // VZ: absolutely no idea about how to do it
606 wxFAIL_MSG( _T("not implemented") );
607 }
608
609 // ----------------------------------------------------------------------------
610 // wxToolBar geometry
611 // ----------------------------------------------------------------------------
612
613 wxToolBarToolBase *wxToolBar::FindToolForPosition(wxCoord WXUNUSED(x),
614 wxCoord WXUNUSED(y)) const
615 {
616 // VZ: GTK+ doesn't seem to have such thing
617 wxFAIL_MSG( _T("wxToolBar::FindToolForPosition() not implemented") );
618
619 return (wxToolBarToolBase *)NULL;
620 }
621
622 void wxToolBar::SetMargins( int x, int y )
623 {
624 wxCHECK_RET( GetToolsCount() == 0,
625 wxT("wxToolBar::SetMargins must be called before adding tools.") );
626
627 #ifndef __WXGTK20__
628 if (x > 1)
629 gtk_toolbar_append_space( m_toolbar ); // oh well
630 #endif
631
632 m_xMargin = x;
633 m_yMargin = y;
634 }
635
636 void wxToolBar::SetToolSeparation( int separation )
637 {
638 // FIXME: this function disappeared
639 #ifndef __WXGTK20__
640 gtk_toolbar_set_space_size( m_toolbar, separation );
641 #endif
642
643 m_toolSeparation = separation;
644 }
645
646 void wxToolBar::SetToolShortHelp( int id, const wxString& helpString )
647 {
648 wxToolBarTool *tool = (wxToolBarTool *)FindById(id);
649
650 if ( tool )
651 {
652 (void)tool->SetShortHelp(helpString);
653 gtk_tooltips_set_tip(m_toolbar->tooltips, tool->m_item,
654 wxGTK_CONV( helpString ), "");
655 }
656 }
657
658 // ----------------------------------------------------------------------------
659 // wxToolBar idle handling
660 // ----------------------------------------------------------------------------
661
662 void wxToolBar::OnInternalIdle()
663 {
664 wxCursor cursor = m_cursor;
665 if (g_globalCursor.Ok()) cursor = g_globalCursor;
666
667 if (cursor.Ok())
668 {
669 /* I now set the cursor the anew in every OnInternalIdle call
670 as setting the cursor in a parent window also effects the
671 windows above so that checking for the current cursor is
672 not possible. */
673
674 if (HasFlag(wxTB_DOCKABLE) && (m_widget->window))
675 {
676 /* if the toolbar is dockable, then m_widget stands for the
677 GtkHandleBox widget, which uses its own window so that we
678 can set the cursor for it. if the toolbar is not dockable,
679 m_widget comes from m_toolbar which uses its parent's
680 window ("windowless windows") and thus we cannot set the
681 cursor. */
682 gdk_window_set_cursor( m_widget->window, cursor.GetCursor() );
683 }
684
685 wxToolBarToolsList::compatibility_iterator node = m_tools.GetFirst();
686 while ( node )
687 {
688 wxToolBarTool *tool = (wxToolBarTool *)node->GetData();
689 node = node->GetNext();
690
691 GtkWidget *item = tool->m_item;
692 if ( item )
693 {
694 GdkWindow *window = item->window;
695
696 if ( window )
697 {
698 gdk_window_set_cursor( window, cursor.GetCursor() );
699 }
700 }
701 }
702 }
703
704 if (wxUpdateUIEvent::CanUpdate(this))
705 UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
706 }
707
708 #endif // wxUSE_TOOLBAR_NATIVE