Add doc for wxGraphicsContext.Create(), which is a lightweight context with no target...

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

diff --git a/src/gtk/artgtk.cpp b/src/gtk/artgtk.cpp
index a888e389bf1154b7f75ed8e2679f00c23d8c9757..b29c33dda5b1da86a8e5e2212e8cab09fcf25ccc 100644 (file)
--- a/src/gtk/artgtk.cpp
+++ b/src/gtk/artgtk.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        src/gtk/artstd.cpp
+// Name:        src/gtk/artgtk.cpp

 // Purpose:     stock wxArtProvider instance with native GTK+ stock icons
 // Author:      Vaclav Slavik
 // Modified by:
 // Purpose:     stock wxArtProvider instance with native GTK+ stock icons
 // Author:      Vaclav Slavik
 // Modified by:


@@ -20,20 +20,10 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

-#if !defined(__WXUNIVERSAL__)
-

 #include "wx/artprov.h"
 
 #include "wx/artprov.h"
 

-#ifndef WX_PRECOMP
-    #include "wx/module.h"
-#endif
-
-#include <gtk/gtkversion.h>
-#if GTK_CHECK_VERSION(2, 9, 0)
-    // gtk_object_sink
-    #undef GTK_DISABLE_DEPRECATED
-#endif

 #include <gtk/gtk.h>
 #include <gtk/gtk.h>

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

 
 // compatibility with older GTK+ versions:
 #ifndef GTK_STOCK_FILE
 
 // compatibility with older GTK+ versions:
 #ifndef GTK_STOCK_FILE


@@ -53,18 +43,23 @@ class wxGTK2ArtProvider : public wxArtProvider
 protected:
     virtual wxBitmap CreateBitmap(const wxArtID& id, const wxArtClient& client,
                                   const wxSize& size);
 protected:
     virtual wxBitmap CreateBitmap(const wxArtID& id, const wxArtClient& client,
                                   const wxSize& size);

+    virtual wxIconBundle CreateIconBundle(const wxArtID& id,
+                                          const wxArtClient& client);

 };
 
 /*static*/ void wxArtProvider::InitNativeProvider()
 {
 };
 
 /*static*/ void wxArtProvider::InitNativeProvider()
 {

-    Push(new wxGTK2ArtProvider);
+    PushBack(new wxGTK2ArtProvider);

 }
 
 // ----------------------------------------------------------------------------
 // CreateBitmap routine
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // CreateBitmap routine
 // ----------------------------------------------------------------------------
 

