src/gtk/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 #ifdef __GNUG__
  20     #pragma implementation "tbargtk.h"
  21 #endif
  22
  23 #include "wx/toolbar.h"
  24
  25 #if wxUSE_TOOLBAR_NATIVE
  26
  27 #include "wx/frame.h"
  28
  29 #include "glib.h"
  30 #include "gdk/gdk.h"
  31 #include "gtk/gtk.h"
  32
  33 extern GdkFont *GtkGetDefaultGuiFont();
  34
  35 // ----------------------------------------------------------------------------
  36 // globals
  37 // ----------------------------------------------------------------------------
  38
  39 // idle system
  40 extern void wxapp_install_idle_handler();
  41 extern bool g_isIdle;
  42
  43 // data
  44 extern bool       g_blockEventsOnDrag;
  45 extern wxCursor   g_globalCursor;
  46
  47 // ----------------------------------------------------------------------------
  48 // wxToolBarTool
  49 // ----------------------------------------------------------------------------
  50
  51 class wxToolBarTool : public wxToolBarToolBase
  52 {
  53 public:
  54     wxToolBarTool(wxToolBar *tbar,
  55                   int id,
  56                   const wxBitmap& bitmap1,
  57                   const wxBitmap& bitmap2,
  58                   bool toggle,
  59                   wxObject *clientData,
  60                   const wxString& shortHelpString,
  61                   const wxString& longHelpString)
  62         : wxToolBarToolBase(tbar, id, bitmap1, bitmap2, toggle,
  63                             clientData, shortHelpString, longHelpString)
  64     {
  65         Init();
  66     }
  67
  68     wxToolBarTool(wxToolBar *tbar, wxControl *control)
  69         : wxToolBarToolBase(tbar, control)
  70     {
  71         Init();
  72     }
  73
  74     GtkWidget            *m_item;
  75     GtkWidget            *m_pixmap;
  76
  77 protected:
  78     void Init();
  79 };
  80
  81 // ----------------------------------------------------------------------------
  82 // wxWin macros
  83 // ----------------------------------------------------------------------------
  84
  85 IMPLEMENT_DYNAMIC_CLASS(wxToolBar, wxControl)
  86
  87 // ============================================================================
  88 // implementation
  89 // ============================================================================
  90
  91 //-----------------------------------------------------------------------------
  92 // "clicked" (internal from gtk_toolbar)
  93 //-----------------------------------------------------------------------------
  94
  95 static void gtk_toolbar_callback( GtkWidget *WXUNUSED(widget),
  96                                   wxToolBarTool *tool )
  97 {
  98     if (g_isIdle)
  99         wxapp_install_idle_handler();
 100
 101     wxToolBar *tbar = (wxToolBar *)tool->GetToolBar();
 102     if ( tbar->m_blockNextEvent )
 103     {
 104         tbar->m_blockNextEvent = FALSE;
 105         return;
 106     }
 107
 108     if (g_blockEventsOnDrag) return;
 109     if (!tool->IsEnabled()) return;
 110
 111     if (tool->CanBeToggled())
 112     {
 113         tool->Toggle();
 114
 115         wxBitmap bitmap = tool->GetBitmap();
 116         if ( bitmap.Ok() )
 117         {
 118             GtkPixmap *pixmap = GTK_PIXMAP( tool->m_pixmap );
 119
 120             GdkBitmap *mask = bitmap.GetMask() ? bitmap.GetMask()->GetBitmap()
 121                                                : (GdkBitmap *)NULL;
 122
 123             gtk_pixmap_set( pixmap, bitmap.GetPixmap(), mask );
 124         }
 125     }
 126
 127     tbar->OnLeftClick( tool->GetId(), tool->IsToggled() );
 128 }
 129
 130 //-----------------------------------------------------------------------------
 131 // "enter_notify_event"
 132 //-----------------------------------------------------------------------------
 133
 134 static gint gtk_toolbar_enter_callback( GtkWidget *WXUNUSED(widget),
 135                                         GdkEventCrossing *WXUNUSED(gdk_event),
 136                                         wxToolBarTool *tool )
 137 {
 138     if (g_isIdle) wxapp_install_idle_handler();
 139
 140     if (g_blockEventsOnDrag) return TRUE;
 141
 142     wxToolBar *tb = (wxToolBar *)tool->GetToolBar();
 143
 144 #if (GTK_MINOR_VERSION == 0)
 145     /* we grey-out the tip text of disabled tool in GTK 1.0 */
 146     if (tool->IsEnabled())
 147     {
 148         if (tb->m_fg->red != 0)
 149         {
 150             tb->m_fg->red = 0;
 151             tb->m_fg->green = 0;
 152             tb->m_fg->blue = 0;
 153             gdk_color_alloc( gtk_widget_get_colormap( GTK_WIDGET(tb->m_toolbar) ), tb->m_fg );
 154
 155             gtk_tooltips_set_colors( GTK_TOOLBAR(tb->m_toolbar)->tooltips, tb->m_bg, tb->m_fg );
 156         }
 157     }
 158     else
 159     {
 160         if (tb->m_fg->red == 0)
 161         {
 162             tb->m_fg->red = 33000;
 163             tb->m_fg->green = 33000;
 164             tb->m_fg->blue = 33000;
 165             gdk_color_alloc( gtk_widget_get_colormap( GTK_WIDGET(tb->m_toolbar) ), tb->m_fg );
 166             gtk_tooltips_set_colors( GTK_TOOLBAR(tb->m_toolbar)->tooltips, tb->m_bg, tb->m_fg );
 167         }
 168     }
 169 #endif
 170
 171     /* emit the event */
 172
 173     tb->OnMouseEnter( tool->GetId() );
 174
 175     return FALSE;
 176 }
 177
 178 //-----------------------------------------------------------------------------
 179 // InsertChild callback for wxToolBar
 180 //-----------------------------------------------------------------------------
 181
 182 static void wxInsertChildInToolBar( wxToolBar* WXUNUSED(parent),
 183                                     wxWindow* WXUNUSED(child) )
 184 {
 185     /* we don't do anything here but pray */
 186 }
 187
 188 // ----------------------------------------------------------------------------
 189 // wxToolBarTool
 190 // ----------------------------------------------------------------------------
 191
 192 void wxToolBarTool::Init()
 193 {
 194     m_item =
 195     m_pixmap = (GtkWidget *)NULL;
 196 }
 197
 198 wxToolBarToolBase *wxToolBar::CreateTool(int id,
 199                                          const wxBitmap& bitmap1,
 200                                          const wxBitmap& bitmap2,
 201                                          bool toggle,
 202                                          wxObject *clientData,
 203                                          const wxString& shortHelpString,
 204                                          const wxString& longHelpString)
 205 {
 206     return new wxToolBarTool(this, id, bitmap1, bitmap2, toggle,
 207                              clientData, shortHelpString, longHelpString);
 208 }
 209
 210 wxToolBarToolBase *wxToolBar::CreateTool(wxControl *control)
 211 {
 212     return new wxToolBarTool(this, control);
 213 }
 214
 215 //-----------------------------------------------------------------------------
 216 // wxToolBar construction
 217 //-----------------------------------------------------------------------------
 218
 219 void wxToolBar::Init()
 220 {
 221     m_fg =
 222     m_bg = (GdkColor *)NULL;
 223
 224     m_toolbar = (GtkToolbar *)NULL;
 225
 226     m_blockNextEvent = FALSE;
 227 }
 228
 229 wxToolBar::~wxToolBar()
 230 {
 231     delete m_fg;
 232     delete m_bg;
 233 }
 234
 235 bool wxToolBar::Create( wxWindow *parent,
 236                         wxWindowID id,
 237                         const wxPoint& pos,
 238                         const wxSize& size,
 239                         long style,
 240                         const wxString& name )
 241 {
 242     m_needParent = TRUE;
 243     m_insertCallback = (wxInsertChildFunction)wxInsertChildInToolBar;
 244
 245     if ( !PreCreation( parent, pos, size ) ||
 246          !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))
 247     {
 248         wxFAIL_MSG( wxT("wxToolBar creation failed") );
 249
 250         return FALSE;
 251     }
 252
 253     GtkOrientation orient = style & wxTB_VERTICAL ? GTK_ORIENTATION_VERTICAL
 254                                                   : GTK_ORIENTATION_HORIZONTAL;
 255     m_toolbar = GTK_TOOLBAR( gtk_toolbar_new( orient, GTK_TOOLBAR_ICONS ) );
 256
 257     SetToolSeparation(7);
 258
 259     if (style & wxTB_DOCKABLE)
 260     {
 261         m_widget = gtk_handle_box_new();
 262         gtk_container_add( GTK_CONTAINER(m_widget), GTK_WIDGET(m_toolbar) );
 263         gtk_widget_show( GTK_WIDGET(m_toolbar) );
 264
 265 #if (GTK_MINOR_VERSION > 0)
 266         if (style & wxTB_FLAT)
 267             gtk_handle_box_set_shadow_type( GTK_HANDLE_BOX(m_widget), GTK_SHADOW_NONE );
 268 #endif
 269     }
 270     else
 271     {
 272         m_widget = GTK_WIDGET(m_toolbar);
 273     }
 274
 275     gtk_toolbar_set_tooltips( GTK_TOOLBAR(m_toolbar), TRUE );
 276
 277     if (style & wxTB_FLAT)
 278         gtk_toolbar_set_button_relief( GTK_TOOLBAR(m_toolbar), GTK_RELIEF_NONE );
 279
 280
 281     m_fg = new GdkColor;
 282     m_fg->red = 0;
 283     m_fg->green = 0;
 284     m_fg->blue = 0;
 285     wxColour fg(0,0,0);
 286     fg.CalcPixel( gtk_widget_get_colormap( GTK_WIDGET(m_toolbar) ) );
 287     m_fg->pixel = fg.GetPixel();
 288
 289     m_bg = new GdkColor;
 290     m_bg->red = 65535;
 291     m_bg->green = 65535;
 292     m_bg->blue = 49980;
 293     wxColour bg(255,255,196);
 294     bg.CalcPixel( gtk_widget_get_colormap( GTK_WIDGET(m_toolbar) ) );
 295     m_bg->pixel = bg.GetPixel();
 296
 297     gtk_tooltips_force_window( GTK_TOOLBAR(m_toolbar)->tooltips );
 298
 299     GtkStyle *g_style =
 300         gtk_style_copy(
 301                 gtk_widget_get_style(
 302                     GTK_TOOLBAR(m_toolbar)->tooltips->tip_window ) );
 303
 304     g_style->bg[GTK_STATE_NORMAL] = *m_bg;
 305     gdk_font_unref( g_style->font );
 306         g_style->font = gdk_font_ref( GtkGetDefaultGuiFont() );
 307     gtk_widget_set_style( GTK_TOOLBAR(m_toolbar)->tooltips->tip_window, g_style );
 308
 309     m_parent->DoAddChild( this );
 310
 311     PostCreation();
 312
 313     Show( TRUE );
 314
 315     return TRUE;
 316 }
 317
 318 bool wxToolBar::DoInsertTool(size_t pos, wxToolBarToolBase *toolBase)
 319 {
 320     wxToolBarTool *tool = (wxToolBarTool *)toolBase;
 321
 322     // we have inserted a space before all the tools
 323     if (m_xMargin > 1) pos++;
 324
 325     if ( tool->IsButton() )
 326     {
 327         wxBitmap bitmap = tool->GetBitmap1();
 328
 329         wxCHECK_MSG( bitmap.Ok(), FALSE,
 330                      wxT("invalid bitmap for wxToolBar icon") );
 331
 332         wxCHECK_MSG( bitmap.GetBitmap() == NULL, FALSE,
 333                      wxT("wxToolBar doesn't support GdkBitmap") );
 334
 335         wxCHECK_MSG( bitmap.GetPixmap() != NULL, FALSE,
 336                      wxT("wxToolBar::Add needs a wxBitmap") );
 337
 338         GtkWidget *tool_pixmap = (GtkWidget *)NULL;
 339
 340         GdkPixmap *pixmap = bitmap.GetPixmap();
 341
 342         GdkBitmap *mask = (GdkBitmap *)NULL;
 343         if ( bitmap.GetMask() )
 344           mask = bitmap.GetMask()->GetBitmap();
 345
 346         tool_pixmap = gtk_pixmap_new( pixmap, mask );
 347 #if (GTK_MINOR_VERSION > 0)
 348         gtk_pixmap_set_build_insensitive( GTK_PIXMAP(tool_pixmap), TRUE );
 349 #endif
 350
 351         gtk_misc_set_alignment( GTK_MISC(tool_pixmap), 0.5, 0.5 );
 352
 353         tool->m_pixmap = tool_pixmap;
 354     }
 355
 356     switch ( tool->GetStyle() )
 357     {
 358         case wxTOOL_STYLE_BUTTON:
 359             tool->m_item = gtk_toolbar_insert_element
 360                            (
 361                               m_toolbar,
 362                               tool->CanBeToggled()
 363                                 ? GTK_TOOLBAR_CHILD_TOGGLEBUTTON
 364                                 : GTK_TOOLBAR_CHILD_BUTTON,
 365                               (GtkWidget *)NULL,
 366                               (const char *)NULL,
 367                               tool->GetShortHelp().mbc_str(),
 368                               "", // tooltip_private_text (?)
 369                               tool->m_pixmap,
 370                               (GtkSignalFunc)gtk_toolbar_callback,
 371                               (gpointer)tool,
 372                               pos
 373                            );
 374
 375             if ( !tool->m_item )
 376             {
 377                 wxFAIL_MSG( _T("gtk_toolbar_insert_element() failed") );
 378
 379                 return FALSE;
 380             }
 381
 382             gtk_signal_connect( GTK_OBJECT(tool->m_item),
 383                                 "enter_notify_event",
 384                                 GTK_SIGNAL_FUNC(gtk_toolbar_enter_callback),
 385                                 (gpointer)tool );
 386             break;
 387
 388         case wxTOOL_STYLE_SEPARATOR:
 389             gtk_toolbar_append_space( m_toolbar );
 390
 391             // skip the rest
 392             return TRUE;
 393
 394         case wxTOOL_STYLE_CONTROL:
 395             gtk_toolbar_insert_widget(
 396                                        m_toolbar,
 397                                        tool->GetControl()->m_widget,
 398                                        (const char *) NULL,
 399                                        (const char *) NULL,
 400                                        pos
 401                                       );
 402             break;
 403     }
 404
 405     GtkRequisition req;
 406     (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget) )->size_request )
 407         (m_widget, &req );
 408     m_width = req.width + m_xMargin;
 409     m_height = req.height + 2*m_yMargin;
 410
 411     return TRUE;
 412 }
 413
 414 bool wxToolBar::DoDeleteTool(size_t WXUNUSED(pos), wxToolBarToolBase *toolBase)
 415 {
 416     wxToolBarTool *tool = (wxToolBarTool *)toolBase;
 417
 418     switch ( tool->GetStyle() )
 419     {
 420         case wxTOOL_STYLE_CONTROL:
 421             tool->GetControl()->Destroy();
 422             break;
 423
 424         case wxTOOL_STYLE_BUTTON:
 425             gtk_widget_destroy( tool->m_item );
 426             break;
 427
 428         //case wxTOOL_STYLE_SEPARATOR: -- nothing to do
 429     }
 430
 431     return TRUE;
 432 }
 433
 434 // ----------------------------------------------------------------------------
 435 // wxToolBar tools state
 436 // ----------------------------------------------------------------------------
 437
 438 void wxToolBar::DoEnableTool(wxToolBarToolBase *toolBase, bool enable)
 439 {
 440 #if (GTK_MINOR_VERSION > 0)
 441     wxToolBarTool *tool = (wxToolBarTool *)toolBase;
 442
 443     /* we don't disable the tools for GTK 1.0 as the bitmaps don't get
 444        greyed anyway and this also disables tooltips */
 445     if (tool->m_item)
 446         gtk_widget_set_sensitive( tool->m_item, enable );
 447 #endif
 448 }
 449
 450 void wxToolBar::DoToggleTool( wxToolBarToolBase *toolBase, bool toggle )
 451 {
 452     wxToolBarTool *tool = (wxToolBarTool *)toolBase;
 453
 454     GtkWidget *item = tool->m_item;
 455     if ( item && GTK_IS_TOGGLE_BUTTON(item) )
 456     {
 457         wxBitmap bitmap = tool->GetBitmap();
 458         if ( bitmap.Ok() )
 459         {
 460             GtkPixmap *pixmap = GTK_PIXMAP( tool->m_pixmap );
 461
 462             GdkBitmap *mask = bitmap.GetMask() ? bitmap.GetMask()->GetBitmap()
 463                                                : (GdkBitmap *)NULL;
 464
 465             gtk_pixmap_set( pixmap, bitmap.GetPixmap(), mask );
 466         }
 467
 468         m_blockNextEvent = TRUE;  // we cannot use gtk_signal_disconnect here
 469
 470         gtk_toggle_button_set_state( GTK_TOGGLE_BUTTON(item), toggle );
 471     }
 472 }
 473
 474 void wxToolBar::DoSetToggle(wxToolBarToolBase * WXUNUSED(tool),
 475                             bool WXUNUSED(toggle))
 476 {
 477     // VZ: absolutely no idea about how to do it
 478     wxFAIL_MSG( _T("not implemented") );
 479 }
 480
 481 // ----------------------------------------------------------------------------
 482 // wxToolBar geometry
 483 // ----------------------------------------------------------------------------
 484
 485 wxToolBarToolBase *wxToolBar::FindToolForPosition(wxCoord WXUNUSED(x),
 486                                                   wxCoord WXUNUSED(y)) const
 487 {
 488     // VZ: GTK+ doesn't seem to have such thing
 489     wxFAIL_MSG( _T("wxToolBar::FindToolForPosition() not implemented") );
 490
 491     return (wxToolBarToolBase *)NULL;
 492 }
 493
 494 void wxToolBar::SetMargins( int x, int y )
 495 {
 496     wxCHECK_RET( GetToolsCount() == 0,
 497                  wxT("wxToolBar::SetMargins must be called before adding tools.") );
 498
 499     if (x > 1) gtk_toolbar_append_space( m_toolbar );  // oh well
 500
 501     m_xMargin = x;
 502     m_yMargin = y;
 503 }
 504
 505 void wxToolBar::SetToolSeparation( int separation )
 506 {
 507     gtk_toolbar_set_space_size( m_toolbar, separation );
 508     m_toolSeparation = separation;
 509 }
 510
 511 // ----------------------------------------------------------------------------
 512 // wxToolBar idle handling
 513 // ----------------------------------------------------------------------------
 514
 515 void wxToolBar::OnInternalIdle()
 516 {
 517     wxCursor cursor = m_cursor;
 518     if (g_globalCursor.Ok()) cursor = g_globalCursor;
 519
 520     if (cursor.Ok())
 521     {
 522         /* I now set the cursor the anew in every OnInternalIdle call
 523            as setting the cursor in a parent window also effects the
 524            windows above so that checking for the current cursor is
 525            not possible. */
 526
 527         if (HasFlag(wxTB_DOCKABLE) && (m_widget->window))
 528         {
 529             /* if the toolbar is dockable, then m_widget stands for the
 530                GtkHandleBox widget, which uses its own window so that we
 531                can set the cursor for it. if the toolbar is not dockable,
 532                m_widget comes from m_toolbar which uses its parent's
 533                window ("windowless windows") and thus we cannot set the
 534                cursor. */
 535             gdk_window_set_cursor( m_widget->window, cursor.GetCursor() );
 536         }
 537
 538         wxToolBarToolsList::Node *node = m_tools.GetFirst();
 539         while ( node )
 540         {
 541             wxToolBarTool *tool = (wxToolBarTool *)node->GetData();
 542             node = node->GetNext();
 543
 544             GtkWidget *item = tool->m_item;
 545             if ( item )
 546             {
 547                 GdkWindow *window = item->window;
 548
 549                 if ( window )
 550                 {
 551                     gdk_window_set_cursor( window, cursor.GetCursor() );
 552                 }
 553             }
 554         }
 555     }
 556
 557     UpdateWindowUI();
 558 }
 559
 560 #endif