[gtk+] Move documentation to inline comments: GtkRecentChooserMenu
- From: Javier Jardón <jjardon src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] Move documentation to inline comments: GtkRecentChooserMenu
- Date: Fri, 21 May 2010 02:15:52 +0000 (UTC)
commit 98cee5e6e27482a31396fb6d11f7e2888dfbf7b5
Author: Javier Jardón <jjardon gnome org>
Date: Fri May 21 03:19:02 2010 +0200
Move documentation to inline comments: GtkRecentChooserMenu
docs/reference/gtk/tmpl/.gitignore | 1 +
docs/reference/gtk/tmpl/gtkrecentchoosermenu.sgml | 92 ---------------------
gtk/gtkrecentchoosermenu.c | 28 ++++++
3 files changed, 29 insertions(+), 92 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index f298ba4..d602664 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -12,6 +12,7 @@ gtkradiobutton.sgml
gtkrange.sgml
gtkrecentaction.sgml
gtkrecentchooser.sgml
+gtkrecentchoosermenu.sgml
gtkrecentchooserwidget.sgml
gtkscalebutton.sgml
gtkseparator.sgml
diff --git a/gtk/gtkrecentchoosermenu.c b/gtk/gtkrecentchoosermenu.c
index 1dd2ac2..f77643b 100644
--- a/gtk/gtkrecentchoosermenu.c
+++ b/gtk/gtkrecentchoosermenu.c
@@ -47,6 +47,34 @@
#include "gtkprivate.h"
#include "gtkalias.h"
+
+/**
+ * SECTION:gtkrecentchoosermenu
+ * @Short_description: Displays recently used files in a menu
+ * @Title: GtkRecentChooserMenu
+ * @See_also:#GtkRecentChooser
+ *
+ * #GtkRecentChooserMenu is a widget suitable for displaying recently used files
+ * inside a menu. It can be used to set a sub-menu of a #GtkMenuItem using
+ * gtk_menu_item_set_submenu(), or as the menu of a #GtkMenuToolButton.
+ *
+ * Note that #GtkRecentChooserMenu does not have any methods of its own. Instead,
+ * you should use the functions that work on a #GtkRecentChooser.
+ *
+ * Note also that #GtkRecentChooserMenu does not support multiple filters, as it
+ * has no way to let the user choose between them as the #GtkRecentChooserWidget
+ * and #GtkRecentChooserDialog widgets do. Thus using gtk_recent_chooser_add_filter()
+ * on a #GtkRecentChooserMenu widget will yield the same effects as using
+ * gtk_recent_chooser_set_filter(), replacing any currently set filter
+ * with the supplied filter; gtk_recent_chooser_remove_filter() will remove
+ * any currently set #GtkRecentFilter object and will unset the current filter;
+ * gtk_recent_chooser_list_filters() will return a list containing a single
+ * #GtkRecentFilter object.
+ *
+ * Recently used files are supported since GTK+ 2.10.
+ */
+
+
struct _GtkRecentChooserMenuPrivate
{
/* the recent manager object */
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]