]> git.saurik.com Git - wxWidgets.git/blobdiff - src/gtk/tbargtk.cpp
Improve wxMenu docs
[wxWidgets.git] / src / gtk / tbargtk.cpp
index f1e0bcc9ad4467c6ebfd72b4e2c35049c2603579..46cb5b8c977146ce9696b05c3b3e9b443c06f591 100644 (file)
@@ -8,14 +8,6 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-// ============================================================================
-// declarations
-// ============================================================================
-
-// ----------------------------------------------------------------------------
-// headers
-// ----------------------------------------------------------------------------
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #include "wx/toolbar.h"
 
 #ifndef WX_PRECOMP
-    #include "wx/frame.h"
+    #include "wx/menu.h"
 #endif
 
 // FIXME: Use GtkImage instead of GtkPixmap. Use the new toolbar API for when gtk runtime is new enough?
 // Beware that the new and old toolbar API may not be mixed in usage.
-#include <gtk/gtkversion.h>
-#ifdef GTK_DISABLE_DEPRECATED
 #undef GTK_DISABLE_DEPRECATED
-#endif
 
 #include "wx/gtk/private.h"
 
+/* XPM */
+static const char *arrow_down_xpm[] = {
+/* columns rows colors chars-per-pixel */
+"7 7 2 1",
+"  c None",
+". c Black",
+/* pixels */
+"       ",
+"       ",
+"       ",
+".......",
+" ..... ",
+"  ...  ",
+"   .   "
+};
+
+
 // ----------------------------------------------------------------------------
 // globals
 // ----------------------------------------------------------------------------
@@ -91,12 +97,23 @@ public:
         Init();
     }
 
-    wxToolBarTool(wxToolBar *tbar, wxControl *control)
-        : wxToolBarToolBase(tbar, control)
+    wxToolBarTool(wxToolBar *tbar, wxControl *control, const wxString& label)
+        : wxToolBarToolBase(tbar, control, label)
     {
         Init();
     }
 
+    virtual ~wxToolBarTool()
+    {
+        if ( IsControl() && !m_item )
+        {
+            // if we're a control which is not currently attached to the
+            // toolbar (as indicated by NULL m_item), we must undo the extra
+            // reference we added in DoDeleteTool()
+            g_object_unref(GetControl()->m_widget);
+        }
+    }
+
     // is this a radio button?
     //
     // unlike GetKind(), can be called for any kind of tools, not just buttons
@@ -118,6 +135,7 @@ public:
                 wxFAIL_MSG( _T("unknown toolbar child type") );
                 // fall through
 
+            case wxITEM_DROPDOWN:
             case wxITEM_NORMAL:
                 return GTK_TOOLBAR_CHILD_BUTTON;
         }
@@ -132,8 +150,12 @@ public:
         }
     }
 
-    GtkWidget            *m_item;
-    GtkWidget            *m_image;
+    // the toolbar element for button tools or a GtkAlignment containing the
+    // control for control tools
+    GtkWidget *m_item;
+
+    // a GtkImage containing the image for a button-type tool, may be NULL
+    GtkWidget *m_image;
 
 protected:
     void Init();
