src/gtk/artgtk.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/artstd.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 #if !defined(__WXUNIVERSAL__)
  24
  25 #include "wx/artprov.h"
  26 #include "wx/gtk/private.h"
  27
  28 #ifndef WX_PRECOMP
  29     #include "wx/module.h"
  30 #endif
  31
  32
  33 #include <gtk/gtk.h>
  34
  35 // compatibility with older GTK+ versions:
  36 #ifndef GTK_STOCK_FILE
  37     #define GTK_STOCK_FILE "gtk-file"
  38 #endif
  39 #ifndef GTK_STOCK_DIRECTORY
  40     #define GTK_STOCK_DIRECTORY "gtk-directory"
  41 #endif
  42
  43
  44 // ----------------------------------------------------------------------------
  45 // wxGTK2ArtProvider
  46 // ----------------------------------------------------------------------------
  47
  48 class wxGTK2ArtProvider : public wxArtProvider
  49 {
  50 protected:
  51     virtual wxBitmap CreateBitmap(const wxArtID& id, const wxArtClient& client,
  52                                   const wxSize& size);
  53 };
  54
  55 /*static*/ void wxArtProvider::InitNativeProvider()
  56 {
  57     Push(new wxGTK2ArtProvider);
  58 }
  59
  60 // ----------------------------------------------------------------------------
  61 // CreateBitmap routine
  62 // ----------------------------------------------------------------------------
  63
  64 static const char *wxArtIDToStock(const wxArtID& id)
  65 {
  66     #define ART(wxid, gtkid) \
  67            if (id == wxid) return gtkid;
  68
  69     ART(wxART_ERROR,                               GTK_STOCK_DIALOG_ERROR)
  70     ART(wxART_INFORMATION,                         GTK_STOCK_DIALOG_INFO)
  71     ART(wxART_WARNING,                             GTK_STOCK_DIALOG_WARNING)
  72     ART(wxART_QUESTION,                            GTK_STOCK_DIALOG_QUESTION)
  73
  74     //ART(wxART_HELP_SIDE_PANEL,                     )
  75     ART(wxART_HELP_SETTINGS,                       GTK_STOCK_SELECT_FONT)
  76     //ART(wxART_HELP_BOOK,                           )
  77     ART(wxART_HELP_FOLDER,                         GTK_STOCK_DIRECTORY)
  78     ART(wxART_HELP_PAGE,                           GTK_STOCK_FILE)
  79     ART(wxART_MISSING_IMAGE,                       GTK_STOCK_MISSING_IMAGE)
  80     ART(wxART_ADD_BOOKMARK,                        GTK_STOCK_ADD)
  81     ART(wxART_DEL_BOOKMARK,                        GTK_STOCK_REMOVE)
  82     ART(wxART_GO_BACK,                             GTK_STOCK_GO_BACK)
  83     ART(wxART_GO_FORWARD,                          GTK_STOCK_GO_FORWARD)
  84     ART(wxART_GO_UP,                               GTK_STOCK_GO_UP)
  85     ART(wxART_GO_DOWN,                             GTK_STOCK_GO_DOWN)
  86     ART(wxART_GO_TO_PARENT,                        GTK_STOCK_GO_UP)
  87     ART(wxART_GO_HOME,                             GTK_STOCK_HOME)
  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_QUIT,                                GTK_STOCK_QUIT)
 121
 122     ART(wxART_FIND,                                GTK_STOCK_FIND)
 123     ART(wxART_FIND_AND_REPLACE,                    GTK_STOCK_FIND_AND_REPLACE)
 124
 125     return NULL;
 126
 127     #undef ART
 128 }
 129
 130 GtkIconSize wxArtClientToIconSize(const wxArtClient& client)
 131 {
 132     if (client == wxART_TOOLBAR)
 133         return GTK_ICON_SIZE_LARGE_TOOLBAR;
 134     else if (client == wxART_MENU)
 135         return GTK_ICON_SIZE_MENU;
 136     else if (client == wxART_CMN_DIALOG || client == wxART_MESSAGE_BOX)
 137         return GTK_ICON_SIZE_DIALOG;
 138     else if (client == wxART_BUTTON)
 139         return GTK_ICON_SIZE_BUTTON;
 140     else
 141         return GTK_ICON_SIZE_INVALID; // this is arbitrary
 142 }
 143
 144 static GtkIconSize FindClosestIconSize(const wxSize& size)
 145 {
 146     #define NUM_SIZES 6
 147     static struct
 148     {
 149         GtkIconSize icon;
 150         gint x, y;
 151     } s_sizes[NUM_SIZES];
 152     static bool s_sizesInitialized = false;
 153
 154     if (!s_sizesInitialized)
 155     {
 156         s_sizes[0].icon = GTK_ICON_SIZE_MENU;
 157         s_sizes[1].icon = GTK_ICON_SIZE_SMALL_TOOLBAR;
 158         s_sizes[2].icon = GTK_ICON_SIZE_LARGE_TOOLBAR;
 159         s_sizes[3].icon = GTK_ICON_SIZE_BUTTON;
 160         s_sizes[4].icon = GTK_ICON_SIZE_DND;
 161         s_sizes[5].icon = GTK_ICON_SIZE_DIALOG;
 162         for (size_t i = 0; i < NUM_SIZES; i++)
 163         {
 164             gtk_icon_size_lookup(s_sizes[i].icon,
 165                                  &s_sizes[i].x, &s_sizes[i].y);
 166         }
 167         s_sizesInitialized = true;
 168     }
 169
 170     GtkIconSize best = GTK_ICON_SIZE_DIALOG; // presumably largest
 171     unsigned distance = INT_MAX;
 172     for (size_t i = 0; i < NUM_SIZES; i++)
 173     {
 174         // only use larger bitmaps, scaling down looks better than scaling up:
 175         if (size.x > s_sizes[i].x || size.y > s_sizes[i].y)
 176             continue;
 177
 178         unsigned dist = (size.x - s_sizes[i].x) * (size.x - s_sizes[i].x) +
 179                         (size.y - s_sizes[i].y) * (size.y - s_sizes[i].y);
 180         if (dist == 0)
 181             return s_sizes[i].icon;
 182         else if (dist < distance)
 183         {
 184             distance = dist;
 185             best = s_sizes[i].icon;
 186         }
 187     }
 188     return best;
 189 }
 190
 191
 192 static GtkStyle *gs_gtkStyle = NULL;
 193
 194 static GdkPixbuf *CreateStockIcon(const char *stockid, GtkIconSize size)
 195 {
 196     // FIXME: This code is not 100% correct, because stock pixmap are
 197     //        context-dependent and may be affected by theme engine, the
 198     //        correct value can only be obtained for given GtkWidget object.
 199     //
 200     //        Fool-proof implementation of stock bitmaps would extend wxBitmap
 201     //        with "stock-id" representation (in addition to pixmap and pixbuf
 202     //        ones) and would convert it to pixbuf when rendered.
 203
 204     if (gs_gtkStyle == NULL)
 205     {
 206         GtkWidget *widget = gtk_button_new();
 207         gs_gtkStyle = gtk_rc_get_style(widget);
 208         wxASSERT( gs_gtkStyle != NULL );
 209         g_object_ref(gs_gtkStyle);
 210         g_object_ref_sink(widget);
 211     }
 212
 213     GtkIconSet *iconset = gtk_style_lookup_icon_set(gs_gtkStyle, stockid);
 214
 215     if (!iconset)
 216         return NULL;
 217
 218     return gtk_icon_set_render_icon(iconset, gs_gtkStyle,
 219                                     gtk_widget_get_default_direction(),
 220                                     GTK_STATE_NORMAL, size, NULL, NULL);
 221 }
 222
 223 static GdkPixbuf *CreateThemeIcon(const char *iconname,
 224                                   GtkIconSize iconsize, const wxSize& sz)
 225 {
 226     wxSize size(sz);
 227     if (size == wxDefaultSize)
 228     {
 229         gtk_icon_size_lookup(iconsize, &size.x, &size.y);
 230     }
 231
 232     return gtk_icon_theme_load_icon(
 233                     gtk_icon_theme_get_default(),
 234                     iconname,
 235                     size.x,
 236                     (GtkIconLookupFlags)0, NULL);
 237 }
 238
 239 wxBitmap wxGTK2ArtProvider::CreateBitmap(const wxArtID& id,
 240                                          const wxArtClient& client,
 241                                          const wxSize& size)
 242 {
 243     wxCharBuffer stockid = wxArtIDToStock(id);
 244     GtkIconSize stocksize = (size == wxDefaultSize) ?
 245                                 wxArtClientToIconSize(client) :
 246                                 FindClosestIconSize(size);
 247
 248     // we must have some size, this is arbitrary
 249     if (stocksize == GTK_ICON_SIZE_INVALID)
 250         stocksize = GTK_ICON_SIZE_BUTTON;
 251
 252     // allow passing GTK+ stock IDs to wxArtProvider:
 253     if (!stockid)
 254         stockid = id.ToAscii();
 255
 256     GdkPixbuf *pixbuf = CreateStockIcon(stockid, stocksize);
 257     if (!pixbuf)
 258         pixbuf = CreateThemeIcon(stockid, stocksize, size);
 259
 260     if (pixbuf && size != wxDefaultSize &&
 261         (size.x != gdk_pixbuf_get_width(pixbuf) ||
 262          size.y != gdk_pixbuf_get_height(pixbuf)))
 263     {
 264         GdkPixbuf *p2 = gdk_pixbuf_scale_simple(pixbuf, size.x, size.y,
 265                                                 GDK_INTERP_BILINEAR);
 266         if (p2)
 267         {
 268             g_object_unref (pixbuf);
 269             pixbuf = p2;
 270         }
 271     }
 272
 273     wxBitmap bmp;
 274     if (pixbuf != NULL)
 275         bmp.SetPixbuf(pixbuf);
 276
 277     return bmp;
 278 }
 279
 280 // ----------------------------------------------------------------------------
 281 // Cleanup
 282 // ----------------------------------------------------------------------------
 283
 284 class wxArtGtkModule: public wxModule
 285 {
 286 public:
 287     bool OnInit() { return true; }
 288     void OnExit()
 289     {
 290         if (gs_gtkStyle)
 291         {
 292             g_object_unref(gs_gtkStyle);
 293             gs_gtkStyle = NULL;
 294         }
 295     }
 296
 297     DECLARE_DYNAMIC_CLASS(wxArtGtkModule)
 298 };
 299
 300 IMPLEMENT_DYNAMIC_CLASS(wxArtGtkModule, wxModule)
 301
 302 #endif // !defined(__WXUNIVERSAL__)