gtkstock.c 20.9 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Havoc Pennington's avatar
Havoc Pennington committed
2
 * Copyright (C) 2000 Red Hat, Inc. 
3 4 5 6 7 8 9 10 11 12 13 14
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 17 18 19 20 21 22 23 24
 */

/*
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

25
#include "config.h"
26

27 28
#define GDK_DISABLE_DEPRECATION_WARNINGS

29 30
#include <string.h>

Yevgen Muntyan's avatar
Yevgen Muntyan committed
31
#include "gtkprivate.h"
32
#include "gtkstock.h"
33
#include "gtkiconfactory.h"
34
#include "deprecated/gtkiconfactoryprivate.h"
35 36
#include "gtkintl.h"

37 38 39 40 41 42 43
/**
 * SECTION:gtkstock
 * @Short_description:
Prebuilt common menu/toolbar items and corresponding icons
 * @Title: Stock Items
 *
 * Stock items represent commonly-used menu or toolbar items such as
William Jon McCann's avatar
William Jon McCann committed
44
 * “Open” or “Exit”. Each stock item is identified by a stock ID;
45 46 47 48 49 50 51 52
 * stock IDs are just strings, but macros such as #GTK_STOCK_OPEN are
 * provided to avoid typing mistakes in the strings.
 * Applications can register their own stock items in addition to those
 * built-in to GTK+.
 *
 * Each stock ID can be associated with a #GtkStockItem, which contains
 * the user-visible label, keyboard accelerator, and translation domain
 * of the menu or toolbar item; and/or with an icon stored in a
53
 * #GtkIconFactory. The connection between a
54
 * #GtkStockItem and stock icons is purely conventional (by virtue of
55
 * using the same stock ID); it’s possible to register a stock item but
56 57 58 59
 * no icon, and vice versa. Stock icons may have a RTL variant which gets
 * used for right-to-left locales.
 */

60
static GHashTable *translate_hash = NULL;
61 62 63
static GHashTable *stock_hash = NULL;
static void init_stock_hash (void);

64 65 66 67 68
/* We use an unused modifier bit to mark stock items which
 * must be freed when they are removed from the hash table.
 */
#define NON_STATIC_MASK (1 << 29)

69 70 71
/* Magic value which is automatically replaced by the primary accel modifier */
#define PRIMARY_MODIFIER 0xffffffff

72 73 74 75 76
typedef struct _GtkStockTranslateFunc GtkStockTranslateFunc;
struct _GtkStockTranslateFunc
{
  GtkTranslateFunc func;
  gpointer data;
77
  GDestroyNotify notify;
78 79
};

80 81 82
static void
real_add (const GtkStockItem *items,
          guint               n_items,
83 84
          gboolean            copy,
          gboolean            replace_primary)
85 86 87 88 89 90 91 92 93 94 95 96 97
{
  int i;

  init_stock_hash ();

  if (n_items == 0)
    return;

  i = 0;
  while (i < n_items)
    {
      gpointer old_key, old_value;
      const GtkStockItem *item = &items[i];
98

99
      if (replace_primary && (guint)item->modifier == PRIMARY_MODIFIER)
100 101 102 103 104 105 106 107 108
        {
          item = gtk_stock_item_copy (item);
          ((GtkStockItem *)item)->modifier = (NON_STATIC_MASK |
                                              _gtk_get_primary_accel_mod ());
        }
      else
        {
          if (item->modifier & NON_STATIC_MASK)
            {
109
              g_warning ("Bit 29 set in stock accelerator.");
110 111 112 113 114 115 116 117 118
              copy = TRUE;
            }

          if (copy)
            {
              item = gtk_stock_item_copy (item);
              ((GtkStockItem *)item)->modifier |= NON_STATIC_MASK;
            }
        }
119 120 121 122 123

      if (g_hash_table_lookup_extended (stock_hash, item->stock_id,
                                        &old_key, &old_value))
        {
          g_hash_table_remove (stock_hash, old_key);
124 125
	  if (((GtkStockItem *)old_value)->modifier & NON_STATIC_MASK)
	    gtk_stock_item_free (old_value);
126 127 128 129 130 131 132 133 134
        }
      
      g_hash_table_insert (stock_hash,
                           (gchar*)item->stock_id, (GtkStockItem*)item);

      ++i;
    }
}

