]> git.saurik.com Git - wxWidgets.git/blobdiff - src/gtk/control.cpp
correction to last commit: don't test unsetenv() return value, it's void under Darwin
[wxWidgets.git] / src / gtk / control.cpp
index dfbfe4b9c0eba7cf531840269c3c511f5c72f6eb..7369e8cd9e27678fba6c4d3dfd37e57c62b52707 100644 (file)
@@ -1,38 +1,42 @@
 /////////////////////////////////////////////////////////////////////////////
-// 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/gtk/private.h"
 
-#include <gtk/gtk.h>
+#include "wx/private/stattext.h"
 
-//-----------------------------------------------------------------------------
-// wxControl
-//-----------------------------------------------------------------------------
+
+// ============================================================================
+// wxControl implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxControl creation
+// ----------------------------------------------------------------------------
 
 IMPLEMENT_DYNAMIC_CLASS(wxControl, wxWindow)
 
 wxControl::wxControl()
 {
-    m_needParent = TRUE;
 }
 
 bool wxControl::Create( wxWindow *parent,
@@ -44,7 +48,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,28 +56,6 @@ bool wxControl::Create( wxWindow *parent,
     return ret;
 }
 
-void wxControl::SetLabel( const wxString &label )
-{
-    m_label.Empty();
-    for ( const wxChar *pc = label; *pc != wxT('\0'); pc++ )
-    {
-        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;
-    }
-}
-
-wxString wxControl::GetLabel() const
-{
-    return m_label;
-}
-
-
 wxSize wxControl::DoGetBestSize() const
 {
     // Do not return any arbitrary default value...
@@ -85,63 +67,210 @@ wxSize wxControl::DoGetBestSize() const
     (* GTK_WIDGET_CLASS( GTK_OBJECT_GET_CLASS(m_widget) )->size_request )
         (m_widget, &req );
 
-    return wxSize(req.width, req.height);
+    wxSize best(req.width, req.height);
+    CacheBestSize(best);
+    return best;
 }
 
-
 void wxControl::PostCreation(const wxSize& size)
 {
     wxWindow::PostCreation();
-    InheritAttributes();
+
+    // 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);
+    SetInitialSize(size);
+}
+
+// ----------------------------------------------------------------------------
+// wxControl dealing with labels
+// ----------------------------------------------------------------------------
+
+void wxControl::GTKSetLabelForLabel(GtkLabel *w, const wxString& label)
+{
+    // save the original label
+    wxControlBase::SetLabel(label);
+
+    const wxString labelGTK = GTKConvertMnemonics(label);
+    gtk_label_set_text_with_mnemonic(w, wxGTK_CONV(labelGTK));
+}
+
+void wxControl::GTKSetLabelWithMarkupForLabel(GtkLabel *w, const wxString& label)
+{
+    const wxString labelGTK = GTKConvertMnemonicsWithMarkup(label);
+    gtk_label_set_markup_with_mnemonic(w, wxGTK_CONV(labelGTK));
+}
+
+
+// ----------------------------------------------------------------------------
+// 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)
+{
+    GtkLabel* labelwidget = GTK_LABEL(gtk_frame_get_label_widget(w));
+    GTKSetLabelForLabel(labelwidget, label);
+}
+
+void wxControl::GTKFrameApplyWidgetStyle(GtkFrame* w, GtkRcStyle* style)
+{
+    gtk_widget_modify_style(GTK_WIDGET(w), style);
+    gtk_widget_modify_style(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
+// ----------------------------------------------------------------------------
 
-#ifdef __WXGTK20__
-wxString wxControl::PrepareLabelMnemonics( const wxString &label ) const
+enum MnemonicsFlag
 {
-    //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++)
+    MNEMONICS_REMOVE,
+    MNEMONICS_CONVERT,
+    MNEMONICS_CONVERT_MARKUP
+};
+
+static wxString GTKProcessMnemonics(const wxString& label, MnemonicsFlag flag)
+{
+    wxString labelGTK;
+    labelGTK.reserve(label.length());
+    for ( wxString::const_iterator i = label.begin(); i != label.end(); ++i )
     {
-        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
+        wxChar ch = *i;
+
+        switch ( ch )
         {
-            label2 << label.GetChar(i);
+            case wxT('&'):
+                if ( i + 1 == label.end() )
+                {
+                    // "&" at the end of string is an error
+                    wxLogDebug(wxT("Invalid label \"%s\"."), label);
+                    break;
+                }
+
+                if ( flag == MNEMONICS_CONVERT_MARKUP )
+                {
+                    bool isMnemonic = true;
+                    size_t distanceFromEnd = label.end() - i;
+
+                    // is this ampersand introducing a mnemonic or rather an entity?
+                    for (size_t j=0; j < wxMARKUP_ENTITY_MAX; j++)
+                    {
+                        const wxChar *entity = wxMarkupEntities[wxMARKUP_ELEMENT_NAME][j];
+                        size_t entityLen = wxStrlen(entity);
+
+                        if (distanceFromEnd >= entityLen &&
+                            wxString(i, i + entityLen) == entity)
+                        {
+                            labelGTK << entity;
+                            i += entityLen - 1;     // the -1 is because main for()
+                                                    // loop already increments i
+                            isMnemonic = false;
+
+                            break;
+                        }
+                    }
+
+                    if (!isMnemonic)
+                        continue;
+                }
+
+                ch = *(++i); // skip '&' itself
+                switch ( ch )
+                {
+                    case wxT('&'):
+                        // special case: "&&" is not a mnemonic at all but just
+                        // an escaped "&"
+                        if ( flag == MNEMONICS_CONVERT_MARKUP )
+                            labelGTK += wxT("&amp;");
+                        else
+                            labelGTK += wxT('&');
+                        break;
+
+                    case wxT('_'):
+                        if ( flag != MNEMONICS_REMOVE )
+                        {
+                            // '_' can't be a GTK mnemonic apparently so
+                            // replace it with something similar
+                            labelGTK += wxT("_-");
+                            break;
+                        }
+                        //else: fall through
+
+                    default:
+                        if ( flag != MNEMONICS_REMOVE )
+                            labelGTK += wxT('_');
+                        labelGTK += ch;
+                }
+                break;
+
+            case wxT('_'):
+                if ( flag != MNEMONICS_REMOVE )
+                {
+                    // escape any existing underlines in the string so that
+                    // they don't become mnemonics accidentally
+                    labelGTK += wxT("__");
+                    break;
+                }
+                //else: fall through
+
+            default:
+                labelGTK += ch;
         }
     }
-    return label2;
+
+    return labelGTK;
+}
+
+/* static */
+wxString wxControl::GTKRemoveMnemonics(const wxString& label)
+{
+    return GTKProcessMnemonics(label, MNEMONICS_REMOVE);
+}
+
+/* static */
+wxString wxControl::GTKConvertMnemonics(const wxString& label)
+{
+    return GTKProcessMnemonics(label, MNEMONICS_CONVERT);
+}
+
+/* static */
+wxString wxControl::GTKConvertMnemonicsWithMarkup(const wxString& label)
+{
+    return GTKProcessMnemonics(label, MNEMONICS_CONVERT_MARKUP);
 }
-#endif
 
+// ----------------------------------------------------------------------------
+// wxControl styles (a.k.a. attributes)
+// ----------------------------------------------------------------------------
 
 wxVisualAttributes wxControl::GetDefaultAttributes() const
 {
@@ -149,9 +278,6 @@ wxVisualAttributes wxControl::GetDefaultAttributes() const
                                              UseGTKStyleBase());
 }
 
-
-#define SHIFT (8*(sizeof(short int)-sizeof(char)))
-
 // static
 wxVisualAttributes
 wxControl::GetDefaultAttributesFromGTKWidget(GtkWidget* widget,
@@ -172,36 +298,29 @@ wxControl::GetDefaultAttributesFromGTKWidget(GtkWidget* widget,
 
     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);
+    attr.colFg = wxColour(style->fg[state]);
     if (useBase)
-        attr.colBg = wxColour(style->base[state].red   >> SHIFT,
-                              style->base[state].green >> SHIFT,
-                              style->base[state].blue  >> SHIFT);
+        attr.colBg = wxColour(style->base[state]);
     else
-        attr.colBg = wxColour(style->bg[state].red   >> SHIFT,
-                              style->bg[state].green >> SHIFT,
-                              style->bg[state].blue  >> SHIFT);
+        attr.colBg = wxColour(style->bg[state]);
 
     // get the style's font
-#ifdef __WXGTK20__
     if ( !style->font_desc )
-        style = gtk_widget_get_default_style();  
+        style = gtk_widget_get_default_style();
     if ( style && style->font_desc )
-    {  
-        wxNativeFontInfo info;  
-        info.description = style->font_desc;  
-        attr.font = wxFont(info);  
-    }  
-    else  
-    {  
+    {
+        wxNativeFontInfo info;
+        info.description = pango_font_description_copy(style->font_desc);
+        attr.font = wxFont(info);
+    }
+    else
+    {
         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)
@@ -209,56 +328,79 @@ 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;
 }
 
 
 //static
 wxVisualAttributes
-wxControl::GetDefaultAttributesFromGTKWidget(GtkWidget* (*widget_new)(void),
+wxControl::GetDefaultAttributesFromGTKWidget(wxGtkWidgetNew_t widget_new,
                                              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(widget);
+    gtk_widget_destroy(wnd);
     return attr;
 }
 
 //static
 wxVisualAttributes
-wxControl::GetDefaultAttributesFromGTKWidget(GtkWidget* (*widget_new)(const gchar*),
+wxControl::GetDefaultAttributesFromGTKWidget(wxGtkWidgetNewFromStr_t widget_new,
                                              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(widget);
+    gtk_widget_destroy(wnd);
     return attr;
 }
 
 
 //static
 wxVisualAttributes
-wxControl::GetDefaultAttributesFromGTKWidget(GtkWidget* (*widget_new)(GtkAdjustment*),
+wxControl::GetDefaultAttributesFromGTKWidget(wxGtkWidgetNewFromAdj_t widget_new,
                                              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(NULL);
+    gtk_container_add(GTK_CONTAINER(wnd), widget);
     attr = GetDefaultAttributesFromGTKWidget(widget, useBase, state);
-    gtk_widget_destroy(widget);
+    gtk_widget_destroy(wnd);
     return attr;
 }
 
+// ----------------------------------------------------------------------------
+// idle handling
+// ----------------------------------------------------------------------------
 
-#endif // wxUSE_CONTROLS
+void wxControl::OnInternalIdle()
+{
+    if ( GtkShowFromOnIdle() )
+        return;
+
+    if ( GTK_WIDGET_REALIZED(m_widget) )
+    {
+        GTKUpdateCursor();
 
+        GTKSetDelayedFocusIfNeeded();
+    }
+
+    if ( wxUpdateUIEvent::CanUpdate(this) )
+        UpdateWindowUI(wxUPDATE_UI_FROMIDLE);
+}
+
+#endif // wxUSE_CONTROLS