docstring fixes

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

diff --git a/src/gtk/button.cpp b/src/gtk/button.cpp
index a3f112390869fb1c1d7d009c5ae67c7f6fc22d69..74281019ca41bd0e4f7ef05a59a4d2a69d90aae1 100644 (file)
--- a/src/gtk/button.cpp
+++ b/src/gtk/button.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$


@@ -7,20 +7,16 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "button.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 

-#include "wx/defs.h"
-

 #if wxUSE_BUTTON
 
 #include "wx/button.h"
 #if wxUSE_BUTTON
 
 #include "wx/button.h"

+#include "wx/stockitem.h"

 
 #include "wx/gtk/private.h"
 
 #include "wx/gtk/private.h"

+#include "wx/gtk/win_gtk.h"

 
 //-----------------------------------------------------------------------------
 // classes
 
 //-----------------------------------------------------------------------------
 // classes


@@ -28,13 +24,6 @@
 
 class wxButton;
 
 
 class wxButton;
 

-//-----------------------------------------------------------------------------
-// idle system
-//-----------------------------------------------------------------------------
-
-extern void wxapp_install_idle_handler();
-extern bool g_isIdle;
-

 //-----------------------------------------------------------------------------
 // data
 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------
 // data
 //-----------------------------------------------------------------------------


@@ -45,6 +34,7 @@ extern bool   g_blockEventsOnDrag;
 // "clicked"
 //-----------------------------------------------------------------------------
 
 // "clicked"
 //-----------------------------------------------------------------------------
 

