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