src/gtk/artgtk.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/artgtk.cpp
   3 // Purpose:     stock wxArtProvider instance with native GTK+ stock icons
   4 // Author:      Vaclav Slavik
   5 // Modified by:
   6 // Created:     2004-08-22
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Vaclav Slavik, 2004
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ---------------------------------------------------------------------------
  13 // headers
  14 // ---------------------------------------------------------------------------
  15
  16 // For compilers that support precompilation, includes "wx.h".
  17 #include "wx/wxprec.h"
  18
  19 #if defined(__BORLANDC__)
  20     #pragma hdrstop
  21 #endif
  22
  23 #include "wx/artprov.h"
  24
  25 #include <gtk/gtk.h>
  26 #include "wx/gtk/private.h"
  27
  28 // compatibility with older GTK+ versions:
  29 #ifndef GTK_STOCK_FILE
  30     #define GTK_STOCK_FILE "gtk-file"
  31 #endif
  32 #ifndef GTK_STOCK_DIRECTORY
  33     #define GTK_STOCK_DIRECTORY "gtk-directory"
  34 #endif
  35
  36
  37 // ----------------------------------------------------------------------------
  38 // wxGTK2ArtProvider
  39 // ----------------------------------------------------------------------------
  40
  41 class wxGTK2ArtProvider : public wxArtProvider
  42 {
  43 protected:
  44     virtual wxBitmap CreateBitmap(const wxArtID& id, const wxArtClient& client,
  45                                   const wxSize& size);
  46     virtual wxIconBundle CreateIconBundle(const wxArtID& id,
  47                                           const wxArtClient& client);
  48 };
  49
  50 /*static*/ void wxArtProvider::InitNativeProvider()
  51 {
  52     PushBack(new wxGTK2ArtProvider);
  53 }
  54
  55 // ----------------------------------------------------------------------------
  56 // CreateBitmap routine
  57 // ----------------------------------------------------------------------------
  58
  59 namespace
  60 {
  61
  62 wxString wxArtIDToStock(const wxArtID& id)
  63 {
  64     #define ART(wxid, gtkid) \
  65            if (id == wxid) return gtkid;
  66
  67     ART(wxART_ERROR,                               GTK_STOCK_DIALOG_ERROR)
  68     ART(wxART_INFORMATION,                         GTK_STOCK_DIALOG_INFO)
  69     ART(wxART_WARNING,                             GTK_STOCK_DIALOG_WARNING)
  70     ART(wxART_QUESTION,                            GTK_STOCK_DIALOG_QUESTION)
  71
  72     //ART(wxART_HELP_SIDE_PANEL,                     )
  73     ART(wxART_HELP_SETTINGS,                       GTK_STOCK_SELECT_FONT)
  74     //ART(wxART_HELP_BOOK,                           )
  75     ART(wxART_HELP_FOLDER,                         GTK_STOCK_DIRECTORY)
  76     ART(wxART_HELP_PAGE,                           GTK_STOCK_FILE)
  77     ART(wxART_MISSING_IMAGE,                       GTK_STOCK_MISSING_IMAGE)
  78     ART(wxART_ADD_BOOKMARK,                        GTK_STOCK_ADD)
  79     ART(wxART_DEL_BOOKMARK,                        GTK_STOCK_REMOVE)
  80     ART(wxART_GO_BACK,                             GTK_STOCK_GO_BACK)
  81     ART(wxART_GO_FORWARD,                          GTK_STOCK_GO_FORWARD)
  82     ART(wxART_GO_UP,                               GTK_STOCK_GO_UP)
  83     ART(wxART_GO_DOWN,                             GTK_STOCK_GO_DOWN)
  84     ART(wxART_GO_TO_PARENT,                        GTK_STOCK_GO_UP)
  85     ART(wxART_GO_HOME,                             GTK_STOCK_HOME)
  86     ART(wxART_GOTO_FIRST,                          GTK_STOCK_GOTO_FIRST)
  87     ART(wxART_GOTO_LAST,                           GTK_STOCK_GOTO_LAST)
  88     ART(wxART_FILE_OPEN,                           GTK_STOCK_OPEN)
  89     ART(wxART_PRINT,                               GTK_STOCK_PRINT)
  90     ART(wxART_HELP,                                GTK_STOCK_HELP)
  91     ART(wxART_TIP,                                 GTK_STOCK_DIALOG_INFO)
  92     //ART(wxART_REPORT_VIEW,                         )
  93     //ART(wxART_LIST_VIEW,                           )
  94     //ART(wxART_NEW_DIR,                             )
  95     ART(wxART_FOLDER,                              GTK_STOCK_DIRECTORY)
  96     ART(wxART_FOLDER_OPEN,                         GTK_STOCK_DIRECTORY)
  97     //ART(wxART_GO_DIR_UP,                           )
  98     ART(wxART_EXECUTABLE_FILE,                     GTK_STOCK_EXECUTE)
  99     ART(wxART_NORMAL_FILE,                         GTK_STOCK_FILE)
 100     ART(wxART_TICK_MARK,                           GTK_STOCK_APPLY)
 101     ART(wxART_CROSS_MARK,                          GTK_STOCK_CANCEL)
 102
 103     ART(wxART_FLOPPY,                              GTK_STOCK_FLOPPY)
 104     ART(wxART_CDROM,                               GTK_STOCK_CDROM)
 105     ART(wxART_HARDDISK,                            GTK_STOCK_HARDDISK)
 106     ART(wxART_REMOVABLE,                           GTK_STOCK_HARDDISK)
 107
 108     ART(wxART_FILE_SAVE,                           GTK_STOCK_SAVE)
 109     ART(wxART_FILE_SAVE_AS,                        GTK_STOCK_SAVE_AS)
 110
 111     ART(wxART_COPY,                                GTK_STOCK_COPY)
 112     ART(wxART_CUT,                                 GTK_STOCK_CUT)
 113     ART(wxART_PASTE,                               GTK_STOCK_PASTE)
 114     ART(wxART_DELETE,                              GTK_STOCK_DELETE)
 115     ART(wxART_NEW,                                 GTK_STOCK_NEW)
 116
 117     ART(wxART_UNDO,                                GTK_STOCK_UNDO)
 118     ART(wxART_REDO,                                GTK_STOCK_REDO)
 119
 120     ART(wxART_PLUS,                                GTK_STOCK_ADD)
 121     ART(wxART_MINUS,                               GTK_STOCK_REMOVE)
 122
 123     ART(wxART_CLOSE,                               GTK_STOCK_CLOSE)
 124     ART(wxART_QUIT,                                GTK_STOCK_QUIT)
 125
 126     ART(wxART_FIND,                                GTK_STOCK_FIND)
 127     ART(wxART_FIND_AND_REPLACE,                    GTK_STOCK_FIND_AND_REPLACE)
 128
 129     #undef ART
 130
 131     // allow passing GTK+ stock IDs to wxArtProvider -- if a recognized wx
 132     // ID wasn't found, pass it to GTK+ in the hope it is a GTK+ or theme
 133     // icon name:
 134     return id;
 135 }
 136
 137 GtkIconSize ArtClientToIconSize(const wxArtClient& client)
 138 {
 139     if (client == wxART_TOOLBAR)
 140         return GTK_ICON_SIZE_LARGE_TOOLBAR;
 141     else if (client == wxART_MENU || client == wxART_FRAME_ICON)
 142         return GTK_ICON_SIZE_MENU;
 143     else if (client == wxART_CMN_DIALOG || client == wxART_MESSAGE_BOX)
 144         return GTK_ICON_SIZE_DIALOG;
 145     else if (client == wxART_BUTTON)
 146         return GTK_ICON_SIZE_BUTTON;
 147     else
 148         return GTK_ICON_SIZE_INVALID; // this is arbitrary
 149 }
 150
 151 GtkIconSize FindClosestIconSize(const wxSize& size)
 152 {
 153     #define NUM_SIZES 6
 154     static struct
 155     {
 156         GtkIconSize icon;
 157         gint x, y;
 158     } s_sizes[NUM_SIZES];
 159     static bool s_sizesInitialized = false;
 160
 161     if (!s_sizesInitialized)
 162     {
 163         s_sizes[0].icon = GTK_ICON_SIZE_MENU;
 164         s_sizes[1].icon = GTK_ICON_SIZE_SMALL_TOOLBAR;
 165         s_sizes[2].icon = GTK_ICON_SIZE_LARGE_TOOLBAR;
 166         s_sizes[3].icon = GTK_ICON_SIZE_BUTTON;
 167         s_sizes[4].icon = GTK_ICON_SIZE_DND;
 168         s_sizes[5].icon = GTK_ICON_SIZE_DIALOG;
 169         for (size_t i = 0; i < NUM_SIZES; i++)
 170         {
 171             gtk_icon_size_lookup(s_sizes[i].icon,
 172                                  &s_sizes[i].x, &s_sizes[i].y);
 173         }
 174         s_sizesInitialized = true;
 175     }
 176
 177     GtkIconSize best = GTK_ICON_SIZE_DIALOG; // presumably largest
 178     unsigned distance = INT_MAX;
 179     for (size_t i = 0; i < NUM_SIZES; i++)
 180     {
 181         // only use larger bitmaps, scaling down looks better than scaling up:
 182         if (size.x > s_sizes[i].x || size.y > s_sizes[i].y)
 183             continue;
 184
 185         unsigned dist = (size.x - s_sizes[i].x) * (size.x - s_sizes[i].x) +
 186                         (size.y - s_sizes[i].y) * (size.y - s_sizes[i].y);
 187         if (dist == 0)
 188             return s_sizes[i].icon;
 189         else if (dist < distance)
 190         {
 191             distance = dist;
 192             best = s_sizes[i].icon;
 193         }
 194     }
 195     return best;
 196 }
 197
 198 GdkPixbuf *CreateStockIcon(const char *stockid, GtkIconSize size)
 199 {
 200     // FIXME: This code is not 100% correct, because stock pixmap are
 201     //        context-dependent and may be affected by theme engine, the
 202     //        correct value can only be obtained for given GtkWidget object.
 203     //
 204     //        Fool-proof implementation of stock bitmaps would extend wxBitmap
 205     //        with "stock-id" representation (in addition to pixmap and pixbuf
 206     //        ones) and would convert it to pixbuf when rendered.
 207
 208     GtkWidget* widget = wxGTKPrivate::GetButtonWidget();
 209 #ifdef __WXGTK3__
 210     GtkStyleContext* sc = gtk_widget_get_style_context(widget);
 211     GtkIconSet* iconset = gtk_style_context_lookup_icon_set(sc, stockid);
 212     GdkPixbuf* pixbuf = NULL;
 213     if (iconset)
 214         pixbuf = gtk_icon_set_render_icon_pixbuf(iconset, sc, size);
 215     return pixbuf;
 216 #else
 217     GtkStyle* style = gtk_widget_get_style(widget);
 218     GtkIconSet* iconset = gtk_style_lookup_icon_set(style, stockid);
 219
 220     if (!iconset)
 221         return NULL;
 222
 223     return gtk_icon_set_render_icon(iconset, style,
 224                                     gtk_widget_get_default_direction(),
 225                                     GTK_STATE_NORMAL, size, NULL, NULL);
 226 #endif
 227 }
 228
 229 GdkPixbuf *CreateThemeIcon(const char *iconname, int size)
 230 {
 231     return gtk_icon_theme_load_icon
 232            (
 233                gtk_icon_theme_get_default(),
 234                iconname,
 235                size,
 236                (GtkIconLookupFlags)0,
 237                NULL
 238            );
 239 }
 240
 241
 242 // creates either stock or theme icon
 243 GdkPixbuf *CreateGtkIcon(const char *icon_name,
 244                          GtkIconSize stock_size, const wxSize& pixel_size)
 245 {
 246     // try stock GTK+ icon first
 247     GdkPixbuf *pixbuf = CreateStockIcon(icon_name, stock_size);
 248     if ( pixbuf )
 249         return pixbuf;
 250
 251     // if that fails, try theme icon
 252     wxSize size(pixel_size);
 253     if ( pixel_size == wxDefaultSize )
 254         gtk_icon_size_lookup(stock_size, &size.x, &size.y);
 255     return CreateThemeIcon(icon_name, size.x);
 256 }
 257
 258 template<typename SizeType, typename LoaderFunc>
 259 wxIconBundle DoCreateIconBundle(const char *stockid,
 260                                 const SizeType *sizes_from,
 261                                 const SizeType *sizes_to,
 262                                 LoaderFunc get_icon)
 263
 264 {
 265     wxIconBundle bundle;
 266
 267     for ( const SizeType *i = sizes_from; i != sizes_to; ++i )
 268     {
 269         GdkPixbuf *pixbuf = get_icon(stockid, *i);
 270         if ( !pixbuf )
 271             continue;
 272
 273         wxIcon icon;
 274         icon.CopyFromBitmap(wxBitmap(pixbuf));
 275         bundle.AddIcon(icon);
 276     }
 277
 278     return bundle;
 279 }
 280
 281 } // anonymous namespace
 282
 283 wxBitmap wxGTK2ArtProvider::CreateBitmap(const wxArtID& id,
 284                                          const wxArtClient& client,
 285                                          const wxSize& size)
 286 {
 287     const wxString stockid = wxArtIDToStock(id);
 288
 289     GtkIconSize stocksize = (size == wxDefaultSize) ?
 290                                 ArtClientToIconSize(client) :
 291                                 FindClosestIconSize(size);
 292     // we must have some size, this is arbitrary
 293     if (stocksize == GTK_ICON_SIZE_INVALID)
 294         stocksize = GTK_ICON_SIZE_BUTTON;
 295
 296     GdkPixbuf *pixbuf = CreateGtkIcon(stockid.utf8_str(), stocksize, size);
 297
 298     if (pixbuf && size != wxDefaultSize &&
 299         (size.x != gdk_pixbuf_get_width(pixbuf) ||
 300          size.y != gdk_pixbuf_get_height(pixbuf)))
 301     {
 302         GdkPixbuf *p2 = gdk_pixbuf_scale_simple(pixbuf, size.x, size.y,
 303                                                 GDK_INTERP_BILINEAR);
 304         if (p2)
 305         {
 306             g_object_unref (pixbuf);
 307             pixbuf = p2;
 308         }
 309     }
 310
 311     return wxBitmap(pixbuf);
 312 }
 313
 314 wxIconBundle
 315 wxGTK2ArtProvider::CreateIconBundle(const wxArtID& id,
 316                                     const wxArtClient& WXUNUSED(client))
 317 {
 318     wxIconBundle bundle;
 319     const wxString stockid = wxArtIDToStock(id);
 320
 321     // try to load the bundle as stock icon first
 322     GtkWidget* widget = wxGTKPrivate::GetButtonWidget();
 323 #ifdef __WXGTK3__
 324     GtkStyleContext* sc = gtk_widget_get_style_context(widget);
 325     GtkIconSet* iconset = gtk_style_context_lookup_icon_set(sc, stockid.utf8_str());
 326 #else
 327     GtkStyle* style = gtk_widget_get_style(widget);
 328     GtkIconSet* iconset = gtk_style_lookup_icon_set(style, stockid.utf8_str());
 329 #endif
 330     if ( iconset )
 331     {
 332         GtkIconSize *sizes;
 333         gint n_sizes;
 334         gtk_icon_set_get_sizes(iconset, &sizes, &n_sizes);
 335         bundle = DoCreateIconBundle
 336                               (
 337                                   stockid.utf8_str(),
 338                                   sizes, sizes + n_sizes,
 339                                   &CreateStockIcon
 340                               );
 341         g_free(sizes);
 342         return bundle;
 343     }
 344
 345     // otherwise try icon themes
 346     gint *sizes = gtk_icon_theme_get_icon_sizes
 347                   (
 348                       gtk_icon_theme_get_default(),
 349                       stockid.utf8_str()
 350                   );
 351     if ( !sizes )
 352         return bundle;
 353
 354     gint *last = sizes;
 355     while ( *last )
 356         last++;
 357
 358     bundle = DoCreateIconBundle
 359                           (
 360                               stockid.utf8_str(),
 361                               sizes, last,
 362                               &CreateThemeIcon
 363                           );
 364     g_free(sizes);
 365
 366     return bundle;
 367 }
 368
 369 // ----------------------------------------------------------------------------
 370 // wxArtProvider::GetNativeSizeHint()
 371 // ----------------------------------------------------------------------------
 372
 373 /*static*/
 374 wxSize wxArtProvider::GetNativeSizeHint(const wxArtClient& client)
 375 {
 376     // Gtk has specific sizes for each client, see artgtk.cpp
 377     GtkIconSize gtk_size = ArtClientToIconSize(client);
 378     // no size hints for this client
 379     if (gtk_size == GTK_ICON_SIZE_INVALID)
 380         return wxDefaultSize;
 381     gint width, height;
 382     gtk_icon_size_lookup( gtk_size, &width, &height);
 383     return wxSize(width, height);
 384 }