+extern "C" {

 static void gtk_button_clicked_callback( GtkWidget *WXUNUSED(widget), wxButton *button )
 {
     if (g_isIdle)
 static void gtk_button_clicked_callback( GtkWidget *WXUNUSED(widget), wxButton *button )
 {
     if (g_isIdle)


@@ -57,6 +47,45 @@ static void gtk_button_clicked_callback( GtkWidget *WXUNUSED(widget), wxButton *
     event.SetEventObject(button);
     button->GetEventHandler()->ProcessEvent(event);
 }
     event.SetEventObject(button);
     button->GetEventHandler()->ProcessEvent(event);
 }

+}
+
+//-----------------------------------------------------------------------------
+// "style_set" from m_widget
+//-----------------------------------------------------------------------------
+
+static gint
+gtk_button_style_set_callback( GtkWidget *m_widget, GtkStyle *WXUNUSED(style), wxButton *win )
+{
+    if (g_isIdle)
+        wxapp_install_idle_handler();
+
+    int left_border = 0;
+    int right_border = 0;
+    int top_border = 0;
+    int bottom_border = 0;
+
+    /* the default button has a border around it */
+    if (GTK_WIDGET_CAN_DEFAULT(m_widget))
+    {
+        GtkBorder *default_border = NULL;
+        gtk_widget_style_get( m_widget, "default_border", &default_border, NULL );
+        if (default_border)
+        {
+            left_border += default_border->left;
+            right_border += default_border->right;
+            top_border += default_border->top;
+            bottom_border += default_border->bottom;
+            g_free( default_border );
+        }
+        win->MoveWindow(
+            win->m_x - top_border,
+            win->m_y - left_border,
+            win->m_width + left_border + right_border,
+            win->m_height + top_border + bottom_border);
+    }
+
+    return FALSE;
+}

 
 //-----------------------------------------------------------------------------
 // wxButton
 
 //-----------------------------------------------------------------------------
 // wxButton


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

-    m_needParent = TRUE;
-    m_acceptsFocus = TRUE;
+    m_needParent = true;
+    m_acceptsFocus = true;

 
     if (!PreCreation( parent, pos, size ) ||
         !CreateBase( parent, id, pos, size, style, validator, name ))
     {
         wxFAIL_MSG( wxT("wxButton creation failed") );
 
     if (!PreCreation( parent, pos, size ) ||
         !CreateBase( parent, id, pos, size, style, validator, name ))
     {
         wxFAIL_MSG( wxT("wxButton creation failed") );

-        return FALSE;
+        return false;

     }
 
     }
 

-/*
-    wxString label2( label );
-    for (size_t i = 0; i < label2.Len(); i++)
-    {
-        if (label2.GetChar(i) == wxT('&'))
-        label2.SetChar(i,wxT('_'));
-    }
-
-    GtkWidget *accel_label = gtk_accel_label_new( label2.mb_str() );
-    gtk_widget_show( accel_label );
-
-    m_widget = gtk_button_new();
-    gtk_container_add( GTK_CONTAINER(m_widget), accel_label );
-
-    gtk_accel_label_set_accel_widget( GTK_ACCEL_LABEL(accel_label), m_widget );
-
-    guint accel_key = gtk_label_parse_uline (GTK_LABEL(accel_label), label2.mb_str() );
-    gtk_accel_label_refetch( GTK_ACCEL_LABEL(accel_label) );
-
-    wxControl::SetLabel( label );
-*/
-
-    m_widget = gtk_button_new_with_label("");
+    m_widget = gtk_button_new_with_mnemonic("");

 
     float x_alignment = 0.5;
     if (HasFlag(wxBU_LEFT))
 
     float x_alignment = 0.5;
     if (HasFlag(wxBU_LEFT))


@@ -122,107 +129,177 @@ bool wxButton::Create(  wxWindow *parent, wxWindowID id, const wxString &label,
     else if (HasFlag(wxBU_BOTTOM))
         y_alignment = 1.0;
 
     else if (HasFlag(wxBU_BOTTOM))
         y_alignment = 1.0;
 

-    gtk_misc_set_alignment (GTK_MISC (BUTTON_CHILD (m_widget)),
-                            x_alignment, y_alignment);
+#ifdef __WXGTK24__
+    if (!gtk_check_version(2,4,0))
+    {
+        gtk_button_set_alignment(GTK_BUTTON(m_widget), x_alignment, y_alignment);
+    }
+    else
+#endif
+    {
+        if (GTK_IS_MISC(GTK_BIN(m_widget)->child))
+            gtk_misc_set_alignment(GTK_MISC(GTK_BIN(m_widget)->child),
+                                x_alignment, y_alignment);
+    }

 
 

-    SetLabel( label );
+    SetLabel(label);

 
     if (style & wxNO_BORDER)
        gtk_button_set_relief( GTK_BUTTON(m_widget), GTK_RELIEF_NONE );
 
 
     if (style & wxNO_BORDER)
        gtk_button_set_relief( GTK_BUTTON(m_widget), GTK_RELIEF_NONE );
 

-    gtk_signal_connect( GTK_OBJECT(m_widget), "clicked",
-      GTK_SIGNAL_FUNC(gtk_button_clicked_callback), (gpointer*)this );
-
-    m_parent->DoAddChild( this );
-
-    PostCreation();
-    InheritAttributes();
+    g_signal_connect_after (m_widget, "clicked",
+                            G_CALLBACK (gtk_button_clicked_callback),
+                            this);

 
 

-    wxSize best_size( DoGetBestSize() );
-    wxSize new_size( size );
-    if (new_size.x == -1)
-        new_size.x = best_size.x;
-    if (new_size.y == -1)
-        new_size.y = best_size.y;
-    if ((new_size.x != size.x) || (new_size.y != size.y))
-        SetSize( new_size.x, new_size.y );
+    g_signal_connect_after (m_widget, "style_set",
+                            G_CALLBACK (gtk_button_style_set_callback),
+                            this);

 
 

-    SetSize( new_size );
+    m_parent->DoAddChild( this );

 
 

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

 
 

-    return TRUE;
+    return true;

 }
 
 }
 

