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, wxToolBarBase)
  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" / "leave_notify_event"
 132 //-----------------------------------------------------------------------------
 133
 134 static gint gtk_toolbar_tool_callback( GtkWidget *WXUNUSED(widget),
 135                                        GdkEventCrossing *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     // emit the event
 145     if( gdk_event->type == GDK_ENTER_NOTIFY )
 146         tb->OnMouseEnter( tool->GetId() );
 147     else
 148         tb->OnMouseEnter( -1 );
 149
 150     return FALSE;
 151 }
 152
 153 //-----------------------------------------------------------------------------
 154 // InsertChild callback for wxToolBar
 155 //-----------------------------------------------------------------------------
 156
 157 static void wxInsertChildInToolBar( wxToolBar* WXUNUSED(parent),
 158                                     wxWindow* WXUNUSED(child) )
 159 {
 160     // we don't do anything here
 161 }
 162
 163 // ----------------------------------------------------------------------------
 164 // wxToolBarTool
 165 // ----------------------------------------------------------------------------
 166
 167 void wxToolBarTool::Init()
 168 {
 169     m_item =
 170     m_pixmap = (GtkWidget *)NULL;
 171 }
 172
 173 wxToolBarToolBase *wxToolBar::CreateTool(int id,
 174                                          const wxBitmap& bitmap1,
 175                                          const wxBitmap& bitmap2,
 176                                          bool toggle,
 177                                          wxObject *clientData,
 178                                          const wxString& shortHelpString,
 179                                          const wxString& longHelpString)
 180 {
 181     return new wxToolBarTool(this, id, bitmap1, bitmap2, toggle,
 182                              clientData, shortHelpString, longHelpString);
 183 }
 184
 185 wxToolBarToolBase *wxToolBar::CreateTool(wxControl *control)
 186 {
 187     return new wxToolBarTool(this, control);
 188 }
 189
 190 //-----------------------------------------------------------------------------
 191 // wxToolBar construction
 192 //-----------------------------------------------------------------------------
 193
 194 void wxToolBar::Init()
 195 {
 196     m_fg =
 197     m_bg = (GdkColor *)NULL;
 198     m_toolbar = (GtkToolbar *)NULL;
 199     m_blockNextEvent = FALSE;
 200 }
 201
 202 wxToolBar::~wxToolBar()
 203 {
 204     delete m_fg;
 205     delete m_bg;
 206 }
 207
 208 bool wxToolBar::Create( wxWindow *parent,
 209                         wxWindowID id,
 210                         const wxPoint& pos,
 211                         const wxSize& size,
 212                         long style,
 213                         const wxString& name )
 214 {
 215     m_needParent = TRUE;
 216     m_insertCallback = (wxInsertChildFunction)wxInsertChildInToolBar;
 217
 218     if ( !PreCreation( parent, pos, size ) ||
 219          !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))
 220     {
 221         wxFAIL_MSG( wxT("wxToolBar creation failed") );
 222
 223         return FALSE;
 224     }
 225
 226     GtkOrientation orient = style & wxTB_VERTICAL ? GTK_ORIENTATION_VERTICAL
 227                                                   : GTK_ORIENTATION_HORIZONTAL;
 228     m_toolbar = GTK_TOOLBAR( gtk_toolbar_new( orient, GTK_TOOLBAR_ICONS ) );
 229
 230     SetToolSeparation(7);
 231
 232     if (style & wxTB_DOCKABLE)
 233     {
 234         m_widget = gtk_handle_box_new();
 235         gtk_container_add( GTK_CONTAINER(m_widget), GTK_WIDGET(m_toolbar) );
 236         gtk_widget_show( GTK_WIDGET(m_toolbar) );
 237
 238         if (style & wxTB_FLAT)
 239             gtk_handle_box_set_shadow_type( GTK_HANDLE_BOX(m_widget), GTK_SHADOW_NONE );
 240     }
 241     else
 242     {
 243         m_widget = GTK_WIDGET(m_toolbar);
 244     }
 245
 246     gtk_toolbar_set_tooltips( GTK_TOOLBAR(m_toolbar), TRUE );
 247
 248     if (style & wxTB_FLAT)
 249         gtk_toolbar_set_button_relief( GTK_TOOLBAR(m_toolbar), GTK_RELIEF_NONE );
 250
 251
 252     m_fg = new GdkColor;
 253     m_fg->red = 0;
 254     m_fg->green = 0;
 255     m_fg->blue = 0;
 256     wxColour fg(0,0,0);
 257     fg.CalcPixel( gtk_widget_get_colormap( GTK_WIDGET(m_toolbar) ) );
 258     m_fg->pixel = fg.GetPixel();
 259
 260     m_bg = new GdkColor;
 261     m_bg->red = 65535;
 262     m_bg->green = 65535;
 263     m_bg->blue = 49980;
 264     wxColour bg(255,255,196);
 265     bg.CalcPixel( gtk_widget_get_colormap( GTK_WIDGET(m_toolbar) ) );
 266     m_bg->pixel = bg.GetPixel();
 267
 268     gtk_tooltips_force_window( GTK_TOOLBAR(m_toolbar)->tooltips );
 269
 270     GtkStyle *g_style =
 271         gtk_style_copy(
 272                 gtk_widget_get_style(
 273                     GTK_TOOLBAR(m_toolbar)->tooltips->tip_window ) );
 274
 275     g_style->bg[GTK_STATE_NORMAL] = *m_bg;
 276     gdk_font_unref( g_style->font );
 277         g_style->font = gdk_font_ref( GtkGetDefaultGuiFont() );
 278     gtk_widget_set_style( GTK_TOOLBAR(m_toolbar)->tooltips->tip_window, g_style );
 279
 280     m_parent->DoAddChild( this );
 281
 282     PostCreation();
 283
 284     Show( TRUE );
 285
 286     return TRUE;
 287 }
 288
 289 bool wxToolBar::DoInsertTool(size_t pos, wxToolBarToolBase *toolBase)
 290 {
 291     wxToolBarTool *tool = (wxToolBarTool *)toolBase;
 292
 293     // we have inserted a space before all the tools
 294     if (m_xMargin > 1) pos++;
 295
 296     if ( tool->IsButton() )
 297     {
 298         wxBitmap bitmap = tool->GetBitmap1();
 299
 300         wxCHECK_MSG( bitmap.Ok(), FALSE,
 301                      wxT("invalid bitmap for wxToolBar icon") );
 302
 303         wxCHECK_MSG( bitmap.GetBitmap() == NULL, FALSE,
 304                      wxT("wxToolBar doesn't support GdkBitmap") );
 305
 306         wxCHECK_MSG( bitmap.GetPixmap() != NULL, FALSE,
 307                      wxT("wxToolBar::Add needs a wxBitmap") );
 308
 309         GtkWidget *tool_pixmap = (GtkWidget *)NULL;
 310
 311         GdkPixmap *pixmap = bitmap.GetPixmap();
 312
 313         GdkBitmap *mask = (GdkBitmap *)NULL;
 314         if ( bitmap.GetMask() )
 315           mask = bitmap.GetMask()->GetBitmap();
 316
 317         tool_pixmap = gtk_pixmap_new( pixmap, mask );
 318 #if (GTK_MINOR_VERSION > 0)
 319         gtk_pixmap_set_build_insensitive( GTK_PIXMAP(tool_pixmap), TRUE );
 320 #endif
 321
 322         gtk_misc_set_alignment( GTK_MISC(tool_pixmap), 0.5, 0.5 );
 323
 324         tool->m_pixmap = tool_pixmap;
 325     }
 326
 327     switch ( tool->GetStyle() )
 328     {
 329         case wxTOOL_STYLE_BUTTON:
 330             tool->m_item = gtk_toolbar_insert_element
 331                            (
 332                               m_toolbar,
 333                               tool->CanBeToggled()
 334                                 ? GTK_TOOLBAR_CHILD_TOGGLEBUTTON
 335                                 : GTK_TOOLBAR_CHILD_BUTTON,
 336                               (GtkWidget *)NULL,
 337                               (const char *)NULL,
 338                               tool->GetShortHelp().mbc_str(),
 339                               "", // tooltip_private_text (?)
 340                               tool->m_pixmap,
 341                               (GtkSignalFunc)gtk_toolbar_callback,
 342                               (gpointer)tool,
 343                               pos
 344                            );
 345
 346             if ( !tool->m_item )
 347             {
 348                 wxFAIL_MSG( _T("gtk_toolbar_insert_element() failed") );
 349
 350                 return FALSE;
 351             }
 352
 353             gtk_signal_connect( GTK_OBJECT(tool->m_item),
 354                                 "enter_notify_event",
 355                                 GTK_SIGNAL_FUNC(gtk_toolbar_tool_callback),
 356                                 (gpointer)tool );
 357             gtk_signal_connect( GTK_OBJECT(tool->m_item),
 358                                 "leave_notify_event",
 359                                 GTK_SIGNAL_FUNC(gtk_toolbar_tool_callback),
 360                                 (gpointer)tool );
 361             break;
 362
 363         case wxTOOL_STYLE_SEPARATOR:
 364             gtk_toolbar_insert_space( m_toolbar, pos );
 365
 366             // skip the rest
 367             return TRUE;
 368
 369         case wxTOOL_STYLE_CONTROL:
 370             gtk_toolbar_insert_widget(
 371                                        m_toolbar,
 372                                        tool->GetControl()->m_widget,
 373                                        (const char *) NULL,
 374                                        (const char *) NULL,
 375                                        pos
 376                                       );
 377             break;
 378     }
 379
 380     GtkRequisition req;
 381     (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget) )->size_request )
 382         (m_widget, &req );
 383     m_width = req.width + m_xMargin;
 384     m_height = req.height + 2*m_yMargin;
 385
 386     return TRUE;
 387 }
 388
 389 bool wxToolBar::DoDeleteTool(size_t WXUNUSED(pos), wxToolBarToolBase *toolBase)
 390 {
 391     wxToolBarTool *tool = (wxToolBarTool *)toolBase;
 392
 393     switch ( tool->GetStyle() )
 394     {
 395         case wxTOOL_STYLE_CONTROL:
 396             tool->GetControl()->Destroy();
 397             break;
 398
 399         case wxTOOL_STYLE_BUTTON:
 400             gtk_widget_destroy( tool->m_item );
 401             break;
 402
 403         //case wxTOOL_STYLE_SEPARATOR: -- nothing to do
 404     }
 405
 406     return TRUE;
 407 }
 408
 409 // ----------------------------------------------------------------------------
 410 // wxToolBar tools state
 411 // ----------------------------------------------------------------------------
 412
 413 void wxToolBar::DoEnableTool(wxToolBarToolBase *toolBase, bool enable)
 414 {
 415 #if (GTK_MINOR_VERSION > 0)
 416     wxToolBarTool *tool = (wxToolBarTool *)toolBase;
 417
 418     /* we don't disable the tools for GTK 1.0 as the bitmaps don't get
 419        greyed anyway and this also disables tooltips */
 420     if (tool->m_item)
 421         gtk_widget_set_sensitive( tool->m_item, enable );
 422 #endif
 423 }
 424
 425 void wxToolBar::DoToggleTool( wxToolBarToolBase *toolBase, bool toggle )
 426 {
 427     wxToolBarTool *tool = (wxToolBarTool *)toolBase;
 428
 429     GtkWidget *item = tool->m_item;
 430     if ( item && GTK_IS_TOGGLE_BUTTON(item) )
 431     {
 432         wxBitmap bitmap = tool->GetBitmap();
 433         if ( bitmap.Ok() )
 434         {
 435             GtkPixmap *pixmap = GTK_PIXMAP( tool->m_pixmap );
 436
 437             GdkBitmap *mask = bitmap.GetMask() ? bitmap.GetMask()->GetBitmap()
 438                                                : (GdkBitmap *)NULL;
 439
 440             gtk_pixmap_set( pixmap, bitmap.GetPixmap(), mask );
 441         }
 442
 443         m_blockNextEvent = TRUE;  // we cannot use gtk_signal_disconnect here
 444
 445         gtk_toggle_button_set_state( GTK_TOGGLE_BUTTON(item), toggle );
 446     }
 447 }
 448
 449 void wxToolBar::DoSetToggle(wxToolBarToolBase * WXUNUSED(tool),
 450                             bool WXUNUSED(toggle))
 451 {
 452     // VZ: absolutely no idea about how to do it
 453     wxFAIL_MSG( _T("not implemented") );
 454 }
 455
 456 // ----------------------------------------------------------------------------
 457 // wxToolBar geometry
 458 // ----------------------------------------------------------------------------
 459
 460 wxToolBarToolBase *wxToolBar::FindToolForPosition(wxCoord WXUNUSED(x),
 461                                                   wxCoord WXUNUSED(y)) const
 462 {
 463     // VZ: GTK+ doesn't seem to have such thing
 464     wxFAIL_MSG( _T("wxToolBar::FindToolForPosition() not implemented") );
 465
 466     return (wxToolBarToolBase *)NULL;
 467 }
 468
 469 void wxToolBar::SetMargins( int x, int y )
 470 {
 471     wxCHECK_RET( GetToolsCount() == 0,
 472                  wxT("wxToolBar::SetMargins must be called before adding tools.") );
 473
 474     if (x > 1) gtk_toolbar_append_space( m_toolbar );  // oh well
 475
 476     m_xMargin = x;
 477     m_yMargin = y;
 478 }
 479
 480 void wxToolBar::SetToolSeparation( int separation )
 481 {
 482     gtk_toolbar_set_space_size( m_toolbar, separation );
 483     m_toolSeparation = separation;
 484 }
 485
 486 void wxToolBar::SetToolShortHelp( int id, const wxString& helpString )
 487 {
 488     wxToolBarTool *tool = (wxToolBarTool *)FindById(id);
 489
 490     if ( tool )
 491     {
 492         (void)tool->SetShortHelp(helpString);
 493         gtk_tooltips_set_tip(m_toolbar->tooltips, tool->m_item,
 494                              helpString.mbc_str(), "");
 495     }
 496 }
 497
 498 // ----------------------------------------------------------------------------
 499 // wxToolBar idle handling
 500 // ----------------------------------------------------------------------------
 501
 502 void wxToolBar::OnInternalIdle()
 503 {
 504     wxCursor cursor = m_cursor;
 505     if (g_globalCursor.Ok()) cursor = g_globalCursor;
 506
 507     if (cursor.Ok())
 508     {
 509         /* I now set the cursor the anew in every OnInternalIdle call
 510            as setting the cursor in a parent window also effects the
 511            windows above so that checking for the current cursor is
 512            not possible. */
 513
 514         if (HasFlag(wxTB_DOCKABLE) && (m_widget->window))
 515         {
 516             /* if the toolbar is dockable, then m_widget stands for the
 517                GtkHandleBox widget, which uses its own window so that we
 518                can set the cursor for it. if the toolbar is not dockable,
 519                m_widget comes from m_toolbar which uses its parent's
 520                window ("windowless windows") and thus we cannot set the
 521                cursor. */
 522             gdk_window_set_cursor( m_widget->window, cursor.GetCursor() );
 523         }
 524
 525         wxToolBarToolsList::Node *node = m_tools.GetFirst();
 526         while ( node )
 527         {
 528             wxToolBarTool *tool = (wxToolBarTool *)node->GetData();
 529             node = node->GetNext();
 530
 531             GtkWidget *item = tool->m_item;
 532             if ( item )
 533             {
 534                 GdkWindow *window = item->window;
 535
 536                 if ( window )
 537                 {
 538                     gdk_window_set_cursor( window, cursor.GetCursor() );
 539                 }
 540             }
 541         }
 542     }
 543
 544     UpdateWindowUI();
 545 }
 546
 547 #endif // wxUSE_TOOLBAR_NATIVE