Fix the URL generated by Doxygen @sampledir macro.

[wxWidgets.git] / src / gtk / button.cpp

diff --git a/src/gtk/button.cpp b/src/gtk/button.cpp
index e1099660546cd92f80e5bb901f228c5befc4da68..cf3fb8b26aea5aaff6be2c5278e78b97a5e25134 100644 (file)
--- a/src/gtk/button.cpp
+++ b/src/gtk/button.cpp
@@ -1,158 +1,333 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        button.cpp
+// Name:        src/gtk/button.cpp

 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling

-// Licence:    wxWindows licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "button.h"
-#endif
-
-#include "wx/button.h"
-
-#include "gdk/gdk.h"
-#include "gtk/gtk.h"
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
+// For compilers that support precompilation, includes "wx.h".
+#include "wx/wxprec.h"

 
 

-class wxButton;
+#if wxUSE_BUTTON

 
 

-//-----------------------------------------------------------------------------
-// idle system
-//-----------------------------------------------------------------------------
+#ifndef WX_PRECOMP
+    #include "wx/button.h"
+#endif

 
 

-extern void wxapp_install_idle_handler();
-extern bool g_isIdle;
+#include "wx/stockitem.h"

 
 

-//-----------------------------------------------------------------------------
-// data
-//-----------------------------------------------------------------------------
+#include "wx/gtk/private.h"
+#include "wx/gtk/private/list.h"

 
 

-extern bool   g_blockEventsOnDrag;
+// ----------------------------------------------------------------------------
+// GTK callbacks
+// ----------------------------------------------------------------------------

 
 

-//-----------------------------------------------------------------------------
-// "clicked"
-//-----------------------------------------------------------------------------
+extern "C"
+{

 
 

-static void gtk_button_clicked_callback( GtkWidget *WXUNUSED(widget), wxButton *button )
+static void
+wxgtk_button_clicked_callback(GtkWidget *WXUNUSED(widget), wxButton *button)

 {
 {

-    if (g_isIdle) 
-       wxapp_install_idle_handler();
+    if ( button->GTKShouldIgnoreEvent() )
+        return;

 
 

-    if (!button->m_hasVMT) return;
-    if (g_blockEventsOnDrag) return;
-    

     wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, button->GetId());
     event.SetEventObject(button);
     wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, button->GetId());
     event.SetEventObject(button);

-    button->GetEventHandler()->ProcessEvent(event);
+    button->HandleWindowEvent(event);

 }
 
 //-----------------------------------------------------------------------------
 }
 
 //-----------------------------------------------------------------------------

-// wxButton
+// "style_set" from m_widget

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-IMPLEMENT_DYNAMIC_CLASS(wxButton,wxControl)
-
-wxButton::wxButton()
+static void
+wxgtk_button_style_set_callback(GtkWidget* widget, GtkStyle*, wxButton* win)

 {
 {

+    /* the default button has a border around it */
+    wxWindow* parent = win->GetParent();
+    if (parent && parent->m_wxwindow && gtk_widget_get_can_default(widget))
+    {
+        GtkBorder* border = NULL;
+        gtk_widget_style_get(widget, "default_border", &border, NULL);
+        if (border)
+        {
+            win->MoveWindow(
+                win->m_x - border->left,
+                win->m_y - border->top,
+                win->m_width + border->left + border->right,
+                win->m_height + border->top + border->bottom);
+            gtk_border_free(border);
+        }
+    }

 }
 
 }
 

-wxButton::~wxButton()
-{
-    if (m_clientData) delete m_clientData;
-}
+} // extern "C"

 
 