@@ -154,12 +176,9 @@ IMPLEMENT_DYNAMIC_CLASS(wxToolBar, wxControl)
 //-----------------------------------------------------------------------------
 
 extern "C" {
-static void gtk_toolbar_callback( GtkWidget *WXUNUSED(widget),
+static void gtk_toolbar_callback( GtkWidget *widget,
                                   wxToolBarTool *tool )
 {
-    if (g_isIdle)
-        wxapp_install_idle_handler();
-
     wxToolBar *tbar = (wxToolBar *)tool->GetToolBar();
 
     if (tbar->m_blockEvent) return;
@@ -169,6 +188,14 @@ static void gtk_toolbar_callback( GtkWidget *WXUNUSED(widget),
 
     if (tool->CanBeToggled())
     {
+        if (tool->IsRadio() &&
+            gtk_toggle_button_get_active( GTK_TOGGLE_BUTTON(widget)) &&
+            tool->IsToggled())
+        {
+            // pressed an already pressed radio button
+            return;
+        }
+
         tool->Toggle();
 
         tool->SetImage(tool->GetBitmap());
@@ -190,6 +217,106 @@ static void gtk_toolbar_callback( GtkWidget *WXUNUSED(widget),
 }
 }
 
+//-----------------------------------------------------------------------------
+// "right-click"
+//-----------------------------------------------------------------------------
+extern "C" {
+static gboolean gtk_toolbar_tool_rclick_callback(GtkWidget *WXUNUSED(widget),
+                                                 GdkEventButton *event,
+                                                 wxToolBarToolBase *tool)
+{
+    if (event->button != 3)
+        return FALSE;
+
+    wxToolBar *tbar = (wxToolBar *)tool->GetToolBar();
+
+    if (tbar->m_blockEvent) return TRUE;
+
+    if (g_blockEventsOnDrag) return TRUE;
+    if (!tool->IsEnabled()) return TRUE;
+
+    tbar->OnRightClick( tool->GetId(), (int)event->x, (int)event->y );
+
+    return TRUE;
+}
+}
+
+//-----------------------------------------------------------------------------
+// "enter_notify_event" / "leave_notify_event" from dropdown
+//-----------------------------------------------------------------------------
+
+extern "C" {
+static gint gtk_toolbar_buddy_enter_callback( GtkWidget *WXUNUSED(widget),
+                                       GdkEventCrossing *WXUNUSED(gdk_event),
+                                       GtkWidget *tool )
+{
+    guint8 state = GTK_WIDGET_STATE( tool );
+    state |= GTK_STATE_PRELIGHT;
+    gtk_widget_set_state( tool, (GtkStateType) state );
+    return FALSE;
+}
+
+static gint gtk_toolbar_buddy_leave_callback( GtkWidget *WXUNUSED(widget),
+                                       GdkEventCrossing *WXUNUSED(gdk_event),
+                                       GtkWidget *tool )
+{
+    guint8 state = GTK_WIDGET_STATE( tool );
+    state &= ~GTK_STATE_PRELIGHT;
+    gtk_widget_set_state( tool, (GtkStateType) state );
+    return FALSE;
+}
+}
+
+//-----------------------------------------------------------------------------
+// "left-click" on dropdown
+//-----------------------------------------------------------------------------
+
+extern "C"
+{
+static void gtk_pop_tb_hide_callback( GtkWidget *WXUNUSED(menu), GtkToggleButton *button  )
+{
+    gtk_toggle_button_set_active( button, FALSE );
+}
+
+static gboolean gtk_toolbar_dropdown_lclick_callback(GtkWidget *widget,
+                                                 GdkEventButton *event,
+                                                 wxToolBarToolBase *tool)
+{
+    if (event->button != 1)
+        return FALSE;
+
+    wxToolBar *tbar = (wxToolBar *)tool->GetToolBar();
+
+    if (tbar->m_blockEvent) return FALSE;
+
+    if (g_blockEventsOnDrag) return FALSE;
+    if (!tool->IsEnabled()) return FALSE;
+
+    wxCommandEvent evt(wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED, tool->GetId() );
+    if ( tbar->HandleWindowEvent(evt) )
+    {
+        return TRUE;
+    }
+
+    wxMenu * const menu = tool->GetDropdownMenu();
+    if (!menu)
+        return TRUE;
+
+    // simulate press
+    gtk_toggle_button_set_active( GTK_TOGGLE_BUTTON(widget), TRUE );
+
+    g_signal_connect (menu->m_menu, "hide",
+                                    G_CALLBACK (gtk_pop_tb_hide_callback),
+                                    widget);
+
+    tbar->PopupMenu( menu, widget->allocation.x,
+                           widget->allocation.y + widget->allocation.height );
+
+
+    return TRUE;
+}
+}
+
 //-----------------------------------------------------------------------------
 // "enter_notify_event" / "leave_notify_event"
 //-----------------------------------------------------------------------------
@@ -199,8 +326,6 @@ static gint gtk_toolbar_tool_callback( GtkWidget *WXUNUSED(widget),
                                        GdkEventCrossing *gdk_event,
                                        wxToolBarTool *tool )
 {
-    // don't need to install idle handler, its done from "event" signal
-
     if (g_blockEventsOnDrag) return TRUE;
 
     wxToolBar *tb = (wxToolBar *)tool->GetToolBar();
@@ -215,35 +340,30 @@ static gint gtk_toolbar_tool_callback( GtkWidget *WXUNUSED(widget),
 }
 }
 
+//-----------------------------------------------------------------------------
+// "size_request" from m_toolbar
+//-----------------------------------------------------------------------------
+
 extern "C" {
-static
-void gtktoolwidget_size_callback( GtkWidget *widget,
-                                  GtkAllocation *alloc,
-                                  wxWindow *win )
-{
-    // this shouldn't happen...
-    if (win->GetParent()->m_wxwindow) return;
-    
-    wxSize size = win->GetEffectiveMinSize();
-    if (size.y != alloc->height)
-    {
-        GtkAllocation alloc2;
-        alloc2.x = alloc->x;
-        alloc2.y = (alloc->height - size.y + 3) / 2;
-        alloc2.width = alloc->width;
-        alloc2.height = size.y;
-        gtk_widget_size_allocate( widget, &alloc2 );
-    }
+static void
+size_request(GtkWidget*, GtkRequisition* req, wxToolBar* win)
+{
+    const wxSize margins = win->GetMargins();
+    req->width  += margins.x;
+    req->height += 2 * margins.y;
 }
 }
+
 //-----------------------------------------------------------------------------
 // InsertChild callback for wxToolBar
 //-----------------------------------------------------------------------------
 
-static void wxInsertChildInToolBar( wxToolBar* WXUNUSED(parent),
-                                    wxWindow* WXUNUSED(child) )
+static void wxInsertChildInToolBar( wxWindow* WXUNUSED(parent),
+                                    wxWindow* child)
 {
-    // we don't do anything here
+    // Child widget will be inserted into GtkToolbar by DoInsertTool. Ref it
+    // here so reparenting into wxToolBar doesn't delete it.
+    g_object_ref(child->m_widget);
 }
 
 // ----------------------------------------------------------------------------
@@ -269,9 +389,10 @@ wxToolBarToolBase *wxToolBar::CreateTool(int id,
                              clientData, shortHelpString, longHelpString);
 }
 
-wxToolBarToolBase *wxToolBar::CreateTool(wxControl *control)
+wxToolBarToolBase *
+wxToolBar::CreateTool(wxControl *control, const wxString& label)
 {
-    return new wxToolBarTool(this, control);
+    return new wxToolBarTool(this, control, label);
 }
 
 //-----------------------------------------------------------------------------
@@ -297,8 +418,7 @@ bool wxToolBar::Create( wxWindow *parent,
                         long style,
                         const wxString& name )
 {
-    m_needParent = true;
-    m_insertCallback = (wxInsertChildFunction)wxInsertChildInToolBar;
+    m_insertCallback = wxInsertChildInToolBar;
 
     if ( !PreCreation( parent, pos, size ) ||
          !CreateBase( parent, id, pos, size, style, wxDefaultValidator, name ))
@@ -346,10 +466,13 @@ bool wxToolBar::Create( wxWindow *parent,
 
     PostCreation(size);
 
+    g_signal_connect_after(m_toolbar, "size_request",
+        G_CALLBACK(size_request), this);
+
     return true;
 }
 
-GdkWindow *wxToolBar::GTKGetWindow(wxArrayGdkWindows& windows) const
+GdkWindow *wxToolBar::GTKGetWindow(wxArrayGdkWindows& WXUNUSED(windows)) const
 {
     return GTK_WIDGET(m_toolbar)->window;
 }
@@ -393,7 +516,21 @@ bool wxToolBar::DoInsertTool(size_t pos, wxToolBarToolBase *toolBase)
         }
     }
 
-    const int posGtk = int(pos);
+    int posGtk = 0;
+    if ( pos > 0 )
+    {
+        for ( size_t i = 0; i < pos; i++ )
+        {
+            posGtk++;
+
+            // if we have a dropdown menu, we use 2 GTK tools internally
+            wxToolBarToolsList::compatibility_iterator node = m_tools.Item( i );
+            wxToolBarTool * const tool2 = (wxToolBarTool*) node->GetData();
+            if ( tool2->IsButton() && tool2->GetKind() == wxITEM_DROPDOWN )
+                posGtk++;
+        }
+    }
+
 
     switch ( tool->GetStyle() )
     {
@@ -457,36 +594,64 @@ bool wxToolBar::DoInsertTool(size_t pos, wxToolBarToolBase *toolBase)
                 g_signal_connect (tool->m_item, "leave_notify_event",
                                   G_CALLBACK (gtk_toolbar_tool_callback),
                                   tool);
+                g_signal_connect(tool->m_item, "button-press-event",
+                                  G_CALLBACK (gtk_toolbar_tool_rclick_callback),
+                                  tool);
+
+                if (tool->GetKind() == wxITEM_DROPDOWN)
+                {
+                    GdkPixbuf *pixbuf = gdk_pixbuf_new_from_xpm_data( arrow_down_xpm );
+                    GtkWidget *dropdown = gtk_toggle_button_new();
+                    GtkWidget *image = gtk_image_new_from_pixbuf( pixbuf );
+                    gtk_widget_show( image );
+                    gtk_container_add( GTK_CONTAINER(dropdown), image );
+
+                    if (GetWindowStyle() & wxTB_FLAT)
+                        gtk_button_set_relief( GTK_BUTTON(dropdown), GTK_RELIEF_NONE );
+                    GTK_WIDGET_UNSET_FLAGS (dropdown, GTK_CAN_FOCUS);
+                    gtk_widget_show( dropdown );
+
+                    g_signal_connect (dropdown, "enter_notify_event",
+                                  G_CALLBACK (gtk_toolbar_buddy_enter_callback),
+                                  tool->m_item);
+                    g_signal_connect (dropdown, "leave_notify_event",
+                                  G_CALLBACK (gtk_toolbar_buddy_leave_callback),
+                                  tool->m_item);
+                    g_signal_connect(dropdown, "button-press-event",
+                                  G_CALLBACK (gtk_toolbar_dropdown_lclick_callback),
+                                  tool);
+
+                    GtkRequisition req;
+                    (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(tool->m_item) )->size_request )
+                        (tool->m_item, &req );
+                    gtk_widget_set_size_request( dropdown, -1, req.height );
+
+                    gtk_toolbar_insert_widget(m_toolbar, dropdown, NULL, NULL,
+                                              posGtk + 1);
+                }
             }
             break;
 
         case wxTOOL_STYLE_SEPARATOR:
             gtk_toolbar_insert_space( m_toolbar, posGtk );
-
-            // skip the rest
-            return true;
+            break;
 
         case wxTOOL_STYLE_CONTROL:
-            gtk_toolbar_insert_widget(
-                                       m_toolbar,
-                                       tool->GetControl()->m_widget,
-                                       (const char *) NULL,
-                                       (const char *) NULL,
-                                       posGtk
-                                      );
-                                      
-            // connect after in order to correct size_allocate events
-            g_signal_connect_after (tool->GetControl()->m_widget, "size_allocate",
-                          G_CALLBACK (gtktoolwidget_size_callback), tool->GetControl());
-                                      
+            GtkWidget * const align = gtk_alignment_new(0.5, 0.5, 0, 0);
+            gtk_widget_show(align);
+            gtk_container_add(GTK_CONTAINER(align),
+                              tool->GetControl()->m_widget);
+            gtk_toolbar_insert_widget(m_toolbar, align, NULL, NULL, posGtk);
+
+            // release reference obtained by wxInsertChildInToolBar
+            g_object_unref(tool->GetControl()->m_widget);
+
+            // remember the container we're in so that we could remove
+            // ourselves from it when we're detached from the toolbar
+            tool->m_item = align;
             break;
     }
 
-    GtkRequisition req;
-    (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget) )->size_request )
-        (m_widget, &req );
-    m_width = req.width + m_xMargin;
-    m_height = req.height + 2*m_yMargin;
     InvalidateBestSize();
 
     return true;