135 136
/**
 * gtk_stock_add:
137
 * @items: (array length=n_items): a #GtkStockItem or array of items
138 139 140 141 142 143 144 145
 * @n_items: number of #GtkStockItem in @items
 *
 * Registers each of the stock items in @items. If an item already
 * exists with the same stock ID as one of the @items, the old item
 * gets replaced. The stock items are copied, so GTK+ does not hold
 * any pointer into @items and @items can be freed. Use
 * gtk_stock_add_static() if @items is persistent and GTK+ need not
 * copy the array.
146 147
 *
 * Deprecated: 3.10
148
 **/
149 150 151 152 153 154
void
gtk_stock_add (const GtkStockItem *items,
               guint               n_items)
{
  g_return_if_fail (items != NULL);

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 162
 * @n_items: number of items
 *
163
 * Same as gtk_stock_add(), but doesn’t copy @items, so
164
 * @items must persist until application exit.
165 166
 *
 * Deprecated: 3.10
167
 **/
168 169 170 171 172 173
void
gtk_stock_add_static (const GtkStockItem *items,
                      guint               n_items)
{
  g_return_if_fail (items != NULL);

174
  real_add (items, n_items, FALSE, FALSE);
175 176
}

177 178 179
/**
 * gtk_stock_lookup:
 * @stock_id: a stock item name
180
 * @item: (out): stock item to initialize with values
181
 *
182 183
 * Fills @item with the registered values for @stock_id, returning %TRUE
 * if @stock_id was known.
184
 *
185
 * Returns: %TRUE if @item was initialized
186 187
 *
 * Deprecated: 3.10
188
 **/
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
gboolean
gtk_stock_lookup (const gchar  *stock_id,
                  GtkStockItem *item)
{
  const GtkStockItem *found;

  g_return_val_if_fail (stock_id != NULL, FALSE);
  g_return_val_if_fail (item != NULL, FALSE);

  init_stock_hash ();

  found = g_hash_table_lookup (stock_hash, stock_id);

  if (found)
    {
      *item = *found;
205
      item->modifier &= ~NON_STATIC_MASK;
206
      if (item->label)
207 208
	{
	  GtkStockTranslateFunc *translate;
209 210 211 212 213 214
	  
	  if (item->translation_domain)
	    translate = (GtkStockTranslateFunc *) 
	      g_hash_table_lookup (translate_hash, item->translation_domain);
	  else
	    translate = NULL;
215 216 217 218
	  
	  if (translate != NULL && translate->func != NULL)
	    item->label = (* translate->func) (item->label, translate->data);
	  else
219
	    item->label = (gchar *) g_dgettext (item->translation_domain, item->label);
220
	}
221 222 223 224 225
    }

  return found != NULL;
}

226
/**
227
 * gtk_stock_list_ids:
228
 * 
229 230 231
 * Retrieves a list of all known stock IDs added to a #GtkIconFactory
 * or registered with gtk_stock_add(). The list must be freed with g_slist_free(),
 * and each string in the list must be freed with g_free().
232
 *
233
 * Returns: (element-type utf8) (transfer full): a list of known stock IDs
234 235
 *
 * Deprecated: 3.10
236
 **/
237 238
GSList*
gtk_stock_list_ids (void)
239
{
240 241
  GList *ids;
  GList *icon_ids;
242 243 244
  GSList *retval;
  const gchar *last_id;
  
245 246
  init_stock_hash ();

247 248
  ids = g_hash_table_get_keys (stock_hash);
  icon_ids = _gtk_icon_factory_list_ids ();
249
  ids = g_list_concat (ids, icon_ids);
250

251
  ids = g_list_sort (ids, (GCompareFunc)strcmp);
252 253 254

  last_id = NULL;
  retval = NULL;
255
  while (ids != NULL)
256
    {
257
      GList *next;
258

259
      next = ids->next;
260

261
      if (last_id && strcmp (ids->data, last_id) == 0)
262 263 264 265 266
        {
          /* duplicate, ignore */
        }
      else
        {
267 268
          retval = g_slist_prepend (retval, g_strdup (ids->data));
          last_id = ids->data;
269 270
        }

271
      g_list_free_1 (ids);
272

273
      ids = next;
274 275 276
    }

  return retval;
277 278
}

279
/**
280
 * gtk_stock_item_copy: (skip)
281 282 283 284
 * @item: a #GtkStockItem
 * 
 * Copies a stock item, mostly useful for language bindings and not in applications.
 * 
285
 * Returns: a new #GtkStockItem
286 287
 *
 * Deprecated: 3.10
288
 **/
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
GtkStockItem *
gtk_stock_item_copy (const GtkStockItem *item)
{
  GtkStockItem *copy;

  g_return_val_if_fail (item != NULL, NULL);

  copy = g_new (GtkStockItem, 1);

  *copy = *item;

  copy->stock_id = g_strdup (item->stock_id);
  copy->label = g_strdup (item->label);
  copy->translation_domain = g_strdup (item->translation_domain);

  return copy;
}

307 308 309 310 311 312 313
/**
 * gtk_stock_item_free:
 * @item: a #GtkStockItem
 *
 * Frees a stock item allocated on the heap, such as one returned by
 * gtk_stock_item_copy(). Also frees the fields inside the stock item,
 * if they are not %NULL.
314 315
 *
 * Deprecated: 3.10
316
 **/
317 318 319 320 321 322 323 324 325 326 327 328
void
gtk_stock_item_free (GtkStockItem *item)
{
  g_return_if_fail (item != NULL);

  g_free ((gchar*)item->stock_id);
  g_free ((gchar*)item->label);
  g_free ((gchar*)item->translation_domain);

  g_free (item);
}

329
static const GtkStockItem builtin_items [] =
330
{
331
  /* KEEP IN SYNC with gtkiconfactory.c stock icons, when appropriate */ 
332
 
Matthias Clasen's avatar
Matthias Clasen committed
333 334 335 336
  { GTK_STOCK_DIALOG_INFO, NC_("Stock label", "Information"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_DIALOG_WARNING, NC_("Stock label", "Warning"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_DIALOG_ERROR, NC_("Stock label", "Error"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_DIALOG_QUESTION, NC_("Stock label", "Question"), 0, 0, GETTEXT_PACKAGE },
337

338 339 340
  /*  FIXME these need accelerators when appropriate, and
   * need the mnemonics to be rationalized
   */
Matthias Clasen's avatar
Matthias Clasen committed
341 342 343 344 345
  { GTK_STOCK_ABOUT, NC_("Stock label", "_About"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_ADD, NC_("Stock label", "_Add"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_APPLY, NC_("Stock label", "_Apply"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_BOLD, NC_("Stock label", "_Bold"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_CANCEL, NC_("Stock label", "_Cancel"), 0, 0, GETTEXT_PACKAGE },
346
  { GTK_STOCK_CDROM, NC_("Stock label", "_CD-ROM"), 0, 0, GETTEXT_PACKAGE },
Matthias Clasen's avatar
Matthias Clasen committed
347
  { GTK_STOCK_CLEAR, NC_("Stock label", "_Clear"), 0, 0, GETTEXT_PACKAGE },
348
  { GTK_STOCK_CLOSE, NC_("Stock label", "_Close"), PRIMARY_MODIFIER, 'w', GETTEXT_PACKAGE },
Matthias Clasen's avatar
Matthias Clasen committed
349 350
  { GTK_STOCK_CONNECT, NC_("Stock label", "C_onnect"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_CONVERT, NC_("Stock label", "_Convert"), 0, 0, GETTEXT_PACKAGE },
351 352
   { GTK_STOCK_COPY, NC_("Stock label", "_Copy"), PRIMARY_MODIFIER, 'c', GETTEXT_PACKAGE },
  { GTK_STOCK_CUT, NC_("Stock label", "Cu_t"), PRIMARY_MODIFIER, 'x', GETTEXT_PACKAGE },
Matthias Clasen's avatar
Matthias Clasen committed
353 354 355 356 357
  { GTK_STOCK_DELETE, NC_("Stock label", "_Delete"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_DISCARD, NC_("Stock label", "_Discard"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_DISCONNECT, NC_("Stock label", "_Disconnect"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_EXECUTE, NC_("Stock label", "_Execute"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_EDIT, NC_("Stock label", "_Edit"), 0, 0, GETTEXT_PACKAGE },
358
  { GTK_STOCK_FILE, NC_("Stock label", "_File"), 0, 0, GETTEXT_PACKAGE },
359 360
  { GTK_STOCK_FIND, NC_("Stock label", "_Find"), PRIMARY_MODIFIER, 'f', GETTEXT_PACKAGE },
  { GTK_STOCK_FIND_AND_REPLACE, NC_("Stock label", "Find and _Replace"), PRIMARY_MODIFIER, 'r', GETTEXT_PACKAGE },
Matthias Clasen's avatar
Matthias Clasen committed
361 362 363 364
  { GTK_STOCK_FLOPPY, NC_("Stock label", "_Floppy"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_FULLSCREEN, NC_("Stock label", "_Fullscreen"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_LEAVE_FULLSCREEN, NC_("Stock label", "_Leave Fullscreen"), 0, 0, GETTEXT_PACKAGE },
  /* This is a navigation label as in "go to the bottom of the page" */
365
  { GTK_STOCK_GOTO_BOTTOM, NC_("Stock label, navigation", "_Bottom"), 0, 0, GETTEXT_PACKAGE "-navigation" },
Matthias Clasen's avatar
Matthias Clasen committed
366
  /* This is a navigation label as in "go to the first page" */
367
  { GTK_STOCK_GOTO_FIRST, NC_("Stock label, navigation", "_First"), 0, 0, GETTEXT_PACKAGE "-navigation" },
Matthias Clasen's avatar
Matthias Clasen committed
368
  /* This is a navigation label as in "go to the last page" */
369
  { GTK_STOCK_GOTO_LAST, NC_("Stock label, navigation", "_Last"), 0, 0, GETTEXT_PACKAGE "-navigation" },
Matthias Clasen's avatar
Matthias Clasen committed
370
  /* This is a navigation label as in "go to the top of the page" */
371
  { GTK_STOCK_GOTO_TOP, NC_("Stock label, navigation", "_Top"), 0, 0, GETTEXT_PACKAGE "-navigation" },
Matthias Clasen's avatar
Matthias Clasen committed
372
  /* This is a navigation label as in "go back" */
373
  { GTK_STOCK_GO_BACK, NC_("Stock label, navigation", "_Back"), 0, 0, GETTEXT_PACKAGE "-navigation" },
Matthias Clasen's avatar
Matthias Clasen committed
374
  /* This is a navigation label as in "go down" */
375
  { GTK_STOCK_GO_DOWN, NC_("Stock label, navigation", "_Down"), 0, 0, GETTEXT_PACKAGE "-navigation" },
Matthias Clasen's avatar
Matthias Clasen committed
376
  /* This is a navigation label as in "go forward" */
377
  { GTK_STOCK_GO_FORWARD, NC_("Stock label, navigation", "_Forward"), 0, 0, GETTEXT_PACKAGE "-navigation" },
Matthias Clasen's avatar
Matthias Clasen committed
378
  /* This is a navigation label as in "go up" */
379
  { GTK_STOCK_GO_UP, NC_("Stock label, navigation", "_Up"), 0, 0, GETTEXT_PACKAGE "-navigation" },
380
  { GTK_STOCK_HARDDISK, NC_("Stock label", "_Hard Disk"), 0, 0, GETTEXT_PACKAGE },
381
  { GTK_STOCK_HELP, NC_("Stock label", "_Help"), 0, GDK_KEY_F1, GETTEXT_PACKAGE },
Matthias Clasen's avatar
Matthias Clasen committed
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
  { GTK_STOCK_HOME, NC_("Stock label", "_Home"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_INDENT, NC_("Stock label", "Increase Indent"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_UNINDENT, NC_("Stock label", "Decrease Indent"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_INDEX, NC_("Stock label", "_Index"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_INFO, NC_("Stock label", "_Information"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_ITALIC, NC_("Stock label", "_Italic"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_JUMP_TO, NC_("Stock label", "_Jump to"), 0, 0, GETTEXT_PACKAGE },
  /* This is about text justification, "centered text" */
  { GTK_STOCK_JUSTIFY_CENTER, NC_("Stock label", "_Center"), 0, 0, GETTEXT_PACKAGE },
  /* This is about text justification */
  { GTK_STOCK_JUSTIFY_FILL, NC_("Stock label", "_Fill"), 0, 0, GETTEXT_PACKAGE },
  /* This is about text justification, "left-justified text" */
  { GTK_STOCK_JUSTIFY_LEFT, NC_("Stock label", "_Left"), 0, 0, GETTEXT_PACKAGE },
  /* This is about text justification, "right-justified text" */
  { GTK_STOCK_JUSTIFY_RIGHT, NC_("Stock label", "_Right"), 0, 0, GETTEXT_PACKAGE },

  /* Media label, as in "fast forward" */
399
  { GTK_STOCK_MEDIA_FORWARD, NC_("Stock label, media", "_Forward"), 0, 0, GETTEXT_PACKAGE "-media" },
Matthias Clasen's avatar
Matthias Clasen committed
400
  /* Media label, as in "next song" */
401
  { GTK_STOCK_MEDIA_NEXT, NC_("Stock label, media", "_Next"), 0, 0, GETTEXT_PACKAGE "-media" },
Matthias Clasen's avatar
Matthias Clasen committed
402
  /* Media label, as in "pause music" */
403
  { GTK_STOCK_MEDIA_PAUSE, NC_("Stock label, media", "P_ause"), 0, 0, GETTEXT_PACKAGE "-media" },
Matthias Clasen's avatar
Matthias Clasen committed
404
  /* Media label, as in "play music" */
405
  { GTK_STOCK_MEDIA_PLAY, NC_("Stock label, media", "_Play"), 0, 0, GETTEXT_PACKAGE "-media" },
Matthias Clasen's avatar
Matthias Clasen committed
406
  /* Media label, as in  "previous song" */
407
  { GTK_STOCK_MEDIA_PREVIOUS, NC_("Stock label, media", "Pre_vious"), 0, 0, GETTEXT_PACKAGE "-media" },
Matthias Clasen's avatar
Matthias Clasen committed
408
  /* Media label */
409
  { GTK_STOCK_MEDIA_RECORD, NC_("Stock label, media", "_Record"), 0, 0, GETTEXT_PACKAGE "-media" },
Matthias Clasen's avatar
Matthias Clasen committed
410
  /* Media label */
411
  { GTK_STOCK_MEDIA_REWIND, NC_("Stock label, media", "R_ewind"), 0, 0, GETTEXT_PACKAGE "-media" },
Matthias Clasen's avatar
Matthias Clasen committed
412
  /* Media label */
413
  { GTK_STOCK_MEDIA_STOP, NC_("Stock label, media", "_Stop"), 0, 0, GETTEXT_PACKAGE "-media" },
Matthias Clasen's avatar
Matthias Clasen committed
414
  { GTK_STOCK_NETWORK, NC_("Stock label", "_Network"), 0, 0, GETTEXT_PACKAGE },
415
  { GTK_STOCK_NEW, NC_("Stock label", "_New"), PRIMARY_MODIFIER, 'n', GETTEXT_PACKAGE },
Matthias Clasen's avatar
Matthias Clasen committed
416 417
  { GTK_STOCK_NO, NC_("Stock label", "_No"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_OK, NC_("Stock label", "_OK"), 0, 0, GETTEXT_PACKAGE },
418
  { GTK_STOCK_OPEN, NC_("Stock label", "_Open"), PRIMARY_MODIFIER, 'o', GETTEXT_PACKAGE },
Matthias Clasen's avatar
Matthias Clasen committed
419 420 421 422 423 424 425 426 427
  /* Page orientation */
  { GTK_STOCK_ORIENTATION_LANDSCAPE, NC_("Stock label", "Landscape"), 0, 0, GETTEXT_PACKAGE },
  /* Page orientation */
  { GTK_STOCK_ORIENTATION_PORTRAIT, NC_("Stock label", "Portrait"), 0, 0, GETTEXT_PACKAGE },
  /* Page orientation */
  { GTK_STOCK_ORIENTATION_REVERSE_LANDSCAPE, NC_("Stock label", "Reverse landscape"), 0, 0, GETTEXT_PACKAGE },
  /* Page orientation */
  { GTK_STOCK_ORIENTATION_REVERSE_PORTRAIT, NC_("Stock label", "Reverse portrait"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_PAGE_SETUP, NC_("Stock label", "Page Set_up"), 0, 0, GETTEXT_PACKAGE },
428
  { GTK_STOCK_PASTE, NC_("Stock label", "_Paste"), PRIMARY_MODIFIER, 'v', GETTEXT_PACKAGE },
Matthias Clasen's avatar
Matthias Clasen committed
429 430 431 432
  { GTK_STOCK_PREFERENCES, NC_("Stock label", "_Preferences"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_PRINT, NC_("Stock label", "_Print"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_PRINT_PREVIEW, NC_("Stock label", "Print Pre_view"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_PROPERTIES, NC_("Stock label", "_Properties"), 0, 0, GETTEXT_PACKAGE },
433
  { GTK_STOCK_QUIT, NC_("Stock label", "_Quit"), PRIMARY_MODIFIER, 'q', GETTEXT_PACKAGE },
Matthias Clasen's avatar
Matthias Clasen committed
434 435 436 437
  { GTK_STOCK_REDO, NC_("Stock label", "_Redo"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_REFRESH, NC_("Stock label", "_Refresh"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_REMOVE, NC_("Stock label", "_Remove"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_REVERT_TO_SAVED, NC_("Stock label", "_Revert"), 0, 0, GETTEXT_PACKAGE },
438
  { GTK_STOCK_SAVE, NC_("Stock label", "_Save"), PRIMARY_MODIFIER, 's', GETTEXT_PACKAGE },
Matthias Clasen's avatar
Matthias Clasen committed
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
  { GTK_STOCK_SAVE_AS, NC_("Stock label", "Save _As"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_SELECT_ALL, NC_("Stock label", "Select _All"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_SELECT_COLOR, NC_("Stock label", "_Color"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_SELECT_FONT, NC_("Stock label", "_Font"), 0, 0, GETTEXT_PACKAGE },
  /* Sorting direction */
  { GTK_STOCK_SORT_ASCENDING, NC_("Stock label", "_Ascending"), 0, 0, GETTEXT_PACKAGE },
  /* Sorting direction */
  { GTK_STOCK_SORT_DESCENDING, NC_("Stock label", "_Descending"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_SPELL_CHECK, NC_("Stock label", "_Spell Check"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_STOP, NC_("Stock label", "_Stop"), 0, 0, GETTEXT_PACKAGE },
  /* Font variant */
  { GTK_STOCK_STRIKETHROUGH, NC_("Stock label", "_Strikethrough"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_UNDELETE, NC_("Stock label", "_Undelete"), 0, 0, GETTEXT_PACKAGE },
  /* Font variant */
  { GTK_STOCK_UNDERLINE, NC_("Stock label", "_Underline"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_UNDO, NC_("Stock label", "_Undo"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_YES, NC_("Stock label", "_Yes"), 0, 0, GETTEXT_PACKAGE },
  /* Zoom */
  { GTK_STOCK_ZOOM_100, NC_("Stock label", "_Normal Size"), 0, 0, GETTEXT_PACKAGE },
  /* Zoom */
  { GTK_STOCK_ZOOM_FIT, NC_("Stock label", "Best _Fit"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_ZOOM_IN, NC_("Stock label", "Zoom _In"), 0, 0, GETTEXT_PACKAGE },
  { GTK_STOCK_ZOOM_OUT, NC_("Stock label", "Zoom _Out"), 0, 0, GETTEXT_PACKAGE }
462 463
};

464 465
/**
 * gtk_stock_set_translate_func: 
466
 * @domain: the translation domain for which @func shall be used
467 468
 * @func: a #GtkTranslateFunc 
 * @data: data to pass to @func
469
 * @notify: a #GDestroyNotify that is called when @data is
470 471 472 473
 *   no longer needed
 *
 * Sets a function to be used for translating the @label of 
 * a stock item.
474
 * 
475
 * If no function is registered for a translation domain,
476
 * g_dgettext() is used.
477 478 479 480 481 482 483
 * 
 * The function is used for all stock items whose
 * @translation_domain matches @domain. Note that it is possible
 * to use strings different from the actual gettext translation domain
 * of your application for this, as long as your #GtkTranslateFunc uses
 * the correct domain when calling dgettext(). This can be useful, e.g.
 * when dealing with message contexts:
484
 *
485
 * |[<!-- language="C" -->
486 487 488 489 490 491 492 493 494 495
 * GtkStockItem items[] = { 
 *  { MY_ITEM1, NC_("odd items", "Item 1"), 0, 0, "odd-item-domain" },
 *  { MY_ITEM2, NC_("even items", "Item 2"), 0, 0, "even-item-domain" },
 * };
 *
 * gchar *
 * my_translate_func (const gchar *msgid,
 *                    gpointer     data)
 * {
 *   gchar *msgctxt = data;
496
 * 
497 498 499
 *   return (gchar*)g_dpgettext2 (GETTEXT_PACKAGE, msgctxt, msgid);
 * }
 *
500
 * ...
501 502
 *
 * gtk_stock_add (items, G_N_ELEMENTS (items));
Matthias Clasen's avatar
Matthias Clasen committed
503 504
 * gtk_stock_set_translate_func ("odd-item-domain", my_translate_func, "odd items"); 
 * gtk_stock_set_translate_func ("even-item-domain", my_translate_func, "even items"); 
505 506 507
 * ]|
 * 
 * Since: 2.8
508 509
 *
 * Deprecated: 3.10
510 511 512 513 514
 */
void
gtk_stock_set_translate_func (const gchar      *domain,
			      GtkTranslateFunc  func,
			      gpointer          data,
515
			      GDestroyNotify    notify)
516 517
{
  GtkStockTranslateFunc *translate;
Manish Singh's avatar
Manish Singh committed
518 519 520 521
  gchar *domainname;
 
  domainname = g_strdup (domain);

522
  translate = (GtkStockTranslateFunc *) 
Manish Singh's avatar
Manish Singh committed
523
    g_hash_table_lookup (translate_hash, domainname);
524 525 526 527 528 529 530 531 532 533 534 535 536

  if (translate)
    {
      if (translate->notify)
	(* translate->notify) (translate->data);
    }
  else
    translate = g_new0 (GtkStockTranslateFunc, 1);
    
  translate->func = func;
  translate->data = data;
  translate->notify = notify;
      
Manish Singh's avatar
Manish Singh committed
537
  g_hash_table_insert (translate_hash, domainname, translate);
538 539 540 541
}

static gchar *
sgettext_swapped (const gchar *msgid, 
Manish Singh's avatar
Manish Singh committed
542
		  gpointer     data)
543
{
544
  gchar *msgctxt = data;
545

546
  return (gchar *)g_dpgettext2 (GETTEXT_PACKAGE, msgctxt, msgid);
547 548
}

549 550 551 552 553 554 555
static void
init_stock_hash (void)
{
  if (stock_hash == NULL)
    {
      stock_hash = g_hash_table_new (g_str_hash, g_str_equal);

556
      real_add (builtin_items, G_N_ELEMENTS (builtin_items), FALSE, TRUE);
557
    }
558 559 560

  if (translate_hash == NULL)
    {
Manish Singh's avatar
Manish Singh committed
561 562
      translate_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
	                                      g_free, NULL);
563 564 565

      gtk_stock_set_translate_func (GETTEXT_PACKAGE, 
				    sgettext_swapped,
566
				    "Stock label",
567
				    NULL);
568
      gtk_stock_set_translate_func (GETTEXT_PACKAGE "-navigation", 
569 570
				    sgettext_swapped,
				    "Stock label, navigation",
571 572
				    NULL);
      gtk_stock_set_translate_func (GETTEXT_PACKAGE "-media", 
573 574
				    sgettext_swapped,
				    "Stock label, media",
575
				    NULL);
576
    }
577
}