Add a note to the docs about how to use this in the context of changeable

Sat Mar  2 20:39:38 2002  Owen Taylor  <otaylor@redhat.com>

        * gtk/gtkimagemenuitem.c (gtk_image_menu_item_new_from_stock):
        Add a note to the docs about how to use this in the
        context of changeable accelerators. (#72382, Mark Patton)

1 files changed, 8 insertions, 1 deletions

diff --git a/gtk/gtkimagemenuitem.c b/gtk/gtkimagemenuitem.c
index 19f8f41014..a51ccf0248 100644
--- a/gtk/gtkimagemenuitem.c
+++ b/gtk/gtkimagemenuitem.c
@@ -350,12 +350,19 @@ gtk_image_menu_item_new_with_mnemonic (const gchar *label)
 /**
  * gtk_image_menu_item_new_from_stock:
  * @stock_id: the name of the stock item.
- * @accel_group: the #GtkAccelGroup to add the menu items accelerator to.
+ * @accel_group: the #GtkAccelGroup to add the menu items accelerator to,
+ *   or %NULL.
  * @returns: a new #GtkImageMenuItem.
  *
  * Creates a new #GtkImageMenuItem containing the image and text from a 
  * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK 
  * and #GTK_STOCK_APPLY.
+ *
+ * If you want this menu item to have changeable accelerators, then
+ * pass in %NULL for @accel_group call gtk_menu_item_set_accel_path()
+ * with an appropriate path for the menu item, then use gtk_stock_lookup()
+ * too look up the standard accelerator for the stock item and
+ * if one is found, call gtk_accel_map_add_entry() to register it.
  **/
 GtkWidget*
 gtk_image_menu_item_new_from_stock (const gchar      *stock_id,