Add doc for wxGraphicsContext.Create(), which is a lightweight context with no target...
[wxWidgets.git] / src / gtk / control.cpp
index 06eaec261b5c85e452f4f956b104a2a643ada318..705da6fa502eba15a9843910cada8371965b582a 100644 (file)
@@ -1,38 +1,44 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        control.cpp
-// Purpose:
+// Name:        src/gtk/control.cpp
+// Purpose:     wxControl implementation for wxGTK
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling, Julian Smart and Vadim Zeitlin
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "control.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
-#include "wx/defs.h"
-
 #if wxUSE_CONTROLS
 
 #include "wx/control.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/settings.h"
+#endif
+
 #include "wx/fontutil.h"
-#include "wx/settings.h"
+#include "wx/utils.h"
+#include "wx/sysopt.h"
 
 #include <gtk/gtk.h>
+#include "wx/gtk/private.h"
+#include "wx/gtk/private/mnemonics.h"
 
-//-----------------------------------------------------------------------------
-// wxControl
-//-----------------------------------------------------------------------------
+// ============================================================================
+// wxControl implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxControl creation
+// ----------------------------------------------------------------------------
 
 IMPLEMENT_DYNAMIC_CLASS(wxControl, wxWindow)
 
 wxControl::wxControl()
 {
-    m_needParent = TRUE;
 }
 
 bool wxControl::Create( wxWindow *parent,
@@ -44,7 +50,7 @@ bool wxControl::Create( wxWindow *parent,
                       const wxString &name )
 {
     bool ret = wxWindow::Create(parent, id, pos, size, style, name);
-    
+
 #if wxUSE_VALIDATORS
     SetValidator(validator);
 #endif
@@ -52,106 +58,167 @@ bool wxControl::Create( wxWindow *parent,
     return ret;
 }
 
-void wxControl::SetLabel( const wxString &label )
+#ifdef __WXGTK3__
+bool wxControl::SetFont(const wxFont& font)
 {
-    m_label.Empty();
-    for ( const wxChar *pc = label; *pc != wxT('\0'); pc++ )
+    const bool changed = base_type::SetFont(font);
+    if (changed && !gtk_widget_get_realized(m_widget))
     {
-        if ( *pc == wxT('&') )
-        {
-            pc++; // skip it
-#if 0 // it would be unused anyhow for now - kbd interface not done yet
-            if ( *pc != wxT('&') ) m_chAccel = *pc;
-#endif
-        }
-        m_label << *pc;
+        // GTK defers sending "style-updated" until widget is realized, but
+        // GetBestSize() won't compute correct result until the signal is sent,
+        // so we have to do it now
+        g_signal_emit_by_name(m_widget, "style-updated");
     }
-    InvalidateBestSize();    
+    return changed;
 }
-
-wxString wxControl::GetLabel() const
-{
-    return m_label;
-}
-
+#endif
 
 wxSize wxControl::DoGetBestSize() const
 {
     // Do not return any arbitrary default value...
     wxASSERT_MSG( m_widget, wxT("DoGetBestSize called before creation") );
 
-    GtkRequisition req;
-    req.width = 2;
-    req.height = 2;
-    (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget) )->size_request )
-        (m_widget, &req );
+    wxSize best;
+    if (m_wxwindow)
+    {
+        // this is not a native control, size_request is likely to be (0,0)
+        best = wxControlBase::DoGetBestSize();
+    }
+    else
+    {
+        best = GTKGetPreferredSize(m_widget);
+    }
 
-    wxSize best(req.width, req.height);
-    CacheBestSize(best);
     return best;
 }
 
-
 void wxControl::PostCreation(const wxSize& size)
 {
     wxWindow::PostCreation();
 
+#ifndef __WXGTK3__
     // NB: GetBestSize needs to know the style, otherwise it will assume
     //     default font and if the user uses a different font, determined
     //     best size will be different (typically, smaller) than the desired
     //     size. This call ensure that a style is available at the time
     //     GetBestSize is called.
     gtk_widget_ensure_style(m_widget);
-    
-    ApplyWidgetStyle();
-    SetInitialBestSize(size);
+#endif
+
+    SetInitialSize(size);
 }
 
+// ----------------------------------------------------------------------------
+// Work around a GTK+ bug whereby button is insensitive after being
+// enabled
+// ----------------------------------------------------------------------------
 