+

 void wxButton::SetDefault()
 {
 void wxButton::SetDefault()
 {

+    wxWindow *parent = GetParent();
+    wxCHECK_RET( parent, _T("button without parent?") );
+
+    parent->SetDefaultItem(this);
+

     GTK_WIDGET_SET_FLAGS( m_widget, GTK_CAN_DEFAULT );
     gtk_widget_grab_default( m_widget );
 
     GTK_WIDGET_SET_FLAGS( m_widget, GTK_CAN_DEFAULT );
     gtk_widget_grab_default( m_widget );
 

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

 }
 
 /* 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, wxT("invalid button") );
 
 {
     wxCHECK_RET( m_widget != NULL, wxT("invalid button") );
 

-    wxControl::SetLabel( label );
+    wxString label(lbl);

 
 

-#ifdef __WXGTK20__
-    wxString label2 = PrepareLabelMnemonics( label );
-    gtk_label_set_text_with_mnemonic( GTK_LABEL( BUTTON_CHILD(m_widget) ), wxGTK_CONV( label2 ) );
-#else
-    gtk_label_set( GTK_LABEL( BUTTON_CHILD(m_widget) ), wxGTK_CONV( GetLabel() ) );
-#endif
+    if (label.empty() && wxIsStockID(m_windowId))
+        label = wxGetStockLabel(m_windowId);
+
+    wxControl::SetLabel(label);
+
+    const wxString labelGTK = GTKConvertMnemonics(label);
+
+    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;
+        }
+    }
+
+    gtk_button_set_label(GTK_BUTTON(m_widget), wxGTK_CONV(labelGTK));
+    gtk_button_set_use_stock(GTK_BUTTON(m_widget), FALSE);
+
+    ApplyWidgetStyle( false );

 }
 
 bool wxButton::Enable( bool enable )
 {
     if ( !wxControl::Enable( enable ) )
 }
 
 bool wxButton::Enable( bool enable )
 {
     if ( !wxControl::Enable( enable ) )

-        return FALSE;
+        return false;

 
 

-    gtk_widget_set_sensitive( BUTTON_CHILD(m_widget), enable );
+    gtk_widget_set_sensitive(GTK_BIN(m_widget)->child, enable);

 
 

-    return TRUE;
+    return true;

 }
 
 bool wxButton::IsOwnGtkWindow( GdkWindow *window )
 {
 }
 
 bool wxButton::IsOwnGtkWindow( GdkWindow *window )
 {

-#ifdef __WXGTK20__

     return GTK_BUTTON(m_widget)->event_window;
     return GTK_BUTTON(m_widget)->event_window;

-#else
-    return (window == m_widget->window);
-#endif

 }
 
 }
 

-void wxButton::ApplyWidgetStyle()
+void wxButton::DoApplyWidgetStyle(GtkRcStyle *style)

 {
 {

-    SetWidgetStyle();
-    gtk_widget_set_style( m_widget, m_widgetStyle );
-    gtk_widget_set_style( BUTTON_CHILD(m_widget), m_widgetStyle );
+    gtk_widget_modify_style(m_widget, style);
+    gtk_widget_modify_style(GTK_BIN(m_widget)->child, style);

 }
 
 wxSize wxButton::DoGetBestSize() const
 {
 }
 
 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 (otherwsie 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_UNSET_FLAGS( m_widget, GTK_CAN_DEFAULT );
+    }
+

     wxSize ret( wxControl::DoGetBestSize() );
 
     wxSize ret( wxControl::DoGetBestSize() );
 

-#ifndef __WXGTK20__
-    ret.x += 10;  // add a few pixels for sloppy (but common) themes
-#endif
-    
+    if ( isDefault )
+    {
+        // set it back again
+        GTK_WIDGET_SET_FLAGS( m_widget, GTK_CAN_DEFAULT );
+    }
+

     if (!HasFlag(wxBU_EXACTFIT))
     {
     if (!HasFlag(wxBU_EXACTFIT))
     {

-        if (ret.x < 80) ret.x = 80;
+        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;
 }
 
     return ret;
 }
 

-#endif // wxUSE_BUTTON
+// static
+wxVisualAttributes
+wxButton::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
+{
+    return GetDefaultAttributesFromGTKWidget(gtk_button_new);
+}

 
 

+#endif // wxUSE_BUTTON