Pileus Git - ~andy/gtk/blob - gtk/gtkstock.c

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 2000 Red Hat, Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #include "config.h"
  28
  29 #include <string.h>
  30
  31 #include "gtkprivate.h"
  32 #include "gtkstock.h"
  33 #include "gtkiconfactory.h"
  34 #include "gtkintl.h"
  35
  36 /**
  37  * SECTION:gtkstock
  38  * @Short_description:
  39 Prebuilt common menu/toolbar items and corresponding icons
  40  * @Title: Stock Items
  41  *
  42  * Stock items represent commonly-used menu or toolbar items such as
  43  * "Open" or "Exit". Each stock item is identified by a stock ID;
  44  * stock IDs are just strings, but macros such as #GTK_STOCK_OPEN are
  45  * provided to avoid typing mistakes in the strings.
  46  * Applications can register their own stock items in addition to those
  47  * built-in to GTK+.
  48  *
  49  * Each stock ID can be associated with a #GtkStockItem, which contains
  50  * the user-visible label, keyboard accelerator, and translation domain
  51  * of the menu or toolbar item; and/or with an icon stored in a
  52  * #GtkIconFactory. See <link
  53  * linkend="gtk3-Themeable-Stock-Images">GtkIconFactory</link> for
  54  * more information on stock icons. The connection between a
  55  * #GtkStockItem and stock icons is purely conventional (by virtue of
  56  * using the same stock ID); it's possible to register a stock item but
  57  * no icon, and vice versa. Stock icons may have a RTL variant which gets
  58  * used for right-to-left locales.
  59  */
  60
  61 static GHashTable *translate_hash = NULL;
  62 static GHashTable *stock_hash = NULL;
  63 static void init_stock_hash (void);
  64
  65 /* We use an unused modifier bit to mark stock items which
  66  * must be freed when they are removed from the hash table.
  67  */
  68 #define NON_STATIC_MASK (1 << 29)
  69
  70 /* Magic value which is automatically replaced by the primary accel modifier */
  71 #define PRIMARY_MODIFIER 0xffffffff
  72
  73 typedef struct _GtkStockTranslateFunc GtkStockTranslateFunc;
  74 struct _GtkStockTranslateFunc
  75 {
  76   GtkTranslateFunc func;
  77   gpointer data;
  78   GDestroyNotify notify;
  79 };
  80
  81 static void
  82 real_add (const GtkStockItem *items,
  83           guint               n_items,
  84           gboolean            copy,
  85           gboolean            replace_primary)
  86 {
  87   int i;
  88
  89   init_stock_hash ();
  90
  91   if (n_items == 0)
  92     return;
  93
  94   i = 0;
  95   while (i < n_items)
  96     {
  97       gpointer old_key, old_value;
  98       const GtkStockItem *item = &items[i];
  99
 100       if (replace_primary && item->modifier == PRIMARY_MODIFIER)
 101         {
 102           item = gtk_stock_item_copy (item);
 103           ((GtkStockItem *)item)->modifier = (NON_STATIC_MASK |
 104                                               _gtk_get_primary_accel_mod ());
 105         }
 106       else
 107         {
 108           if (item->modifier & NON_STATIC_MASK)
 109             {
 110               g_warning ("Bit 29 set in stock accelerator.\n");
 111               copy = TRUE;
 112             }
 113
 114           if (copy)
 115             {
 116               item = gtk_stock_item_copy (item);
 117               ((GtkStockItem *)item)->modifier |= NON_STATIC_MASK;
 118             }
 119         }
 120
 121       if (g_hash_table_lookup_extended (stock_hash, item->stock_id,
 122                                         &old_key, &old_value))
 123         {
 124           g_hash_table_remove (stock_hash, old_key);
 125           if (((GtkStockItem *)old_value)->modifier & NON_STATIC_MASK)
 126             gtk_stock_item_free (old_value);
 127         }
 128
 129       g_hash_table_insert (stock_hash,
 130                            (gchar*)item->stock_id, (GtkStockItem*)item);
 131
 132       ++i;
 133     }
 134 }
 135
 136 /**
 137  * gtk_stock_add:
 138  * @items: (array length=n_items): a #GtkStockItem or array of items
 139  * @n_items: number of #GtkStockItem in @items
 140  *
 141  * Registers each of the stock items in @items. If an item already
 142  * exists with the same stock ID as one of the @items, the old item
 143  * gets replaced. The stock items are copied, so GTK+ does not hold
 144  * any pointer into @items and @items can be freed. Use
 145  * gtk_stock_add_static() if @items is persistent and GTK+ need not
 146  * copy the array.
 147  *
 148  **/
 149 void
 150 gtk_stock_add (const GtkStockItem *items,
 151                guint               n_items)
 152 {
 153   g_return_if_fail (items != NULL);
 154
 155   real_add (items, n_items, TRUE, FALSE);
 156 }
 157
 158 /**
 159  * gtk_stock_add_static:
 160  * @items: (array length=n_items): a #GtkStockItem or array of #GtkStockItem
 161  * @n_items: number of items
 162  *
 163  * Same as gtk_stock_add(), but doesn't copy @items, so
 164  * @items must persist until application exit.
 165  *
 166  **/
 167 void
 168 gtk_stock_add_static (const GtkStockItem *items,
 169                       guint               n_items)
 170 {
 171   g_return_if_fail (items != NULL);
 172
 173   real_add (items, n_items, FALSE, FALSE);
 174 }
 175
 176 /**
 177  * gtk_stock_lookup:
 178  * @stock_id: a stock item name
 179  * @item: (out): stock item to initialize with values
 180  *
 181  * Fills @item with the registered values for @stock_id, returning %TRUE
 182  * if @stock_id was known.
 183  *
 184  *
 185  * Return value: %TRUE if @item was initialized
 186  **/
 187 gboolean
 188 gtk_stock_lookup (const gchar  *stock_id,
 189                   GtkStockItem *item)
 190 {
 191   const GtkStockItem *found;
 192
 193   g_return_val_if_fail (stock_id != NULL, FALSE);
 194   g_return_val_if_fail (item != NULL, FALSE);
 195
 196   init_stock_hash ();
 197
 198   found = g_hash_table_lookup (stock_hash, stock_id);
 199
 200   if (found)
 201     {
 202       *item = *found;
 203       item->modifier &= ~NON_STATIC_MASK;
 204       if (item->label)
 205         {
 206           GtkStockTranslateFunc *translate;
 207
 208           if (item->translation_domain)
 209             translate = (GtkStockTranslateFunc *)
 210               g_hash_table_lookup (translate_hash, item->translation_domain);
 211           else
 212             translate = NULL;
 213
 214           if (translate != NULL && translate->func != NULL)
 215             item->label = (* translate->func) (item->label, translate->data);
 216           else
 217             item->label = (gchar *) g_dgettext (item->translation_domain, item->label);
 218         }
 219     }
 220
 221   return found != NULL;
 222 }
 223
 224 /**
 225  * gtk_stock_list_ids:
 226  *
 227  * Retrieves a list of all known stock IDs added to a #GtkIconFactory
 228  * or registered with gtk_stock_add(). The list must be freed with g_slist_free(),
 229  * and each string in the list must be freed with g_free().
 230  *
 231  * Return value: (element-type utf8) (transfer full): a list of known stock IDs
 232  **/
 233 GSList*
 234 gtk_stock_list_ids (void)
 235 {
 236   GList *ids;
 237   GList *icon_ids;
 238   GSList *retval;
 239   const gchar *last_id;
 240
 241   init_stock_hash ();
 242
 243   ids = g_hash_table_get_keys (stock_hash);
 244   icon_ids = _gtk_icon_factory_list_ids ();
 245   ids = g_list_concat (ids, icon_ids);
 246
 247   ids = g_list_sort (ids, (GCompareFunc)strcmp);
 248
 249   last_id = NULL;
 250   retval = NULL;
 251   while (ids != NULL)
 252     {
 253       GList *next;
 254
 255       next = g_list_next (ids);
 256
 257       if (last_id && strcmp (ids->data, last_id) == 0)
 258         {
 259           /* duplicate, ignore */
 260         }
 261       else
 262         {
 263           retval = g_slist_prepend (retval, g_strdup (ids->data));
 264           last_id = ids->data;
 265         }
 266
 267       g_list_free_1 (ids);
 268
 269       ids = next;
 270     }
 271
 272   return retval;
 273 }
 274
 275 /**
 276  * gtk_stock_item_copy: (skip)
 277  * @item: a #GtkStockItem
 278  *
 279  * Copies a stock item, mostly useful for language bindings and not in applications.
 280  *
 281  * Return value: a new #GtkStockItem
 282  **/
 283 GtkStockItem *
 284 gtk_stock_item_copy (const GtkStockItem *item)
 285 {
 286   GtkStockItem *copy;
 287
 288   g_return_val_if_fail (item != NULL, NULL);
 289
 290   copy = g_new (GtkStockItem, 1);
 291
 292   *copy = *item;
 293
 294   copy->stock_id = g_strdup (item->stock_id);
 295   copy->label = g_strdup (item->label);
 296   copy->translation_domain = g_strdup (item->translation_domain);
 297
 298   return copy;
 299 }
 300
 301 /**
 302  * gtk_stock_item_free:
 303  * @item: a #GtkStockItem
 304  *
 305  * Frees a stock item allocated on the heap, such as one returned by
 306  * gtk_stock_item_copy(). Also frees the fields inside the stock item,
 307  * if they are not %NULL.
 308  *
 309  **/
 310 void
 311 gtk_stock_item_free (GtkStockItem *item)
 312 {
 313   g_return_if_fail (item != NULL);
 314
 315   g_free ((gchar*)item->stock_id);
 316   g_free ((gchar*)item->label);
 317   g_free ((gchar*)item->translation_domain);
 318
 319   g_free (item);
 320 }
 321
 322 static const GtkStockItem builtin_items [] =
 323 {
 324   /* KEEP IN SYNC with gtkiconfactory.c stock icons, when appropriate */
 325
 326   { GTK_STOCK_DIALOG_INFO, NC_("Stock label", "Information"), 0, 0, GETTEXT_PACKAGE },
 327   { GTK_STOCK_DIALOG_WARNING, NC_("Stock label", "Warning"), 0, 0, GETTEXT_PACKAGE },
 328   { GTK_STOCK_DIALOG_ERROR, NC_("Stock label", "Error"), 0, 0, GETTEXT_PACKAGE },
 329   { GTK_STOCK_DIALOG_QUESTION, NC_("Stock label", "Question"), 0, 0, GETTEXT_PACKAGE },
 330
 331   /*  FIXME these need accelerators when appropriate, and
 332    * need the mnemonics to be rationalized
 333    */
 334   { GTK_STOCK_ABOUT, NC_("Stock label", "_About"), 0, 0, GETTEXT_PACKAGE },
 335   { GTK_STOCK_ADD, NC_("Stock label", "_Add"), 0, 0, GETTEXT_PACKAGE },
 336   { GTK_STOCK_APPLY, NC_("Stock label", "_Apply"), 0, 0, GETTEXT_PACKAGE },
 337   { GTK_STOCK_BOLD, NC_("Stock label", "_Bold"), 0, 0, GETTEXT_PACKAGE },
 338   { GTK_STOCK_CANCEL, NC_("Stock label", "_Cancel"), 0, 0, GETTEXT_PACKAGE },
 339   { GTK_STOCK_CDROM, NC_("Stock label", "_CD-ROM"), 0, 0, GETTEXT_PACKAGE },
 340   { GTK_STOCK_CLEAR, NC_("Stock label", "_Clear"), 0, 0, GETTEXT_PACKAGE },
 341   { GTK_STOCK_CLOSE, NC_("Stock label", "_Close"), PRIMARY_MODIFIER, 'w', GETTEXT_PACKAGE },
 342   { GTK_STOCK_CONNECT, NC_("Stock label", "C_onnect"), 0, 0, GETTEXT_PACKAGE },
 343   { GTK_STOCK_CONVERT, NC_("Stock label", "_Convert"), 0, 0, GETTEXT_PACKAGE },
 344    { GTK_STOCK_COPY, NC_("Stock label", "_Copy"), PRIMARY_MODIFIER, 'c', GETTEXT_PACKAGE },
 345   { GTK_STOCK_CUT, NC_("Stock label", "Cu_t"), PRIMARY_MODIFIER, 'x', GETTEXT_PACKAGE },
 346   { GTK_STOCK_DELETE, NC_("Stock label", "_Delete"), 0, 0, GETTEXT_PACKAGE },
 347   { GTK_STOCK_DISCARD, NC_("Stock label", "_Discard"), 0, 0, GETTEXT_PACKAGE },
 348   { GTK_STOCK_DISCONNECT, NC_("Stock label", "_Disconnect"), 0, 0, GETTEXT_PACKAGE },
 349   { GTK_STOCK_EXECUTE, NC_("Stock label", "_Execute"), 0, 0, GETTEXT_PACKAGE },
 350   { GTK_STOCK_EDIT, NC_("Stock label", "_Edit"), 0, 0, GETTEXT_PACKAGE },
 351   { GTK_STOCK_FILE, NC_("Stock label", "_File"), 0, 0, GETTEXT_PACKAGE },
 352   { GTK_STOCK_FIND, NC_("Stock label", "_Find"), PRIMARY_MODIFIER, 'f', GETTEXT_PACKAGE },
 353   { GTK_STOCK_FIND_AND_REPLACE, NC_("Stock label", "Find and _Replace"), PRIMARY_MODIFIER, 'r', GETTEXT_PACKAGE },
 354   { GTK_STOCK_FLOPPY, NC_("Stock label", "_Floppy"), 0, 0, GETTEXT_PACKAGE },
 355   { GTK_STOCK_FULLSCREEN, NC_("Stock label", "_Fullscreen"), 0, 0, GETTEXT_PACKAGE },
 356   { GTK_STOCK_LEAVE_FULLSCREEN, NC_("Stock label", "_Leave Fullscreen"), 0, 0, GETTEXT_PACKAGE },
 357   /* This is a navigation label as in "go to the bottom of the page" */
 358   { GTK_STOCK_GOTO_BOTTOM, NC_("Stock label, navigation", "_Bottom"), 0, 0, GETTEXT_PACKAGE "-navigation" },
 359   /* This is a navigation label as in "go to the first page" */
 360   { GTK_STOCK_GOTO_FIRST, NC_("Stock label, navigation", "_First"), 0, 0, GETTEXT_PACKAGE "-navigation" },
 361   /* This is a navigation label as in "go to the last page" */
 362   { GTK_STOCK_GOTO_LAST, NC_("Stock label, navigation", "_Last"), 0, 0, GETTEXT_PACKAGE "-navigation" },
 363   /* This is a navigation label as in "go to the top of the page" */
 364   { GTK_STOCK_GOTO_TOP, NC_("Stock label, navigation", "_Top"), 0, 0, GETTEXT_PACKAGE "-navigation" },
 365   /* This is a navigation label as in "go back" */
 366   { GTK_STOCK_GO_BACK, NC_("Stock label, navigation", "_Back"), 0, 0, GETTEXT_PACKAGE "-navigation" },
 367   /* This is a navigation label as in "go down" */
 368   { GTK_STOCK_GO_DOWN, NC_("Stock label, navigation", "_Down"), 0, 0, GETTEXT_PACKAGE "-navigation" },
 369   /* This is a navigation label as in "go forward" */
 370   { GTK_STOCK_GO_FORWARD, NC_("Stock label, navigation", "_Forward"), 0, 0, GETTEXT_PACKAGE "-navigation" },
 371   /* This is a navigation label as in "go up" */
 372   { GTK_STOCK_GO_UP, NC_("Stock label, navigation", "_Up"), 0, 0, GETTEXT_PACKAGE "-navigation" },
 373   { GTK_STOCK_HARDDISK, NC_("Stock label", "_Hard Disk"), 0, 0, GETTEXT_PACKAGE },
 374   { GTK_STOCK_HELP, NC_("Stock label", "_Help"), PRIMARY_MODIFIER, 'h', GETTEXT_PACKAGE },
 375   { GTK_STOCK_HOME, NC_("Stock label", "_Home"), 0, 0, GETTEXT_PACKAGE },
 376   { GTK_STOCK_INDENT, NC_("Stock label", "Increase Indent"), 0, 0, GETTEXT_PACKAGE },
 377   { GTK_STOCK_UNINDENT, NC_("Stock label", "Decrease Indent"), 0, 0, GETTEXT_PACKAGE },
 378   { GTK_STOCK_INDEX, NC_("Stock label", "_Index"), 0, 0, GETTEXT_PACKAGE },
 379   { GTK_STOCK_INFO, NC_("Stock label", "_Information"), 0, 0, GETTEXT_PACKAGE },
 380   { GTK_STOCK_ITALIC, NC_("Stock label", "_Italic"), 0, 0, GETTEXT_PACKAGE },
 381   { GTK_STOCK_JUMP_TO, NC_("Stock label", "_Jump to"), 0, 0, GETTEXT_PACKAGE },
 382   /* This is about text justification, "centered text" */
 383   { GTK_STOCK_JUSTIFY_CENTER, NC_("Stock label", "_Center"), 0, 0, GETTEXT_PACKAGE },
 384   /* This is about text justification */
 385   { GTK_STOCK_JUSTIFY_FILL, NC_("Stock label", "_Fill"), 0, 0, GETTEXT_PACKAGE },
 386   /* This is about text justification, "left-justified text" */
 387   { GTK_STOCK_JUSTIFY_LEFT, NC_("Stock label", "_Left"), 0, 0, GETTEXT_PACKAGE },
 388   /* This is about text justification, "right-justified text" */
 389   { GTK_STOCK_JUSTIFY_RIGHT, NC_("Stock label", "_Right"), 0, 0, GETTEXT_PACKAGE },
 390
 391   /* Media label, as in "fast forward" */
 392   { GTK_STOCK_MEDIA_FORWARD, NC_("Stock label, media", "_Forward"), 0, 0, GETTEXT_PACKAGE "-media" },
 393   /* Media label, as in "next song" */
 394   { GTK_STOCK_MEDIA_NEXT, NC_("Stock label, media", "_Next"), 0, 0, GETTEXT_PACKAGE "-media" },
 395   /* Media label, as in "pause music" */
 396   { GTK_STOCK_MEDIA_PAUSE, NC_("Stock label, media", "P_ause"), 0, 0, GETTEXT_PACKAGE "-media" },
 397   /* Media label, as in "play music" */
 398   { GTK_STOCK_MEDIA_PLAY, NC_("Stock label, media", "_Play"), 0, 0, GETTEXT_PACKAGE "-media" },
 399   /* Media label, as in  "previous song" */
 400   { GTK_STOCK_MEDIA_PREVIOUS, NC_("Stock label, media", "Pre_vious"), 0, 0, GETTEXT_PACKAGE "-media" },
 401   /* Media label */
 402   { GTK_STOCK_MEDIA_RECORD, NC_("Stock label, media", "_Record"), 0, 0, GETTEXT_PACKAGE "-media" },
 403   /* Media label */
 404   { GTK_STOCK_MEDIA_REWIND, NC_("Stock label, media", "R_ewind"), 0, 0, GETTEXT_PACKAGE "-media" },
 405   /* Media label */
 406   { GTK_STOCK_MEDIA_STOP, NC_("Stock label, media", "_Stop"), 0, 0, GETTEXT_PACKAGE "-media" },
 407   { GTK_STOCK_NETWORK, NC_("Stock label", "_Network"), 0, 0, GETTEXT_PACKAGE },
 408   { GTK_STOCK_NEW, NC_("Stock label", "_New"), PRIMARY_MODIFIER, 'n', GETTEXT_PACKAGE },
 409   { GTK_STOCK_NO, NC_("Stock label", "_No"), 0, 0, GETTEXT_PACKAGE },
 410   { GTK_STOCK_OK, NC_("Stock label", "_OK"), 0, 0, GETTEXT_PACKAGE },
 411   { GTK_STOCK_OPEN, NC_("Stock label", "_Open"), PRIMARY_MODIFIER, 'o', GETTEXT_PACKAGE },
 412   /* Page orientation */
 413   { GTK_STOCK_ORIENTATION_LANDSCAPE, NC_("Stock label", "Landscape"), 0, 0, GETTEXT_PACKAGE },
 414   /* Page orientation */
 415   { GTK_STOCK_ORIENTATION_PORTRAIT, NC_("Stock label", "Portrait"), 0, 0, GETTEXT_PACKAGE },
 416   /* Page orientation */
 417   { GTK_STOCK_ORIENTATION_REVERSE_LANDSCAPE, NC_("Stock label", "Reverse landscape"), 0, 0, GETTEXT_PACKAGE },
 418   /* Page orientation */
 419   { GTK_STOCK_ORIENTATION_REVERSE_PORTRAIT, NC_("Stock label", "Reverse portrait"), 0, 0, GETTEXT_PACKAGE },
 420   { GTK_STOCK_PAGE_SETUP, NC_("Stock label", "Page Set_up"), 0, 0, GETTEXT_PACKAGE },
 421   { GTK_STOCK_PASTE, NC_("Stock label", "_Paste"), PRIMARY_MODIFIER, 'v', GETTEXT_PACKAGE },
 422   { GTK_STOCK_PREFERENCES, NC_("Stock label", "_Preferences"), 0, 0, GETTEXT_PACKAGE },
 423   { GTK_STOCK_PRINT, NC_("Stock label", "_Print"), 0, 0, GETTEXT_PACKAGE },
 424   { GTK_STOCK_PRINT_PREVIEW, NC_("Stock label", "Print Pre_view"), 0, 0, GETTEXT_PACKAGE },
 425   { GTK_STOCK_PROPERTIES, NC_("Stock label", "_Properties"), 0, 0, GETTEXT_PACKAGE },
 426   { GTK_STOCK_QUIT, NC_("Stock label", "_Quit"), PRIMARY_MODIFIER, 'q', GETTEXT_PACKAGE },
 427   { GTK_STOCK_REDO, NC_("Stock label", "_Redo"), 0, 0, GETTEXT_PACKAGE },
 428   { GTK_STOCK_REFRESH, NC_("Stock label", "_Refresh"), 0, 0, GETTEXT_PACKAGE },
 429   { GTK_STOCK_REMOVE, NC_("Stock label", "_Remove"), 0, 0, GETTEXT_PACKAGE },
 430   { GTK_STOCK_REVERT_TO_SAVED, NC_("Stock label", "_Revert"), 0, 0, GETTEXT_PACKAGE },
 431   { GTK_STOCK_SAVE, NC_("Stock label", "_Save"), PRIMARY_MODIFIER, 's', GETTEXT_PACKAGE },
 432   { GTK_STOCK_SAVE_AS, NC_("Stock label", "Save _As"), 0, 0, GETTEXT_PACKAGE },
 433   { GTK_STOCK_SELECT_ALL, NC_("Stock label", "Select _All"), 0, 0, GETTEXT_PACKAGE },
 434   { GTK_STOCK_SELECT_COLOR, NC_("Stock label", "_Color"), 0, 0, GETTEXT_PACKAGE },
 435   { GTK_STOCK_SELECT_FONT, NC_("Stock label", "_Font"), 0, 0, GETTEXT_PACKAGE },
 436   /* Sorting direction */
 437   { GTK_STOCK_SORT_ASCENDING, NC_("Stock label", "_Ascending"), 0, 0, GETTEXT_PACKAGE },
 438   /* Sorting direction */
 439   { GTK_STOCK_SORT_DESCENDING, NC_("Stock label", "_Descending"), 0, 0, GETTEXT_PACKAGE },
 440   { GTK_STOCK_SPELL_CHECK, NC_("Stock label", "_Spell Check"), 0, 0, GETTEXT_PACKAGE },
 441   { GTK_STOCK_STOP, NC_("Stock label", "_Stop"), 0, 0, GETTEXT_PACKAGE },
 442   /* Font variant */
 443   { GTK_STOCK_STRIKETHROUGH, NC_("Stock label", "_Strikethrough"), 0, 0, GETTEXT_PACKAGE },
 444   { GTK_STOCK_UNDELETE, NC_("Stock label", "_Undelete"), 0, 0, GETTEXT_PACKAGE },
 445   /* Font variant */
 446   { GTK_STOCK_UNDERLINE, NC_("Stock label", "_Underline"), 0, 0, GETTEXT_PACKAGE },
 447   { GTK_STOCK_UNDO, NC_("Stock label", "_Undo"), 0, 0, GETTEXT_PACKAGE },
 448   { GTK_STOCK_YES, NC_("Stock label", "_Yes"), 0, 0, GETTEXT_PACKAGE },
 449   /* Zoom */
 450   { GTK_STOCK_ZOOM_100, NC_("Stock label", "_Normal Size"), 0, 0, GETTEXT_PACKAGE },
 451   /* Zoom */
 452   { GTK_STOCK_ZOOM_FIT, NC_("Stock label", "Best _Fit"), 0, 0, GETTEXT_PACKAGE },
 453   { GTK_STOCK_ZOOM_IN, NC_("Stock label", "Zoom _In"), 0, 0, GETTEXT_PACKAGE },
 454   { GTK_STOCK_ZOOM_OUT, NC_("Stock label", "Zoom _Out"), 0, 0, GETTEXT_PACKAGE }
 455 };
 456
 457 /**
 458  * gtk_stock_set_translate_func:
 459  * @domain: the translation domain for which @func shall be used
 460  * @func: a #GtkTranslateFunc
 461  * @data: data to pass to @func
 462  * @notify: a #GDestroyNotify that is called when @data is
 463  *   no longer needed
 464  *
 465  * Sets a function to be used for translating the @label of
 466  * a stock item.
 467  *
 468  * If no function is registered for a translation domain,
 469  * g_dgettext() is used.
 470  *
 471  * The function is used for all stock items whose
 472  * @translation_domain matches @domain. Note that it is possible
 473  * to use strings different from the actual gettext translation domain
 474  * of your application for this, as long as your #GtkTranslateFunc uses
 475  * the correct domain when calling dgettext(). This can be useful, e.g.
 476  * when dealing with message contexts:
 477  *
 478  * |[
 479  * GtkStockItem items[] = {
 480  *  { MY_ITEM1, NC_("odd items", "Item 1"), 0, 0, "odd-item-domain" },
 481  *  { MY_ITEM2, NC_("even items", "Item 2"), 0, 0, "even-item-domain" },
 482  * };
 483  *
 484  * gchar *
 485  * my_translate_func (const gchar *msgid,
 486  *                    gpointer     data)
 487  * {
 488  *   gchar *msgctxt = data;
 489  *
 490  *   return (gchar*)g_dpgettext2 (GETTEXT_PACKAGE, msgctxt, msgid);
 491  * }
 492  *
 493  * /&ast; ... &ast;/
 494  *
 495  * gtk_stock_add (items, G_N_ELEMENTS (items));
 496  * gtk_stock_set_translate_func ("odd-item-domain", my_translate_func, "odd items");
 497  * gtk_stock_set_translate_func ("even-item-domain", my_translate_func, "even items");
 498  * ]|
 499  *
 500  * Since: 2.8
 501  */
 502 void
 503 gtk_stock_set_translate_func (const gchar      *domain,
 504                               GtkTranslateFunc  func,
 505                               gpointer          data,
 506                               GDestroyNotify    notify)
 507 {
 508   GtkStockTranslateFunc *translate;
 509   gchar *domainname;
 510
 511   domainname = g_strdup (domain);
 512
 513   translate = (GtkStockTranslateFunc *)
 514     g_hash_table_lookup (translate_hash, domainname);
 515
 516   if (translate)
 517     {
 518       if (translate->notify)
 519         (* translate->notify) (translate->data);
 520     }
 521   else
 522     translate = g_new0 (GtkStockTranslateFunc, 1);
 523
 524   translate->func = func;
 525   translate->data = data;
 526   translate->notify = notify;
 527
 528   g_hash_table_insert (translate_hash, domainname, translate);
 529 }
 530
 531 static gchar *
 532 sgettext_swapped (const gchar *msgid,
 533                   gpointer     data)
 534 {
 535   gchar *msgctxt = data;
 536
 537   return (gchar *)g_dpgettext2 (GETTEXT_PACKAGE, msgctxt, msgid);
 538 }
 539
 540 static void
 541 init_stock_hash (void)
 542 {
 543   if (stock_hash == NULL)
 544     {
 545       stock_hash = g_hash_table_new (g_str_hash, g_str_equal);
 546
 547       real_add (builtin_items, G_N_ELEMENTS (builtin_items), FALSE, TRUE);
 548     }
 549
 550   if (translate_hash == NULL)
 551     {
 552       translate_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
 553                                               g_free, NULL);
 554
 555       gtk_stock_set_translate_func (GETTEXT_PACKAGE,
 556                                     sgettext_swapped,
 557                                     "Stock label",
 558                                     NULL);
 559       gtk_stock_set_translate_func (GETTEXT_PACKAGE "-navigation",
 560                                     sgettext_swapped,
 561                                     "Stock label, navigation",
 562                                     NULL);
 563       gtk_stock_set_translate_func (GETTEXT_PACKAGE "-media",
 564                                     sgettext_swapped,
 565                                     "Stock label, media",
 566                                     NULL);
 567     }
 568 }