@@ -499,16 +664,29 @@ bool wxToolBar::DoDeleteTool(size_t pos, wxToolBarToolBase *toolBase)
     switch ( tool->GetStyle() )
     {
         case wxTOOL_STYLE_CONTROL:
-            tool->GetControl()->Destroy();
-            break;
+            // don't destroy the control here as we can be called from
+            // RemoveTool() and then we need to keep the control alive;
+            // while if we're called from DeleteTool() the control will
+            // be destroyed when wxToolBarToolBase itself is deleted
+            {
+                GtkWidget * const w = tool->GetControl()->m_widget;
+                g_object_ref(w);
+                gtk_container_remove(GTK_CONTAINER(tool->m_item), w);
+            }
+            // fall through
 
         case wxTOOL_STYLE_BUTTON:
             gtk_widget_destroy( tool->m_item );
+            tool->m_item = NULL;
             break;
 
         case wxTOOL_STYLE_SEPARATOR:
             gtk_toolbar_remove_space( m_toolbar, pos );
             break;
+
+        default:
+            wxFAIL_MSG( "unknown tool style" );
+            return false;
     }
 
     InvalidateBestSize();
@@ -606,7 +784,7 @@ void wxToolBar::SetToolNormalBitmap( int id, const wxBitmap& bitmap )
 
         tool->SetNormalBitmap(bitmap);
         tool->SetImage(tool->GetBitmap());
-    }    
+    }
 }
 
 void wxToolBar::SetToolDisabledBitmap( int id, const wxBitmap& bitmap )
@@ -618,7 +796,7 @@ void wxToolBar::SetToolDisabledBitmap( int id, const wxBitmap& bitmap )
 
         tool->SetDisabledBitmap(bitmap);
         tool->SetImage(tool->GetBitmap());
-    }    
+    }
 }
 
 // ----------------------------------------------------------------------------
@@ -629,7 +807,7 @@ void wxToolBar::OnInternalIdle()
 {
     // Check if we have to show window now
     if (GtkShowFromOnIdle()) return;
-    
+
     wxCursor cursor = m_cursor;
     if (g_globalCursor.Ok()) cursor = g_globalCursor;
 
@@ -670,7 +848,7 @@ void wxToolBar::OnInternalIdle()
         }
     }
 
-    if (wxUpdateUIEvent::CanUpdate(this))
+    if (wxUpdateUIEvent::CanUpdate(this) && IsShownOnScreen())
         UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
 }