-bool wxButton::Create(  wxWindow *parent, wxWindowID id, const wxString &label,
-      const wxPoint &pos, const wxSize &size,
-      long style, const wxValidator& validator, const wxString &name )
-{
-    m_clientData = (wxClientData*) NULL;
-    m_needParent = TRUE;
-    m_acceptsFocus = TRUE;
+//-----------------------------------------------------------------------------
+// wxButton
+//-----------------------------------------------------------------------------

 
 

+bool wxButton::Create(wxWindow *parent,
+                      wxWindowID id,
+                      const wxString &label,
+                      const wxPoint& pos,
+                      const wxSize& size,
+                      long style,
+                      const wxValidator& validator,
+                      const wxString& name)
+{

     if (!PreCreation( parent, pos, size ) ||
         !CreateBase( parent, id, pos, size, style, validator, name ))
     {
     if (!PreCreation( parent, pos, size ) ||
         !CreateBase( parent, id, pos, size, style, validator, name ))
     {

-        wxFAIL_MSG( _T("wxButton creation failed") );
-       return FALSE;
+        wxFAIL_MSG( wxT("wxButton creation failed") );
+        return false;

     }
 
     }
 

+    // create either a standard button with text label (which may still contain
+    // an image under GTK+ 2.6+) or a bitmap-only button if we don't have any
+    // label
+    const bool
+        useLabel = !(style & wxBU_NOTEXT) && (!label.empty() || wxIsStockID(id));
+    if ( useLabel )
+    {
+        m_widget = gtk_button_new_with_mnemonic("");
+    }
+    else // no label, suppose we will have a bitmap
+    {
+        m_widget = gtk_button_new();

 
 

-    m_widget = gtk_button_new_with_label( "" );
-    
-#if (GTK_MINOR_VERSION > 0)    
-    if (style & wxNO_BORDER)
-       gtk_button_set_relief( GTK_BUTTON(m_widget), GTK_RELIEF_NONE );
-#endif
+        GtkWidget *image = gtk_image_new();
+        gtk_widget_show(image);
+        gtk_container_add(GTK_CONTAINER(m_widget), image);
+    }

 
 

-    SetLabel(label);
+    g_object_ref(m_widget);

 
 

-    int x = 0;  int y = 0;
-    wxFont new_font( parent->GetFont() );
-    GetTextExtent( m_label, &x, &y, (int*)NULL, (int*)NULL, &new_font );
+    float x_alignment = 0.5;
+    if (HasFlag(wxBU_LEFT))
+        x_alignment = 0.0;
+    else if (HasFlag(wxBU_RIGHT))
+        x_alignment = 1.0;

 
 

-    wxSize newSize = size;
-    if (newSize.x == -1) newSize.x = 12+x;
-    if (newSize.y == -1) newSize.y = 11+y;
-    SetSize( newSize.x, newSize.y );
+    float y_alignment = 0.5;
+    if (HasFlag(wxBU_TOP))
+        y_alignment = 0.0;
+    else if (HasFlag(wxBU_BOTTOM))
+        y_alignment = 1.0;

 
 

-    gtk_signal_connect( GTK_OBJECT(m_widget), "clicked",
-      GTK_SIGNAL_FUNC(gtk_button_clicked_callback), (gpointer*)this );
+    gtk_button_set_alignment(GTK_BUTTON(m_widget), x_alignment, y_alignment);
+
+    if ( useLabel )
+        SetLabel(label);
+
+    if (style & wxNO_BORDER)
+       gtk_button_set_relief( GTK_BUTTON(m_widget), GTK_RELIEF_NONE );
+
+    g_signal_connect_after (m_widget, "clicked",
+                            G_CALLBACK (wxgtk_button_clicked_callback),
+                            this);
+
+    g_signal_connect_after (m_widget, "style_set",
+                            G_CALLBACK (wxgtk_button_style_set_callback),
+                            this);

 
     m_parent->DoAddChild( this );
 
     m_parent->DoAddChild( this );

-  
-    PostCreation();
-  
-    SetBackgroundColour( parent->GetBackgroundColour() );
-    SetForegroundColour( parent->GetForegroundColour() );
-    SetFont( parent->GetFont() );

 
 

-    Show( TRUE );
+    PostCreation(size);

 
 

-    return TRUE;
+    return true;

 }
 
 }
 