-#ifdef __WXGTK20__
-wxString wxControl::PrepareLabelMnemonics( const wxString &label ) const
+// Fix sensitivity due to bug in GTK+ < 2.14
+void wxControl::GTKFixSensitivity(bool WXUNUSED_IN_GTK3(onlyIfUnderMouse))
 {
-    //Format mnemonics properly for GTK2. This can be called from GTK1.x, but
-    //it's not very useful because mnemonics don't exist prior to GTK2.
-    wxString label2;
-    for (size_t i = 0; i < label.Len(); i++)
+#ifndef __WXGTK3__
+    if (gtk_check_version(2,14,0)
+#if wxUSE_SYSTEM_OPTIONS
+        && (wxSystemOptions::GetOptionInt(wxT("gtk.control.disable-sensitivity-fix")) != 1)
+#endif
+        )
     {
-        if (label.GetChar(i) == wxT('&'))
-        {
-            //Mnemonic escape sequence "&&" is a literal "&" in the output.
-            if (label.GetChar(i + 1) == wxT('&'))
-            {
-                label2 << wxT('&');
-                i++;
-            }
-            //Handle special case of "&_" (i.e. "_" is the mnemonic).
-            //FIXME - Is it possible to use "_" as a GTK mnemonic? Just use a
-            //dash for now.
-            else if (label.GetChar(i + 1) == wxT('_'))
-            {
-                label2 << wxT("_-");
-                i++;
-            }
-            //Replace WX mnemonic indicator "&" with GTK indicator "_".
-            else
-            {
-                label2 << wxT('_');
-            }
-        }
-        else if (label.GetChar(i) == wxT('_'))
-        {
-            //Escape any underlines in the string so GTK doesn't use them.
-            label2 << wxT("__");
-        }
-        else
+        if (!onlyIfUnderMouse || GetScreenRect().Contains(wxGetMousePosition()))
         {
-            label2 << label.GetChar(i);
+            Hide();
+            Show();
         }
     }
-    return label2;
-}
 #endif
+}
+
+// ----------------------------------------------------------------------------
+// wxControl dealing with labels
+// ----------------------------------------------------------------------------
+
+void wxControl::GTKSetLabelForLabel(GtkLabel *w, const wxString& label)
+{
+    const wxString labelGTK = GTKConvertMnemonics(label);
+    gtk_label_set_text_with_mnemonic(w, wxGTK_CONV(labelGTK));
+}
+
+#if wxUSE_MARKUP
+
+void wxControl::GTKSetLabelWithMarkupForLabel(GtkLabel *w, const wxString& label)
+{
+    const wxString labelGTK = GTKConvertMnemonicsWithMarkup(label);
+    gtk_label_set_markup_with_mnemonic(w, wxGTK_CONV(labelGTK));
+}
+
+#endif // wxUSE_MARKUP
+
+// ----------------------------------------------------------------------------
+// GtkFrame helpers
+//
+// GtkFrames do in fact support mnemonics in GTK2+ but not through
+// gtk_frame_set_label, rather you need to use a custom label widget
+// instead (idea gleaned from the native gtk font dialog code in GTK)
+// ----------------------------------------------------------------------------
+
+GtkWidget* wxControl::GTKCreateFrame(const wxString& label)
+{
+    const wxString labelGTK = GTKConvertMnemonics(label);
+    GtkWidget* labelwidget = gtk_label_new_with_mnemonic(wxGTK_CONV(labelGTK));
+    gtk_widget_show(labelwidget); // without this it won't show...
+
+    GtkWidget* framewidget = gtk_frame_new(NULL);
+    gtk_frame_set_label_widget(GTK_FRAME(framewidget), labelwidget);
+
+    return framewidget; // note that the label is already set so you'll
+                        // only need to call wxControl::SetLabel afterwards
+}
+
+void wxControl::GTKSetLabelForFrame(GtkFrame *w, const wxString& label)
+{
+    wxControlBase::SetLabel(label);
+
+    GtkLabel* labelwidget = GTK_LABEL(gtk_frame_get_label_widget(w));
+    GTKSetLabelForLabel(labelwidget, label);
+}
+
+void wxControl::GTKFrameApplyWidgetStyle(GtkFrame* w, GtkRcStyle* style)
+{
+    GTKApplyStyle(GTK_WIDGET(w), style);
+    GTKApplyStyle(gtk_frame_get_label_widget(w), style);
+}
+
+void wxControl::GTKFrameSetMnemonicWidget(GtkFrame* w, GtkWidget* widget)
+{
+    GtkLabel* labelwidget = GTK_LABEL(gtk_frame_get_label_widget(w));
+
+    gtk_label_set_mnemonic_widget(labelwidget, widget);
+}
+
+// ----------------------------------------------------------------------------
+// worker function implementing GTK*Mnemonics() functions
+// ----------------------------------------------------------------------------
+
+/* static */
+wxString wxControl::GTKRemoveMnemonics(const wxString& label)
+{
+    return wxGTKRemoveMnemonics(label);
+}
 
