docstring fixes

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

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

-// 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
+// For compilers that support precompilation, includes "wx.h".
+#include "wx/wxprec.h"
+
+#if wxUSE_BUTTON

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

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

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


@@ -29,14 +34,57 @@ extern bool   g_blockEventsOnDrag;
 // "clicked"
 //-----------------------------------------------------------------------------
 
 // "clicked"
 //-----------------------------------------------------------------------------
 

+extern "C" {

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

-  if (!button->HasVMT()) return;
-  if (g_blockEventsOnDrag) return;
-  
-  wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, button->GetId());
-  event.SetEventObject(button);
-  button->GetEventHandler()->ProcessEvent(event);
+    if (g_isIdle)
+       wxapp_install_idle_handler();
+
+    if (!button->m_hasVMT) return;
+    if (g_blockEventsOnDrag) return;
+
+    wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, button->GetId());
+    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;

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


@@ -45,7 +93,11 @@ static void gtk_button_clicked_callback( GtkWidget *WXUNUSED(widget), wxButton *
 
 IMPLEMENT_DYNAMIC_CLASS(wxButton,wxControl)
 
 
 IMPLEMENT_DYNAMIC_CLASS(wxButton,wxControl)
 

-wxButton::wxButton(void)
+wxButton::wxButton()
+{
+}
+
+wxButton::~wxButton()

 {
 }
 
 {
 }
 


@@ -53,83 +105,201 @@ 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_needParent = true;
+    m_acceptsFocus = true;
+
+    if (!PreCreation( parent, pos, size ) ||
+        !CreateBase( parent, id, pos, size, style, validator, name ))
+    {
+        wxFAIL_MSG( wxT("wxButton creation failed") );
+        return false;
+    }
+
+    m_widget = gtk_button_new_with_mnemonic("");
+
+    float x_alignment = 0.5;
+    if (HasFlag(wxBU_LEFT))
+        x_alignment = 0.0;
+    else if (HasFlag(wxBU_RIGHT))
+        x_alignment = 1.0;
+
+    float y_alignment = 0.5;
+    if (HasFlag(wxBU_TOP))
+        y_alignment = 0.0;
+    else if (HasFlag(wxBU_BOTTOM))
+        y_alignment = 1.0;
+
+#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);
+
+    if (style & wxNO_BORDER)
+       gtk_button_set_relief( GTK_BUTTON(m_widget), GTK_RELIEF_NONE );
+
+    g_signal_connect_after (m_widget, "clicked",
+                            G_CALLBACK (gtk_button_clicked_callback),
+                            this);
+
+    g_signal_connect_after (m_widget, "style_set",
+                            G_CALLBACK (gtk_button_style_set_callback),
+                            this);
+
+    m_parent->DoAddChild( this );
+
+    PostCreation(size);
+
+    return true;
+}
+
+
+void wxButton::SetDefault()
+{
+    wxWindow *parent = GetParent();
+    wxCHECK_RET( parent, _T("button without parent?") );

 
 

-  wxSize newSize = size;
+    parent->SetDefaultItem(this);

 
 

-  PreCreation( parent, id, pos, newSize, style, name );
-  
-  SetValidator( validator );
+    GTK_WIDGET_SET_FLAGS( m_widget, GTK_CAN_DEFAULT );
+    gtk_widget_grab_default( m_widget );

 
 

-  m_widget = gtk_button_new_with_label( m_label );
-  SetLabel(label);
+    // resize for default border
+    gtk_button_style_set_callback( m_widget, NULL, this );
+}

 
 

-  if (newSize.x == -1) newSize.x = 15+gdk_string_measure( m_widget->style->font, label );
-  if (newSize.y == -1) newSize.y = 26;
-  SetSize( newSize.x, newSize.y );
+/* static */
+wxSize wxButtonBase::GetDefaultSize()
+{
+    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.

 
 

-  gtk_signal_connect( GTK_OBJECT(m_widget), "clicked",
-    GTK_SIGNAL_FUNC(gtk_button_clicked_callback), (gpointer*)this );
+        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);

 
 

-  PostCreation();
-  
-  SetBackgroundColour( parent->GetBackgroundColour() );
+        gint minwidth, minheight;
+        gtk_widget_style_get(box,
+                             "child-min-width", &minwidth,
+                             "child-min-height", &minheight,
+                             NULL);

 
 

-  Show( TRUE );
+        size.x = wxMax(minwidth, req.width);
+        size.y = wxMax(minheight, req.height);

 
 

-  return TRUE;
+        gtk_widget_destroy(wnd);
+    }
+    return size;

 }
 
 }
 

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

 {
 {

-/*
-  GTK_WIDGET_SET_FLAGS( m_widget, GTK_CAN_DEFAULT );
-  gtk_widget_grab_default( m_widget );
-*/
+    wxCHECK_RET( m_widget != NULL, wxT("invalid button") );
+
+    wxString label(lbl);
+
+    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 );

 }
 
 }
 

-void wxButton::SetLabel( const wxString &label )
+bool wxButton::Enable( bool enable )

 {
 {

-  wxCHECK_RET( m_widget != NULL, "invalid button" );
-  
-  wxControl::SetLabel( label );
-  
-  gtk_label_set( GTK_LABEL( GTK_BUTTON(m_widget)->child ), GetLabel() );
+    if ( !wxControl::Enable( enable ) )
+        return false;
+
+    gtk_widget_set_sensitive(GTK_BIN(m_widget)->child, enable);
+
+    return true;

 }
 
 }
 

-void wxButton::Enable( bool enable )
+bool wxButton::IsOwnGtkWindow( GdkWindow *window )

 {
 {

-  wxCHECK_RET( m_widget != NULL, "invalid button" );
-  
-  wxControl::Enable( enable );
-  
-  gtk_widget_set_sensitive( GTK_BUTTON(m_widget)->child, enable );
+    return GTK_BUTTON(m_widget)->event_window;

 }
 
 }
 

-void wxButton::SetFont( const wxFont &font )
+void wxButton::DoApplyWidgetStyle(GtkRcStyle *style)

 {
 {

-  wxCHECK_RET( m_widget != NULL, "invalid button" );
-  
-  wxControl::SetFont( font );
-  
-  gtk_widget_set_style( GTK_BUTTON(m_widget)->child, 
-    gtk_style_ref(
-      gtk_widget_get_style( m_widget ) ) );
+    gtk_widget_modify_style(m_widget, style);
+    gtk_widget_modify_style(GTK_BIN(m_widget)->child, style);

 }
 
 }
 

-void wxButton::SetBackgroundColour( const wxColour &colour )
+wxSize wxButton::DoGetBestSize() const

 {
 {

-  return;
+    // 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() );

 
 

-  wxCHECK_RET( m_widget != NULL, "invalid button" );
+    if ( isDefault )
+    {
+        // set it back again
+        GTK_WIDGET_SET_FLAGS( m_widget, GTK_CAN_DEFAULT );
+    }

 
 

-  wxControl::SetBackgroundColour( colour );
-  
-  if (!m_backgroundColour.Ok()) return;
-  
-  gtk_widget_set_style( GTK_BUTTON(m_widget)->child, 
-    gtk_style_ref(
-      gtk_widget_get_style( m_widget ) ) );
+    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