changeset 21252:d275275a011c

Missing changelog entries and @since tags from 3f567df17490f68b4feb8cf26ad004a34eb7cc9a.

--- a/ChangeLog	Tue Oct 16 11:04:09 2007 +0000
+++ b/ChangeLog	Tue Oct 16 11:05:59 2007 +0000
@@ -20,6 +20,8 @@
 	  remove the plugin from the list of saved plugins so it won't load
 	  at the next startup.  Previously, we were ignoring this case, which
 	  could lead to crashes.
+	* It's possible to bind key-strokes to specific menuitems in the windows.
+	  Read the 'Menus' section in the man-page for details.
 
 version 2.2.2:
 	http://developer.pidgin.im/query?status=closed&milestone=2.2.2

--- a/ChangeLog.API	Tue Oct 16 11:04:09 2007 +0000
+++ b/ChangeLog.API	Tue Oct 16 11:05:59 2007 +0000
@@ -98,6 +98,12 @@
 		  attributes in place of colors if the terminal doesn't have color
 		  support. (Bug: #3560) All future code should use gnt_color_pair
 		  instead of COLOR_PAIR.
+		* Added gnt_menuitem_set_id and gnt_menuitem_get_id to set and get the
+		  string id of a menuitem respectively.
+		* Added gnt_window_get_accel_item, which returns a the id of a menuitem
+		  bound to a keystroke.
+		* Added gnt_menu_get_item to activate and return a menuitem of the
+		  given id from a menu.
 
 version 2.2.2 (??/??/????):
 	libpurple:

--- a/finch/libgnt/gntmenu.h	Tue Oct 16 11:04:09 2007 +0000
+++ b/finch/libgnt/gntmenu.h	Tue Oct 16 11:05:59 2007 +0000
@@ -108,12 +108,14 @@
 void gnt_menu_add_item(GntMenu *menu, GntMenuItem *item);
 
 /**
- * Get the GntMenuItem with the given ID.
+ * Activate and return the GntMenuItem with the given ID.
  *
  * @param menu   The menu.
  * @param id     The ID for an item.
  *
  * @return  The menuitem with the given ID, or @c NULL.
+ *
+ * @since 2.3.0
  */
 GntMenuItem *gnt_menu_get_item(GntMenu *menu, const char *id);
 

--- a/finch/libgnt/gntmenuitem.h	Tue Oct 16 11:04:09 2007 +0000
+++ b/finch/libgnt/gntmenuitem.h	Tue Oct 16 11:05:59 2007 +0000
@@ -123,6 +123,8 @@
  * @param item   The menuitem.
  *
  * @return  The submenu, or @c NULL.
+ *
+ * @since 2.3.0
  */
 GntMenu *gnt_menuitem_get_submenu(GntMenuItem *item);
 
@@ -150,6 +152,8 @@
  *
  * @param item   The menuitem.
  * @param id     The ID for the menuitem.
+ *
+ * @since 2.3.0
  */
 void gnt_menuitem_set_id(GntMenuItem *item, const char *id);
 
@@ -159,6 +163,8 @@
  * @param item   The menuitem.
  *
  * @return  The ID for the menuitem.
+ *
+ * @since 2.3.0
  */
 const char * gnt_menuitem_get_id(GntMenuItem *item);
 

--- a/finch/libgnt/gntwindow.h	Tue Oct 16 11:04:09 2007 +0000
+++ b/finch/libgnt/gntwindow.h	Tue Oct 16 11:05:59 2007 +0000
@@ -68,9 +68,7 @@
 G_BEGIN_DECLS
 
 /**
- * 
- *
- * @return
+ * @return  GType for GntWindow.
  */
 GType gnt_window_get_gtype(void);
 
@@ -78,28 +76,40 @@
 #define gnt_hwindow_new(homo) gnt_window_box_new(homo, FALSE)
 
 /**
- * 
+ * Create a new window.
  *
- * @return
+ * @return The newly created window.
  */
 GntWidget * gnt_window_new(void);
 
 /**
- * 
- * @param homo
- * @param vert
+ * Create a new window.
  *
- * @return
+ * @param homo  @c TRUE if the widgets inside the window should have the same dimensions.
+ * @param vert  @c TRUE if the widgets inside the window should be stacked vertically.
+ *
+ * @return  The newly created window.
  */
 GntWidget * gnt_window_box_new(gboolean homo, gboolean vert);
 
 /**
- * 
- * @param window
- * @param menu
+ * Set the menu for a window.
+ *
+ * @param window  The window.
+ * @param menu    The menu for the window.
  */
 void gnt_window_set_menu(GntWindow *window, GntMenu *menu);
 
+/**
+ * Return the id of a menuitem specified to a keystroke.
+ *
+ * @param window    The window.
+ * @param key       The keystroke.
+ *
+ * @return The id of the menuitem bound to the keystroke, or @c NULL.
+ *
+ * @since 2.3.0
+ */
 const char * gnt_window_get_accel_item(GntWindow *window, const char *key);
 
 void gnt_window_workspace_hiding(GntWindow *);