-static const char *wxArtIDToStock(const wxArtID& id)
+namespace
+{
+
+wxString wxArtIDToStock(const wxArtID& id)

 {
     #define ART(wxid, gtkid) \
            if (id == wxid) return gtkid;
 {
     #define ART(wxid, gtkid) \
            if (id == wxid) return gtkid;


@@ -88,6 +83,8 @@ static const char *wxArtIDToStock(const wxArtID& id)
     ART(wxART_GO_DOWN,                             GTK_STOCK_GO_DOWN)
     ART(wxART_GO_TO_PARENT,                        GTK_STOCK_GO_UP)
     ART(wxART_GO_HOME,                             GTK_STOCK_HOME)
     ART(wxART_GO_DOWN,                             GTK_STOCK_GO_DOWN)
     ART(wxART_GO_TO_PARENT,                        GTK_STOCK_GO_UP)
     ART(wxART_GO_HOME,                             GTK_STOCK_HOME)

+    ART(wxART_GOTO_FIRST,                          GTK_STOCK_GOTO_FIRST)
+    ART(wxART_GOTO_LAST,                           GTK_STOCK_GOTO_LAST)

     ART(wxART_FILE_OPEN,                           GTK_STOCK_OPEN)
     ART(wxART_PRINT,                               GTK_STOCK_PRINT)
     ART(wxART_HELP,                                GTK_STOCK_HELP)
     ART(wxART_FILE_OPEN,                           GTK_STOCK_OPEN)
     ART(wxART_PRINT,                               GTK_STOCK_PRINT)
     ART(wxART_HELP,                                GTK_STOCK_HELP)


@@ -120,21 +117,28 @@ static const char *wxArtIDToStock(const wxArtID& id)
     ART(wxART_UNDO,                                GTK_STOCK_UNDO)
     ART(wxART_REDO,                                GTK_STOCK_REDO)
 
     ART(wxART_UNDO,                                GTK_STOCK_UNDO)
     ART(wxART_REDO,                                GTK_STOCK_REDO)
 

+    ART(wxART_PLUS,                                GTK_STOCK_ADD)
+    ART(wxART_MINUS,                               GTK_STOCK_REMOVE)
+
+    ART(wxART_CLOSE,                               GTK_STOCK_CLOSE)

     ART(wxART_QUIT,                                GTK_STOCK_QUIT)
 
     ART(wxART_FIND,                                GTK_STOCK_FIND)
     ART(wxART_FIND_AND_REPLACE,                    GTK_STOCK_FIND_AND_REPLACE)
 
     ART(wxART_QUIT,                                GTK_STOCK_QUIT)
 
     ART(wxART_FIND,                                GTK_STOCK_FIND)
     ART(wxART_FIND_AND_REPLACE,                    GTK_STOCK_FIND_AND_REPLACE)
 

-    return NULL;
-

     #undef ART
     #undef ART

+
+    // allow passing GTK+ stock IDs to wxArtProvider -- if a recognized wx
+    // ID wasn't found, pass it to GTK+ in the hope it is a GTK+ or theme
+    // icon name:
+    return id;

 }
 
 }
 

-GtkIconSize wxArtClientToIconSize(const wxArtClient& client)
+GtkIconSize ArtClientToIconSize(const wxArtClient& client)

 {
     if (client == wxART_TOOLBAR)
         return GTK_ICON_SIZE_LARGE_TOOLBAR;
 {
     if (client == wxART_TOOLBAR)
         return GTK_ICON_SIZE_LARGE_TOOLBAR;

-    else if (client == wxART_MENU)
+    else if (client == wxART_MENU || client == wxART_FRAME_ICON)

         return GTK_ICON_SIZE_MENU;
     else if (client == wxART_CMN_DIALOG || client == wxART_MESSAGE_BOX)
         return GTK_ICON_SIZE_DIALOG;
         return GTK_ICON_SIZE_MENU;
     else if (client == wxART_CMN_DIALOG || client == wxART_MESSAGE_BOX)
         return GTK_ICON_SIZE_DIALOG;


@@ -144,7 +148,7 @@ GtkIconSize wxArtClientToIconSize(const wxArtClient& client)
         return GTK_ICON_SIZE_INVALID; // this is arbitrary
 }
 
         return GTK_ICON_SIZE_INVALID; // this is arbitrary
 }
 

-static GtkIconSize FindClosestIconSize(const wxSize& size)
+GtkIconSize FindClosestIconSize(const wxSize& size)

 {
     #define NUM_SIZES 6
     static struct
 {
     #define NUM_SIZES 6
     static struct


@@ -191,10 +195,7 @@ static GtkIconSize FindClosestIconSize(const wxSize& size)
     return best;
 }
 
     return best;
 }
 

-
-static GtkStyle *gs_gtkStyle = NULL;
-
-static GdkPixbuf *CreateStockIcon(const char *stockid, GtkIconSize size)
+GdkPixbuf *CreateStockIcon(const char *stockid, GtkIconSize size)

 {
     // FIXME: This code is not 100% correct, because stock pixmap are
     //        context-dependent and may be affected by theme engine, the
 {
     // FIXME: This code is not 100% correct, because stock pixmap are
     //        context-dependent and may be affected by theme engine, the


@@ -204,64 +205,95 @@ static GdkPixbuf *CreateStockIcon(const char *stockid, GtkIconSize size)
     //        with "stock-id" representation (in addition to pixmap and pixbuf
     //        ones) and would convert it to pixbuf when rendered.
 
     //        with "stock-id" representation (in addition to pixmap and pixbuf
     //        ones) and would convert it to pixbuf when rendered.
 

-    if (gs_gtkStyle == NULL)
-    {
-        GtkWidget *widget = gtk_button_new();
-        gs_gtkStyle = gtk_rc_get_style(widget);
-        wxASSERT( gs_gtkStyle != NULL );
-        g_object_ref(gs_gtkStyle);
-        gtk_object_sink((GtkObject*)widget);
-    }
-
-    GtkIconSet *iconset = gtk_style_lookup_icon_set(gs_gtkStyle, stockid);
+    GtkWidget* widget = wxGTKPrivate::GetButtonWidget();
+#ifdef __WXGTK3__
+    GtkStyleContext* sc = gtk_widget_get_style_context(widget);
+    GtkIconSet* iconset = gtk_style_context_lookup_icon_set(sc, stockid);
+    GdkPixbuf* pixbuf = NULL;
+    if (iconset)
+        pixbuf = gtk_icon_set_render_icon_pixbuf(iconset, sc, size);
+    return pixbuf;
+#else
+    GtkStyle* style = gtk_widget_get_style(widget);
+    GtkIconSet* iconset = gtk_style_lookup_icon_set(style, stockid);

 
     if (!iconset)
         return NULL;
 
 
     if (!iconset)
         return NULL;
 

-    return gtk_icon_set_render_icon(iconset, gs_gtkStyle,
+    return gtk_icon_set_render_icon(iconset, style,

                                     gtk_widget_get_default_direction(),
                                     GTK_STATE_NORMAL, size, NULL, NULL);
                                     gtk_widget_get_default_direction(),
                                     GTK_STATE_NORMAL, size, NULL, NULL);

+#endif
+}
+
+GdkPixbuf *CreateThemeIcon(const char *iconname, int size)
+{
+    return gtk_icon_theme_load_icon
+           (
+               gtk_icon_theme_get_default(),
+               iconname,
+               size,
+               (GtkIconLookupFlags)0,
+               NULL
+           );

 }
 
 }
 

-static GdkPixbuf *CreateThemeIcon(const char *iconname,
-                                  GtkIconSize iconsize, const wxSize& sz)
+
+// creates either stock or theme icon
+GdkPixbuf *CreateGtkIcon(const char *icon_name,
+                         GtkIconSize stock_size, const wxSize& pixel_size)
+{
+    // try stock GTK+ icon first
+    GdkPixbuf *pixbuf = CreateStockIcon(icon_name, stock_size);
+    if ( pixbuf )
+        return pixbuf;
+
+    // if that fails, try theme icon
+    wxSize size(pixel_size);
+    if ( pixel_size == wxDefaultSize )
+        gtk_icon_size_lookup(stock_size, &size.x, &size.y);
+    return CreateThemeIcon(icon_name, size.x);
+}
+
+template<typename SizeType, typename LoaderFunc>
+wxIconBundle DoCreateIconBundle(const char *stockid,
+                                const SizeType *sizes_from,
+                                const SizeType *sizes_to,
+                                LoaderFunc get_icon)
+

 {
 {

-    wxSize size(sz);
-    if (size == wxDefaultSize)
+    wxIconBundle bundle;
+
+    for ( const SizeType *i = sizes_from; i != sizes_to; ++i )

     {
     {

-        gtk_icon_size_lookup(iconsize, &size.x, &size.y);
+        GdkPixbuf *pixbuf = get_icon(stockid, *i);
+        if ( !pixbuf )
+            continue;
+
+        wxIcon icon;
+        icon.CopyFromBitmap(wxBitmap(pixbuf));
+        bundle.AddIcon(icon);

     }
 
     }
 

-    return gtk_icon_theme_load_icon(
-                    gtk_icon_theme_get_default(),
-                    iconname,
-                    size.x,
-                    (GtkIconLookupFlags)0, NULL);
+    return bundle;

 }
 
 }
 

+} // anonymous namespace
+

 wxBitmap wxGTK2ArtProvider::CreateBitmap(const wxArtID& id,
                                          const wxArtClient& client,
                                          const wxSize& size)
 {
 wxBitmap wxGTK2ArtProvider::CreateBitmap(const wxArtID& id,
                                          const wxArtClient& client,
                                          const wxSize& size)
 {

-    wxCharBuffer stockid = wxArtIDToStock(id);
+    const wxString stockid = wxArtIDToStock(id);
+

     GtkIconSize stocksize = (size == wxDefaultSize) ?
     GtkIconSize stocksize = (size == wxDefaultSize) ?

-                                wxArtClientToIconSize(client) :
+                                ArtClientToIconSize(client) :

                                 FindClosestIconSize(size);
                                 FindClosestIconSize(size);

-

     // we must have some size, this is arbitrary
     if (stocksize == GTK_ICON_SIZE_INVALID)
         stocksize = GTK_ICON_SIZE_BUTTON;
 
     // we must have some size, this is arbitrary
     if (stocksize == GTK_ICON_SIZE_INVALID)
         stocksize = GTK_ICON_SIZE_BUTTON;
 

-    // allow passing GTK+ stock IDs to wxArtProvider:
-    if (!stockid)
-        stockid = id.ToAscii();
-
-    GdkPixbuf *pixbuf = CreateStockIcon(stockid, stocksize);
-
-    if (!pixbuf && !gtk_check_version(2,4,0))
-    {
-        pixbuf = CreateThemeIcon(stockid, stocksize, size);
-    }
+    GdkPixbuf *pixbuf = CreateGtkIcon(stockid.utf8_str(), stocksize, size);

 
     if (pixbuf && size != wxDefaultSize &&
         (size.x != gdk_pixbuf_get_width(pixbuf) ||
 
     if (pixbuf && size != wxDefaultSize &&
         (size.x != gdk_pixbuf_get_width(pixbuf) ||


@@ -276,33 +308,77 @@ wxBitmap wxGTK2ArtProvider::CreateBitmap(const wxArtID& id,
         }
     }
 
         }
     }
 

-    wxBitmap bmp;
-    if (pixbuf != NULL)
-        bmp.SetPixbuf(pixbuf);
-
-    return bmp;
+    return wxBitmap(pixbuf);

 }
 
 }
 

-// ----------------------------------------------------------------------------
-// Cleanup
-// ----------------------------------------------------------------------------
-
-class wxArtGtkModule: public wxModule
+wxIconBundle
+wxGTK2ArtProvider::CreateIconBundle(const wxArtID& id,
+                                    const wxArtClient& WXUNUSED(client))

 {
 {

-public:
-    bool OnInit() { return true; }
-    void OnExit()
+    wxIconBundle bundle;
+    const wxString stockid = wxArtIDToStock(id);
+
+    // try to load the bundle as stock icon first
+    GtkWidget* widget = wxGTKPrivate::GetButtonWidget();
+#ifdef __WXGTK3__
+    GtkStyleContext* sc = gtk_widget_get_style_context(widget);
+    GtkIconSet* iconset = gtk_style_context_lookup_icon_set(sc, stockid.utf8_str());
+#else
+    GtkStyle* style = gtk_widget_get_style(widget);
+    GtkIconSet* iconset = gtk_style_lookup_icon_set(style, stockid.utf8_str());
+#endif
+    if ( iconset )

     {
     {

-        if (gs_gtkStyle)
-        {
-            g_object_unref(gs_gtkStyle);
-            gs_gtkStyle = NULL;
-        }
+        GtkIconSize *sizes;
+        gint n_sizes;
+        gtk_icon_set_get_sizes(iconset, &sizes, &n_sizes);
+        bundle = DoCreateIconBundle
+                              (
+                                  stockid.utf8_str(),
+                                  sizes, sizes + n_sizes,
+                                  &CreateStockIcon
+                              );
+        g_free(sizes);
+        return bundle;

     }
 
     }
 

-    DECLARE_DYNAMIC_CLASS(wxArtGtkModule)
-};
+    // otherwise try icon themes
+    gint *sizes = gtk_icon_theme_get_icon_sizes
+                  (
+                      gtk_icon_theme_get_default(),
+                      stockid.utf8_str()
+                  );
+    if ( !sizes )
+        return bundle;
+
+    gint *last = sizes;
+    while ( *last )
+        last++;
+
+    bundle = DoCreateIconBundle
+                          (
+                              stockid.utf8_str(),
+                              sizes, last,
+                              &CreateThemeIcon
+                          );
+    g_free(sizes);
+
+    return bundle;
+}

 
 

-IMPLEMENT_DYNAMIC_CLASS(wxArtGtkModule, wxModule)
+// ----------------------------------------------------------------------------
+// wxArtProvider::GetNativeSizeHint()
+// ----------------------------------------------------------------------------

 
 

-#endif // !defined(__WXUNIVERSAL__)
+/*static*/
+wxSize wxArtProvider::GetNativeSizeHint(const wxArtClient& client)
+{
+    // Gtk has specific sizes for each client, see artgtk.cpp
+    GtkIconSize gtk_size = ArtClientToIconSize(client);
+    // no size hints for this client
+    if (gtk_size == GTK_ICON_SIZE_INVALID)
+        return wxDefaultSize;
+    gint width, height;
+    gtk_icon_size_lookup( gtk_size, &width, &height);
+    return wxSize(width, height);
+}