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