+/* static */
+wxString wxControl::GTKConvertMnemonics(const wxString& label)
+{
+    return wxConvertMnemonicsToGTK(label);
+}
+
+/* static */
+wxString wxControl::GTKConvertMnemonicsWithMarkup(const wxString& label)
+{
+    return wxConvertMnemonicsToGTKMarkup(label);
+}
+
+// ----------------------------------------------------------------------------
+// wxControl styles (a.k.a. attributes)
+// ----------------------------------------------------------------------------
 
 wxVisualAttributes wxControl::GetDefaultAttributes() const
 {
@@ -159,59 +226,75 @@ wxVisualAttributes wxControl::GetDefaultAttributes() const
                                              UseGTKStyleBase());
 }
 
-
-#define SHIFT (8*(sizeof(short int)-sizeof(char)))
-
 // static
 wxVisualAttributes
 wxControl::GetDefaultAttributesFromGTKWidget(GtkWidget* widget,
-                                             bool useBase,
+                                             bool WXUNUSED_IN_GTK3(useBase),
                                              int state)
 {
-    GtkStyle* style;
     wxVisualAttributes attr;
 
+    GtkWidget* tlw = NULL;
+    if (gtk_widget_get_parent(widget) == NULL)
+    {
+        tlw = gtk_window_new(GTK_WINDOW_TOPLEVEL);
+        gtk_container_add(GTK_CONTAINER(tlw), widget);
+    }
+
+#ifdef __WXGTK3__
+    GtkStateFlags stateFlag = GTK_STATE_FLAG_NORMAL;
+    if (state)
+    {
+        wxASSERT(state == GTK_STATE_ACTIVE);
+        stateFlag = GTK_STATE_FLAG_ACTIVE;
+    }
+    GtkStyleContext* sc = gtk_widget_get_style_context(widget);
+    GdkRGBA c;
+    gtk_style_context_get_color(sc, stateFlag, &c);
+    attr.colFg = wxColour(c);
+    gtk_style_context_get_background_color(sc, stateFlag, &c);
+    attr.colBg = wxColour(c);
+    wxNativeFontInfo info;
+    info.description = const_cast<PangoFontDescription*>(gtk_style_context_get_font(sc, stateFlag));
+    attr.font = wxFont(info);
+    info.description = NULL;
+#else
+    GtkStyle* style;
+
     style = gtk_rc_get_style(widget);
     if (!style)
         style = gtk_widget_get_default_style();
 
-    if (!style)
+    if (style)
     {
-        return wxWindow::GetClassDefaultAttributes(wxWINDOW_VARIANT_NORMAL);
-    }
+        // get the style's colours
+        attr.colFg = wxColour(style->fg[state]);
+        if (useBase)
+            attr.colBg = wxColour(style->base[state]);
+        else
+            attr.colBg = wxColour(style->bg[state]);
 
-    if (state == -1)
-        state = GTK_STATE_NORMAL;
-        
-    // get the style's colours
-    attr.colFg = wxColour(style->fg[state].red   >> SHIFT,
-                          style->fg[state].green >> SHIFT,
-                          style->fg[state].blue  >> SHIFT);
-    if (useBase)
-        attr.colBg = wxColour(style->base[state].red   >> SHIFT,
-                              style->base[state].green >> SHIFT,
-                              style->base[state].blue  >> SHIFT);
+        // get the style's font
+        if (!style->font_desc)
+            style = gtk_widget_get_default_style();
+        if (style && style->font_desc)
+        {
+            wxNativeFontInfo info;
+            info.description = style->font_desc;
+            attr.font = wxFont(info);
+            info.description = NULL;
+        }
+    }
     else
-        attr.colBg = wxColour(style->bg[state].red   >> SHIFT,
-                              style->bg[state].green >> SHIFT,
-                              style->bg[state].blue  >> SHIFT);
-
-    // get the style's font
-#ifdef __WXGTK20__
-    if ( !style->font_desc )
-        style = gtk_widget_get_default_style();  
-    if ( style && style->font_desc )
-    {  
-        wxNativeFontInfo info;  
-        info.description = pango_font_description_copy(style->font_desc);
-        attr.font = wxFont(info);  
-    }  
-    else  
-    {  
+        attr = wxWindow::GetClassDefaultAttributes(wxWINDOW_VARIANT_NORMAL);
+#endif
+
+    if (!attr.font.IsOk())
+    {
         GtkSettings *settings = gtk_settings_get_default();
         gchar *font_name = NULL;
         g_object_get ( settings,
-                       "gtk-font-name", 
+                       "gtk-font-name",
                        &font_name,
                        NULL);
         if (!font_name)
@@ -219,64 +302,57 @@ wxControl::GetDefaultAttributesFromGTKWidget(GtkWidget* widget,
         else
             attr.font = wxFont(wxString::FromAscii(font_name));
         g_free (font_name);
-    }  
-#else
-    // TODO: isn't there a way to get a standard gtk 1.2 font?
-    attr.font = wxFont( 12, wxSWISS, wxNORMAL, wxNORMAL );
-#endif
-    
-    return attr;
-}
+    }
 
+    if (tlw)
+        gtk_widget_destroy(tlw);
 
-//static
-wxVisualAttributes
-wxControl::GetDefaultAttributesFromGTKWidget(GtkWidget* (*widget_new)(void),
-                                             bool useBase,
-                                             int state)
-{
-    wxVisualAttributes attr;
-    // NB: we need toplevel window so that GTK+ can find the right style
-    GtkWidget *wnd = gtk_window_new(GTK_WINDOW_TOPLEVEL);
-    GtkWidget* widget = widget_new();
-    gtk_container_add(GTK_CONTAINER(wnd), widget);
-    attr = GetDefaultAttributesFromGTKWidget(widget, useBase, state);
-    gtk_widget_destroy(wnd);
     return attr;
 }
 
-//static
-wxVisualAttributes
-wxControl::GetDefaultAttributesFromGTKWidget(GtkWidget* (*widget_new)(const gchar*),
-                                             bool useBase,
-                                             int state)
+// This is not the same as GetBestSize() because that size may have
+// been recalculated and cached by us. We want GTK+ information.
+wxSize wxControl::GTKGetPreferredSize(GtkWidget* widget) const
 {
-    wxVisualAttributes attr;
-    // NB: we need toplevel window so that GTK+ can find the right style
-    GtkWidget *wnd = gtk_window_new(GTK_WINDOW_TOPLEVEL);
-    GtkWidget* widget = widget_new("");
-    gtk_container_add(GTK_CONTAINER(wnd), widget);
-    attr = GetDefaultAttributesFromGTKWidget(widget, useBase, state);
-    gtk_widget_destroy(wnd);
-    return attr;
-}
+    GtkRequisition req;
+#ifdef __WXGTK3__
+    gtk_widget_get_preferred_size(widget, NULL, &req);
+#else
+    GTK_WIDGET_GET_CLASS(widget)->size_request(widget, &req);
+#endif
 
+    return wxSize(req.width, req.height);
+}
 
-//static
-wxVisualAttributes
-wxControl::GetDefaultAttributesFromGTKWidget(GtkWidget* (*widget_new)(GtkAdjustment*),
-                                             bool useBase,
-                                             int state)
+wxPoint wxControl::GTKGetEntryMargins(GtkEntry* entry) const
 {
-    wxVisualAttributes attr;
-    // NB: we need toplevel window so that GTK+ can find the right style
-    GtkWidget *wnd = gtk_window_new(GTK_WINDOW_TOPLEVEL);
-    GtkWidget* widget = widget_new(NULL);
-    gtk_container_add(GTK_CONTAINER(wnd), widget);
-    attr = GetDefaultAttributesFromGTKWidget(widget, useBase, state);
-    gtk_widget_destroy(wnd);
-    return attr;
+    wxPoint marg(0, 0);
+
+#ifndef __WXGTK3__
+#if GTK_CHECK_VERSION(2,10,0)
+    // The margins we have previously set
+    const GtkBorder* border = gtk_entry_get_inner_border(entry);
+    if ( border )
+    {
+        marg.x = border->left + border->right;
+        marg.y = border->top + border->bottom;
+    }
+#endif // GTK+ 2.10+
+#else // GTK+ 3
+    // Gtk3 does not use inner border, but StyleContext and CSS
+    // TODO: implement it, starting with wxTextEntry::DoSetMargins()
+#endif // GTK+ 2/3
+
+    int x, y;
+    gtk_entry_get_layout_offsets(entry, &x, &y);
+    // inner borders are included. Substract them so we can get other margins
+    x -= marg.x;
+    y -= marg.y;
+    marg.x += 2 * x + 2;
+    marg.y += 2 * y + 2;
+
+    return marg;
 }
 
-#endif // wxUSE_CONTROLS
 
+#endif // wxUSE_CONTROLS