src/gtk/button.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/button.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 // For compilers that support precompilation, includes "wx.h".
  11 #include "wx/wxprec.h"
  12
  13 #if wxUSE_BUTTON
  14
  15 #ifndef WX_PRECOMP
  16     #include "wx/button.h"
  17 #endif
  18
  19 #include "wx/stockitem.h"
  20
  21 #include <gtk/gtk.h>
  22 #include "wx/gtk/private.h"
  23 #include "wx/gtk/private/gtk2-compat.h"
  24 #include "wx/gtk/private/list.h"
  25
  26 // ----------------------------------------------------------------------------
  27 // GTK callbacks
  28 // ----------------------------------------------------------------------------
  29
  30 extern "C"
  31 {
  32
  33 static void
  34 wxgtk_button_clicked_callback(GtkWidget *WXUNUSED(widget), wxButton *button)
  35 {
  36     if ( button->GTKShouldIgnoreEvent() )
  37         return;
  38
  39     wxCommandEvent event(wxEVT_BUTTON, button->GetId());
  40     event.SetEventObject(button);
  41     button->HandleWindowEvent(event);
  42 }
  43
  44 //-----------------------------------------------------------------------------
  45 // "style_set" from m_widget
  46 //-----------------------------------------------------------------------------
  47
  48 static void
  49 wxgtk_button_style_set_callback(GtkWidget* widget, GtkStyle*, wxButton* win)
  50 {
  51     /* the default button has a border around it */
  52     wxWindow* parent = win->GetParent();
  53     if (parent && parent->m_wxwindow && gtk_widget_get_can_default(widget))
  54     {
  55         GtkBorder* border = NULL;
  56         gtk_widget_style_get(widget, "default_border", &border, NULL);
  57         if (border)
  58         {
  59             win->MoveWindow(
  60                 win->m_x - border->left,
  61                 win->m_y - border->top,
  62                 win->m_width + border->left + border->right,
  63                 win->m_height + border->top + border->bottom);
  64             gtk_border_free(border);
  65         }
  66     }
  67 }
  68
  69 } // extern "C"
  70
  71 //-----------------------------------------------------------------------------
  72 // wxButton
  73 //-----------------------------------------------------------------------------
  74
  75 bool wxButton::Create(wxWindow *parent,
  76                       wxWindowID id,
  77                       const wxString &label,
  78                       const wxPoint& pos,
  79                       const wxSize& size,
  80                       long style,
  81                       const wxValidator& validator,
  82                       const wxString& name)
  83 {
  84     if (!PreCreation( parent, pos, size ) ||
  85         !CreateBase( parent, id, pos, size, style, validator, name ))
  86     {
  87         wxFAIL_MSG( wxT("wxButton creation failed") );
  88         return false;
  89     }
  90
  91     // create either a standard button with text label (which may still contain
  92     // an image under GTK+ 2.6+) or a bitmap-only button if we don't have any
  93     // label
  94     const bool
  95         useLabel = !(style & wxBU_NOTEXT) && (!label.empty() || wxIsStockID(id));
  96     if ( useLabel )
  97     {
  98         m_widget = gtk_button_new_with_mnemonic("");
  99     }
 100     else // no label, suppose we will have a bitmap
 101     {
 102         m_widget = gtk_button_new();
 103
 104         GtkWidget *image = gtk_image_new();
 105         gtk_widget_show(image);
 106         gtk_container_add(GTK_CONTAINER(m_widget), image);
 107     }
 108
 109     g_object_ref(m_widget);
 110
 111     float x_alignment = 0.5;
 112     if (HasFlag(wxBU_LEFT))
 113         x_alignment = 0.0;
 114     else if (HasFlag(wxBU_RIGHT))
 115         x_alignment = 1.0;
 116
 117     float y_alignment = 0.5;
 118     if (HasFlag(wxBU_TOP))
 119         y_alignment = 0.0;
 120     else if (HasFlag(wxBU_BOTTOM))
 121         y_alignment = 1.0;
 122
 123     gtk_button_set_alignment(GTK_BUTTON(m_widget), x_alignment, y_alignment);
 124
 125     if ( useLabel )
 126         SetLabel(label);
 127
 128     if (style & wxNO_BORDER)
 129        gtk_button_set_relief( GTK_BUTTON(m_widget), GTK_RELIEF_NONE );
 130
 131     g_signal_connect_after (m_widget, "clicked",
 132                             G_CALLBACK (wxgtk_button_clicked_callback),
 133                             this);
 134
 135     g_signal_connect_after (m_widget, "style_set",
 136                             G_CALLBACK (wxgtk_button_style_set_callback),
 137                             this);
 138
 139     m_parent->DoAddChild( this );
 140
 141     PostCreation(size);
 142
 143     return true;
 144 }
 145
 146
 147 wxWindow *wxButton::SetDefault()
 148 {
 149     wxWindow *oldDefault = wxButtonBase::SetDefault();
 150
 151     gtk_widget_set_can_default(m_widget, TRUE);
 152     gtk_widget_grab_default( m_widget );
 153
 154     // resize for default border
 155     wxgtk_button_style_set_callback( m_widget, NULL, this );
 156
 157     return oldDefault;
 158 }
 159
 160 /* static */
 161 wxSize wxButtonBase::GetDefaultSize()
 162 {
 163     static wxSize size = wxDefaultSize;
 164     if (size == wxDefaultSize)
 165     {
 166         // NB: Default size of buttons should be same as size of stock
 167         //     buttons as used in most GTK+ apps. Unfortunately it's a little
 168         //     tricky to obtain this size: stock button's size may be smaller
 169         //     than size of button in GtkButtonBox and vice versa,
 170         //     GtkButtonBox's minimal button size may be smaller than stock
 171         //     button's size. We have to retrieve both values and combine them.
 172
 173         GtkWidget *wnd = gtk_window_new(GTK_WINDOW_TOPLEVEL);
 174         GtkWidget *box = gtk_button_box_new(GTK_ORIENTATION_HORIZONTAL);
 175         GtkWidget *btn = gtk_button_new_from_stock(GTK_STOCK_CANCEL);
 176         gtk_container_add(GTK_CONTAINER(box), btn);
 177         gtk_container_add(GTK_CONTAINER(wnd), box);
 178         GtkRequisition req;
 179         gtk_widget_get_preferred_size(btn, NULL, &req);
 180
 181         gint minwidth, minheight;
 182         gtk_widget_style_get(box,
 183                              "child-min-width", &minwidth,
 184                              "child-min-height", &minheight,
 185                              NULL);
 186
 187         size.x = wxMax(minwidth, req.width);
 188         size.y = wxMax(minheight, req.height);
 189
 190         gtk_widget_destroy(wnd);
 191     }
 192     return size;
 193 }
 194
 195 void wxButton::SetLabel( const wxString &lbl )
 196 {
 197     wxCHECK_RET( m_widget != NULL, wxT("invalid button") );
 198
 199     wxString label(lbl);
 200
 201     if (label.empty() && wxIsStockID(m_windowId))
 202         label = wxGetStockLabel(m_windowId);
 203
 204     wxAnyButton::SetLabel(label);
 205
 206     // don't use label if it was explicitly disabled
 207     if ( HasFlag(wxBU_NOTEXT) )
 208         return;
 209
 210     if (wxIsStockID(m_windowId) && wxIsStockLabel(m_windowId, label))
 211     {
 212         const char *stock = wxGetStockGtkID(m_windowId);
 213         if (stock)
 214         {
 215             gtk_button_set_label(GTK_BUTTON(m_widget), stock);
 216             gtk_button_set_use_stock(GTK_BUTTON(m_widget), TRUE);
 217             return;
 218         }
 219     }
 220
 221     // this call is necessary if the button had been initially created without
 222     // a (text) label -- then we didn't use gtk_button_new_with_mnemonic() and
 223     // so "use-underline" GtkButton property remained unset
 224     gtk_button_set_use_underline(GTK_BUTTON(m_widget), TRUE);
 225     const wxString labelGTK = GTKConvertMnemonics(label);
 226     gtk_button_set_label(GTK_BUTTON(m_widget), wxGTK_CONV(labelGTK));
 227     gtk_button_set_use_stock(GTK_BUTTON(m_widget), FALSE);
 228
 229     GTKApplyWidgetStyle( false );
 230 }
 231
 232 #if wxUSE_MARKUP
 233 bool wxButton::DoSetLabelMarkup(const wxString& markup)
 234 {
 235     wxCHECK_MSG( m_widget != NULL, false, "invalid button" );
 236
 237     const wxString stripped = RemoveMarkup(markup);
 238     if ( stripped.empty() && !markup.empty() )
 239         return false;
 240
 241     wxControl::SetLabel(stripped);
 242
 243     GtkLabel * const label = GTKGetLabel();
 244     wxCHECK_MSG( label, false, "no label in this button?" );
 245
 246     GTKSetLabelWithMarkupForLabel(label, markup);
 247
 248     return true;
 249 }
 250
 251 GtkLabel *wxButton::GTKGetLabel() const
 252 {
 253     GtkWidget* child = gtk_bin_get_child(GTK_BIN(m_widget));
 254     if ( GTK_IS_ALIGNMENT(child) )
 255     {
 256         GtkWidget* box = gtk_bin_get_child(GTK_BIN(child));
 257         GtkLabel* label = NULL;
 258         wxGtkList list(gtk_container_get_children(GTK_CONTAINER(box)));
 259         for (GList* item = list; item; item = item->next)
 260         {
 261             if (GTK_IS_LABEL(item->data))
 262                 label = GTK_LABEL(item->data);
 263         }
 264
 265         return label;
 266     }
 267
 268     return GTK_LABEL(child);
 269 }
 270 #endif // wxUSE_MARKUP
 271
 272 void wxButton::DoApplyWidgetStyle(GtkRcStyle *style)
 273 {
 274     GTKApplyStyle(m_widget, style);
 275     GtkWidget* child = gtk_bin_get_child(GTK_BIN(m_widget));
 276     GTKApplyStyle(child, style);
 277
 278     // for buttons with images, the path to the label is (at least in 2.12)
 279     // GtkButton -> GtkAlignment -> GtkHBox -> GtkLabel
 280     if ( GTK_IS_ALIGNMENT(child) )
 281     {
 282         GtkWidget* box = gtk_bin_get_child(GTK_BIN(child));
 283         if ( GTK_IS_BOX(box) )
 284         {
 285             wxGtkList list(gtk_container_get_children(GTK_CONTAINER(box)));
 286             for (GList* item = list; item; item = item->next)
 287             {
 288                 GTKApplyStyle(GTK_WIDGET(item->data), style);
 289             }
 290         }
 291     }
 292 }
 293
 294 wxSize wxButton::DoGetBestSize() const
 295 {
 296     // the default button in wxGTK is bigger than the other ones because of an
 297     // extra border around it, but we don't want to take it into account in
 298     // our size calculations (otherwise the result is visually ugly), so
 299     // always return the size of non default button from here
 300     const bool isDefault = gtk_widget_has_default(m_widget) != 0;
 301     if ( isDefault )
 302     {
 303         // temporarily unset default flag
 304         gtk_widget_set_can_default(m_widget, FALSE);
 305     }
 306
 307     wxSize ret( wxAnyButton::DoGetBestSize() );
 308
 309     if ( isDefault )
 310     {
 311         // set it back again
 312         gtk_widget_set_can_default(m_widget, TRUE);
 313     }
 314
 315     if (!HasFlag(wxBU_EXACTFIT))
 316     {
 317         wxSize defaultSize = GetDefaultSize();
 318         if (ret.x < defaultSize.x)
 319             ret.x = defaultSize.x;
 320         if (ret.y < defaultSize.y)
 321             ret.y = defaultSize.y;
 322     }
 323
 324     CacheBestSize(ret);
 325     return ret;
 326 }
 327
 328 // static
 329 wxVisualAttributes
 330 wxButton::GetClassDefaultAttributes(wxWindowVariant WXUNUSED(variant))
 331 {
 332     return GetDefaultAttributesFromGTKWidget(gtk_button_new());
 333 }
 334
 335 #endif // wxUSE_BUTTON