-void wxButton::SetDefault(void)
+
+wxWindow *wxButton::SetDefault()

 {
 {

-    GTK_WIDGET_SET_FLAGS( m_widget, GTK_CAN_DEFAULT );
+    wxWindow *oldDefault = wxButtonBase::SetDefault();
+
+    gtk_widget_set_can_default(m_widget, TRUE);

     gtk_widget_grab_default( m_widget );
     gtk_widget_grab_default( m_widget );

-    
-    SetSize( m_x, m_y, m_width, m_height );
+
+    // resize for default border
+    wxgtk_button_style_set_callback( m_widget, NULL, this );
+
+    return oldDefault;

 }
 
 /* static */
 }
 
 /* static */

-wxSize wxButton::GetDefaultSize()
+wxSize wxButtonBase::GetDefaultSize()

 {
 {

-    return wxSize(80,26);
+    static wxSize size = wxDefaultSize;
+    if (size == wxDefaultSize)
+    {
+        // NB: Default size of buttons should be same as size of stock
+        //     buttons as used in most GTK+ apps. Unfortunately it's a little
+        //     tricky to obtain this size: stock button's size may be smaller
+        //     than size of button in GtkButtonBox and vice versa,
+        //     GtkButtonBox's minimal button size may be smaller than stock
+        //     button's size. We have to retrieve both values and combine them.
+
+        GtkWidget *wnd = gtk_window_new(GTK_WINDOW_TOPLEVEL);
+        GtkWidget *box = gtk_hbutton_box_new();
+        GtkWidget *btn = gtk_button_new_from_stock(GTK_STOCK_CANCEL);
+        gtk_container_add(GTK_CONTAINER(box), btn);
+        gtk_container_add(GTK_CONTAINER(wnd), box);
+        GtkRequisition req;
+        gtk_widget_size_request(btn, &req);
+
+        gint minwidth, minheight;
+        gtk_widget_style_get(box,
+                             "child-min-width", &minwidth,
+                             "child-min-height", &minheight,
+                             NULL);
+
+        size.x = wxMax(minwidth, req.width);
+        size.y = wxMax(minheight, req.height);
+
+        gtk_widget_destroy(wnd);
+    }
+    return size;

 }
 
 }
 

-void wxButton::SetLabel( const wxString &label )
+void wxButton::SetLabel( const wxString &lbl )

 {
 {

-    wxCHECK_RET( m_widget != NULL, _T("invalid button") );
-  
-    wxControl::SetLabel( label );
-  
-    gtk_label_set( GTK_LABEL( GTK_BUTTON(m_widget)->child ), GetLabel().mbc_str() );
+    wxCHECK_RET( m_widget != NULL, wxT("invalid button") );
+
+    wxString label(lbl);
+
+    if (label.empty() && wxIsStockID(m_windowId))
+        label = wxGetStockLabel(m_windowId);
+
+    wxAnyButton::SetLabel(label);
+
+    // don't use label if it was explicitly disabled
+    if ( HasFlag(wxBU_NOTEXT) )
+        return;
+
+    if (wxIsStockID(m_windowId) && wxIsStockLabel(m_windowId, label))
+    {
+        const char *stock = wxGetStockGtkID(m_windowId);
+        if (stock)
+        {
+            gtk_button_set_label(GTK_BUTTON(m_widget), stock);
+            gtk_button_set_use_stock(GTK_BUTTON(m_widget), TRUE);
+            return;
+        }
+    }
+
+    // this call is necessary if the button had been initially created without
+    // a (text) label -- then we didn't use gtk_button_new_with_mnemonic() and
+    // so "use-underline" GtkButton property remained unset
+    gtk_button_set_use_underline(GTK_BUTTON(m_widget), TRUE);
+    const wxString labelGTK = GTKConvertMnemonics(label);
+    gtk_button_set_label(GTK_BUTTON(m_widget), wxGTK_CONV(labelGTK));
+    gtk_button_set_use_stock(GTK_BUTTON(m_widget), FALSE);
+
+    GTKApplyWidgetStyle( false );

 }
 
 }
 

