gtk2/docs/reference/gtk/tmpl/gtkrecentchooserdialog.sgml
Emmanuele Bassi 237342c4ec Add long descriptions.
2006-04-17  Emmanuele Bassi  <ebassi@cvs.gnome.org>

	* gtk/tmpl/gtkrecent*.sgml: Add long descriptions.
2006-04-17 15:39:21 +00:00

94 lines
2.0 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GtkRecentChooserDialog
<!-- ##### SECTION Short_Description ##### -->
Displays recently used files in a dialog
<!-- ##### SECTION Long_Description ##### -->
<para>
#GtkRecentChooserDialog is a dialog box suitable for displaying the recently
used documents. This widgets works by putting a #GtkRecentChooserWidget inside
a #GtkDialog. It exposes the #GtkRecentChooserIface interface, so you can use
all the #GtkRecentChooser functions on the recent chooser dialog as well as
those for #GtkDialog.
</para>
<para>
Note that #GtkRecentChooserDialog does not have any methods of its own.
Instead, you should use the functions that work on a #GtkRecentChooser.
</para>
<example id="gtkrecentchooser-typical-usage">
<title>Typical usage</title>
<para>
In the simplest of cases, you can use the following code to use
a #GtkRecentChooserDialog to select a recently used file:
</para>
<programlisting>
GtkWidget *dialog;
dialog = gtk_recent_chooser_dialog_new ("Recent Documents",
parent_window,
GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
GTK_STOCK_OPEN, GTK_RESPONSE_ACCEPT,
NULL);
if (gtk_dialog_run (GTK_DIALOG (dialog)) == GTK_RESPONSE_ACCEPT)
{
GtkRecentInfo *info;
info = gtk_recent_chooser_get_current_item (GTK_RECENT_CHOOSER (dialog));
open_file (gtk_recent_info_get_uri (info));
gtk_recent_info_unref (info);
}
gtk_widget_destroy (dialog);
</programlisting>
</example>
<para>
Recently used files are supported since GTK+ 2.10.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkRecentChooser, #GtkDialog
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GtkRecentChooserDialog ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_recent_chooser_dialog_new ##### -->
<para>
</para>
@title:
@parent:
@first_button_text:
@Varargs:
@Returns:
<!-- ##### FUNCTION gtk_recent_chooser_dialog_new_for_manager ##### -->
<para>
</para>
@title:
@parent:
@manager:
@first_button_text:
@Varargs:
@Returns: