[gtk+] Move documentation to inline comments: GtkFileChooserButton



commit 2da9a5791fd19b7c19f85274e9ce1c5aeae37827
Author: Javier Jardón <jjardon gnome org>
Date:   Wed Apr 13 20:46:31 2011 +0100

    Move documentation to inline comments: GtkFileChooserButton

 docs/reference/gtk/tmpl/.gitignore                |    1 +
 docs/reference/gtk/tmpl/gtkfilechooserbutton.sgml |  162 ---------------------
 gtk/gtkfilechooserbutton.c                        |   41 +++++
 3 files changed, 42 insertions(+), 162 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 409c0e8..7f59147 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -38,6 +38,7 @@ gtkeventbox.sgml
 gtkexpander.sgml
 gtkfeatures.sgml
 gtkfixed.sgml
+gtkfilechooserbutton.sgml
 gtkfilechooserwidget.sgml
 gtkfilefilter.sgml
 gtkfontbutton.sgml
diff --git a/gtk/gtkfilechooserbutton.c b/gtk/gtkfilechooserbutton.c
index c12ef91..7b74874 100644
--- a/gtk/gtkfilechooserbutton.c
+++ b/gtk/gtkfilechooserbutton.c
@@ -55,6 +55,47 @@
 #include "gtktypebuiltins.h"
 #include "gtkprivate.h"
 
+
+/**
+ * SECTION:gtkfilechooserbutton
+ * @Short_description: A button to launch a file selection dialog
+ * @Title: GtkFileChooserButton
+ * @See_also:#GtkFileChooserDialog
+ *
+ * The #GtkFileChooserButton is a widget that lets the user select a
+ * file.  It implements the #GtkFileChooser interface.  Visually, it is a
+ * file name with a button to bring up a #GtkFileChooserDialog.
+ * The user can then use that dialog to change the file associated with
+ * that button.  This widget does not support setting the
+ * #GtkFileChooser:select-multiple property to %TRUE.
+ *
+ * <example>
+ * <title>Create a button to let the user select a file in /etc</title>
+ * <programlisting>
+ * {
+ *   GtkWidget *button;
+ *
+ *   button = gtk_file_chooser_button_new (_("Select a file"),
+ *                                         GTK_FILE_CHOOSER_ACTION_OPEN);
+ *   gtk_file_chooser_set_current_folder (GTK_FILE_CHOOSER (button),
+ *                                        "/etc");
+ * }
+ * </programlisting>
+ * </example>
+ *
+ * The #GtkFileChooserButton supports the #GtkFileChooserAction<!-- -->s
+ * %GTK_FILE_CHOOSER_ACTION_OPEN and %GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER.
+ *
+ * <important>
+ * The #GtkFileChooserButton will ellipsize the label,
+ * and thus will thus request little horizontal space.  To give the button
+ * more space, you should call gtk_widget_get_preferred_size(),
+ * gtk_file_chooser_button_set_width_chars(), or pack the button in
+ * such a way that other interface elements give space to the widget.
+ * </important>
+ */
+
+
 /* **************** *
  *  Private Macros  *
  * **************** */



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]