-bool wxButton::Enable( bool enable )
+#if wxUSE_MARKUP
+bool wxButton::DoSetLabelMarkup(const wxString& markup)

 {
 {

-    if ( !wxControl::Enable( enable ) )
-        return FALSE;
-  
-    gtk_widget_set_sensitive( GTK_BUTTON(m_widget)->child, enable );
+    wxCHECK_MSG( m_widget != NULL, false, "invalid button" );

 
 

-    return TRUE;
+    const wxString stripped = RemoveMarkup(markup);
+    if ( stripped.empty() && !markup.empty() )
+        return false;
+
+    wxControl::SetLabel(stripped);
+
+    GtkLabel * const label = GTKGetLabel();
+    wxCHECK_MSG( label, false, "no label in this button?" );
+
+    GTKSetLabelWithMarkupForLabel(label, markup);
+
+    return true;

 }
 
 }
 

-void wxButton::ApplyWidgetStyle()
+GtkLabel *wxButton::GTKGetLabel() const

 {
 {

-    SetWidgetStyle();
-    gtk_widget_set_style( m_widget, m_widgetStyle );
-    gtk_widget_set_style( GTK_BUTTON(m_widget)->child, m_widgetStyle );
+    GtkWidget* child = gtk_bin_get_child(GTK_BIN(m_widget));
+    if ( GTK_IS_ALIGNMENT(child) )
+    {
+        GtkWidget* box = gtk_bin_get_child(GTK_BIN(child));
+        GtkLabel* label = NULL;
+        wxGtkList list(gtk_container_get_children(GTK_CONTAINER(box)));
+        for (GList* item = list; item; item = item->next)
+        {
+            if (GTK_IS_LABEL(item->data))
+                label = GTK_LABEL(item->data);
+        }
+
+        return label;
+    }
+
+    return GTK_LABEL(child);

 }
 }

+#endif // wxUSE_MARKUP
+
+void wxButton::DoApplyWidgetStyle(GtkRcStyle *style)
+{
+    gtk_widget_modify_style(m_widget, style);
+    GtkWidget* child = gtk_bin_get_child(GTK_BIN(m_widget));
+    gtk_widget_modify_style(child, style);
+
+    // for buttons with images, the path to the label is (at least in 2.12)
+    // GtkButton -> GtkAlignment -> GtkHBox -> GtkLabel
+    if ( GTK_IS_ALIGNMENT(child) )
+    {
+        GtkWidget* box = gtk_bin_get_child(GTK_BIN(child));
+        if ( GTK_IS_BOX(box) )
+        {
+            wxGtkList list(gtk_container_get_children(GTK_CONTAINER(box)));
+            for (GList* item = list; item; item = item->next)
+            {
+                gtk_widget_modify_style(GTK_WIDGET(item->data), style);
+            }
+        }
+    }
+}
+
+wxSize wxButton::DoGetBestSize() const
+{
+    // the default button in wxGTK is bigger than the other ones because of an
+    // extra border around it, but we don't want to take it into account in
+    // our size calculations (otherwise the result is visually ugly), so
+    // always return the size of non default button from here
+    const bool isDefault = gtk_widget_has_default(m_widget);
+    if ( isDefault )
+    {
+        // temporarily unset default flag
+        gtk_widget_set_can_default(m_widget, FALSE);
+    }
+
+    wxSize ret( wxAnyButton::DoGetBestSize() );
+
+    if ( isDefault )
+    {
+        // set it back again
+        gtk_widget_set_can_default(m_widget, TRUE);
+    }
+
+    if (!HasFlag(wxBU_EXACTFIT))
+    {
+        wxSize defaultSize = GetDefaultSize();
+        if (ret.x < defaultSize.x)
+            ret.x = defaultSize.x;
+        if (ret.y < defaultSize.y)
+            ret.y = defaultSize.y;
+    }
+
+    CacheBestSize(ret);
+    return ret;
+}
+
+// static
+wxVisualAttributes
+wxButton::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
+{
+    return GetDefaultAttributesFromGTKWidget(gtk_button_new);
+}
+
+#endif // wxUSE_BUTTON