<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-gtkrecentchooserdialog">

  <refnamediv>
    <refname>gtk.RecentChooserDialog</refname>
      <refpurpose>Displays recently used files in a dialog (new in PyGTK
      2.10)</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.RecentChooserDialog</classname></ooclass>
      <ooclass><classname><link linkend="class-gtkdialog">gtk.Dialog</link></classname></ooclass>
      <ooclass><classname><link linkend="class-gtkrecentchooser">gtk.RecentChooser</link></classname></ooclass>
      <constructorsynopsis language="python">
        <methodname><link linkend="constructor-gtkrecentchooserdialog">gtk.RecentChooserDialog</link></methodname>
        <methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
        <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
        <methodparam><parameter role="keyword">manager</parameter><initializer>None</initializer></methodparam>
        <methodparam><parameter role="keyword">buttons</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis>
</classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkwidget">gtk.Widget</link>
      +-- <link linkend="class-gtkcontainer">gtk.Container</link>
        +-- <link linkend="class-gtkbin">gtk.Bin</link>
          +-- <link linkend="class-gtkwindow">gtk.Window</link>
            +-- <link linkend="class-gtkdialog">gtk.Dialog</link>
              +-- <link linkend="class-gtkrecentchooserdialog">gtk.RecentChooserDialog</link>
</synopsis>

  </refsect1>
  
  <refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link>
			implements 
			<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
            <link linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>
		</para>
	</refsect1>


  <refsect1 id="properties-gtkrecentchooserdialog">
    <title>gtk.RecentChooserDialog Properties</title>

    <para><link linkend="properties-gtkrecentchooser">gtk.RecentChooser Properties</link></para>
    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
    <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
    <para><link linkend="properties-gtkwindow">gtk.Window Properties</link></para>
    <para><link linkend="properties-gtkdialog">gtk.Dialog Properties</link></para>

  </refsect1>

  <refsect1 id="style-properties-gtkrecentchooserdialog">
    <title>gtk.RecentChooserDialog Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
    <para><link linkend="style-properties-gtkdialog">gtk.Dialog Style Properties</link></para>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkrecentchooserdialog">
    <title>gtk.RecentChooserDialog Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwindow">gtk.Window Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkdialog">gtk.Dialog Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkrecentchooser">gtk.RecentChooser Signal Prototypes</link></para>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <para><link
    linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link>
    is a dialog box suitable for displaying the recently used documents.
    This widgets works by putting a <link
    linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>
    inside a <link
    linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>.  It
    exposes the <link
    linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>
    interface, so you can use all the <link
    linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>
    methods on the recent chooser dialog as well as those for <link
    linkend="class-gtkdialog"><classname>gtk.Dialog</classname></link>.</para>

    <para>Note that <link
    linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link>
    does not have any methods of its own.  Instead, you should use the
    methods that work on a <link
    linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>.</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 <link
      linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link>
      to select a recently used file:</para>

  <programlisting>
  dialog = gtk.RecentChooserDialog("Recent Documents", parent_window, None,
			           (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL,
				    gtk.STOCK_OPEN, gtk.RESPONSE_ACCEPT))
					
  if dialog.run() == gtk.RESPONSE_ACCEPT:
    info = dialog.get_current_item ()
    open_file(info.get_uri())
  dialog.destroy()
  </programlisting>
    </example>

    <para>Recently used files are supported since GTK+ 2.10.</para>

  </refsect1>

  <refsect1>
    <title>Constructor</title>

    <refsect2 id="constructor-gtkrecentchooserdialog">
      <title>gtk.RecentChooserDialog</title>

      <programlisting><constructorsynopsis language="python">
        <methodname>gtk.RecentChooserDialog</methodname>
        <methodparam><parameter role="keyword">title</parameter><initializer>None</initializer></methodparam>
        <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
        <methodparam><parameter role="keyword">manager</parameter><initializer>None</initializer></methodparam>
        <methodparam><parameter role="keyword">buttons</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">title</parameter>&nbsp;:</term>
          <listitem><simpara>Title of the dialog, or
          <literal>None</literal></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">parent</parameter>&nbsp;:</term>
          <listitem><simpara>Transient parent of the dialog, or
          <literal>None</literal>,</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">manager</parameter>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>,
          or <literal>None</literal>,</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">buttons</parameter>&nbsp;:</term>
          <listitem><simpara>a sequence of text-response
          pairs</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a new <link
          linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This constructor is available in PyGTK 2.10 and above.</para>
      </note>

      <para>Creates a new <link
      linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link>
      with the title text specified by <parameter>title</parameter> (or
      <literal>None</literal> for the default title; see <link
      linkend="method-gtkwindow--set-title"><methodname>gtk.Window.set_title</methodname>()</link>)
      and transient parent window specified by <parameter>parent</parameter>
      (or <literal>None</literal> for none; see <link
      linkend="method-gtkwindow--set-transient-for"><methodname>gtk.Window.set_transient_for</methodname>()</link>).
      <parameter>manager</parameter> specifies a <link
      linkend="class-gtkrecentmanager"><classname>gtk.RecentManager</classname></link>
      object (or <literal>None</literal>). <parameter>buttons</parameter> is
      a sequence of button text/response ID pairs should be listed, or
      <literal>None</literal> (the default value) if no buttons are
      needed. The button text can be either a stock ID such as
      <literal>gtk.STOCK_OK</literal>, or some arbitrary text.  A response
      ID can be any positive number, or one of the pre-defined <xref
      linkend="gtk-response-type-constants"
      endterm="gtk-response-type-constants-title"></xref>. This constructor
      is analogous to <link
      linkend="constructor-gtkdialog"><methodname>gtk.Dialog</methodname></link>.</para>

    </refsect2>

  </refsect1>

</refentry>
