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