<?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-gtkrecentchooser">

  <refnamediv>
    <refname>gtk.RecentChooser</refname>
      <refpurpose>an interface implemented by <link
      linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>,
      <link
      linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link>
      and <link
      linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link> (new in PyGTK 2.10)
      </refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.RecentChooser</classname></ooclass>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--set-show-private">set_show_private</link></methodname>
        <methodparam><parameter role="keyword">show_private</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--get-show-private">get_show_private</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--set-show-not-found">set_show_not_found</link></methodname>
        <methodparam><parameter role="keyword">show_not_found</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--get-show-not-found">get_show_not_found</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--set-select-multiple">set_select_multiple</link></methodname>
        <methodparam><parameter role="keyword">select_multiple</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--get-select-multiple">get_select_multiple</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--set-limit">set_limit</link></methodname>
        <methodparam><parameter role="keyword">limit</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--get-limit">get_limit</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--set-local-only">set_local_only</link></methodname>
        <methodparam><parameter role="keyword">local_only</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--get-local-only">get_local_only</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--set-show-tips">set_show_tips</link></methodname>
        <methodparam><parameter role="keyword">show_tips</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--get-show-tips">get_show_tips</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--set-show-numbers">set_show_numbers</link></methodname>
        <methodparam><parameter role="keyword">show_numbers</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--get-show-numbers">get_show_numbers</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--set-show-icons">set_show_icons</link></methodname>
        <methodparam><parameter role="keyword">show_icons</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--get-show-icons">get_show_icons</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--set-sort-type">set_sort_type</link></methodname>
        <methodparam><parameter role="keyword">sort_type</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--get-sort-type">get_sort_type</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--set-sort-func">set_sort_func</link></methodname>
        <methodparam><parameter role="keyword">sort_func</parameter></methodparam>
        <methodparam><parameter role="keyword">sort_data</parameter><initializer>None</initializer></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--set-current-uri">set_current_uri</link></methodname>
        <methodparam><parameter role="keyword">uri</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--get-current-uri">get_current_uri</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--get-current-item">get_current_item</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--select-uri">select_uri</link></methodname>
        <methodparam><parameter role="keyword">uri</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--unselect-uri">unselect_uri</link></methodname>
        <methodparam><parameter role="keyword">uri</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--select-all">select_all</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--unselect-all">unselect_all</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--get-items">get_items</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--get-uris">get_uris</link></methodname>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--add-filter">add_filter</link></methodname>
        <methodparam><parameter role="keyword">filter</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--remove-filter">remove_filter</link></methodname>
        <methodparam><parameter role="keyword">filter</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--list-filters">list_filters</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--set-filter">set_filter</link></methodname>
        <methodparam><parameter role="keyword">filter</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkrecentchooser--get-filter">get_filter</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
</classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gtkrecentchooser">gtk.RecentChooser</link>
</synopsis>

  </refsect1>

  <refsect1 id="properties-gtkrecentchooser">
    <title>gtk.RecentChooser Properties</title>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
        <tgroup cols="3">
          <colspec column="1" colwidth="1in"/>
          <colspec column="2" colwidth="1in"/>
          <colspec column="3" colwidth="3.5in"/>
        <tbody>

        <row valign="top">
          <entry>"filter"</entry>
          <entry>Read-Write</entry>
          <entry>The current <link
          linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
          for selecting which resources are displayed</entry>
        </row>

        <row valign="top">
          <entry>"limit"</entry>
          <entry>Read-Write</entry>
          <entry>The maximum number of items to be displayed</entry>
        </row>

        <row valign="top">
          <entry>"local-only"</entry>
          <entry>Read-Write</entry>
          <entry>if <literal>True</literal> the selected resource(s) should
          be limited to local file: URIs</entry>
        </row>

        <row valign="top">
          <entry>"recent-manager"</entry>
          <entry>Write-Construct Only</entry>
          <entry>The RecentManager object to use</entry>
        </row>

        <row valign="top">
          <entry>"select-multiple"</entry>
          <entry>Read-Write</entry>
          <entry>if <literal>True</literal> allow multiple items to be
          selected</entry>
        </row>

        <row valign="top">
          <entry>"show-icons"</entry>
          <entry>Read-Write</entry>
          <entry>if <literal>True</literal> there should be an icon near the
          item</entry>
        </row>

        <row valign="top">
          <entry>"show-not-found"</entry>
          <entry>Read-Write</entry>
          <entry>if <literal>True</literal> the items pointing to
          unavailable resources should be displayed</entry>
        </row>

        <row valign="top">
          <entry>"show-private"</entry>
          <entry>Read-Write</entry>
          <entry>if <literal>True</literal> the private items should be
          displayed</entry>
        </row>

        <row valign="top">
          <entry>"show-tips"</entry>
          <entry>Read-Write</entry>
          <entry>if <literal>True</literal> there should be a tooltip on the
          item</entry>
        </row>

        <row valign="top">
          <entry>"sort-type"</entry>
          <entry>Read-Write</entry>
          <entry>The sorting order of the items displayed - one of the <xref
          linkend="gtk-recent-sort-type-constants"
          endterm="gtk-recent-sort-type-constants-title"></xref></entry>
        </row>

        </tbody>
      </tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkrecentchooser">
    <title>gtk.RecentChooser Signal Prototypes</title>


      <variablelist>
      <varlistentry>
        <term>"<link linkend="signal-gtkrecentchooser--item-activated">item-activated</link></term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>chooser</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>"<link linkend="signal-gtkrecentchooser--selection-changed">selection-changed</link></term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>chooser</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para><link
    linkend="class-gtkrecentchooser"><classname>gtk.RecentChooser</classname></link>
    is an interface that can be implemented by widgets displaying the list
    of recently used files.  In PyGTK, the main objects that implement this
    interface are <link
    linkend="class-gtkrecentchooserwidget"><classname>gtk.RecentChooserWidget</classname></link>,
    <link
    linkend="class-gtkrecentchooserdialog"><classname>gtk.RecentChooserDialog</classname></link>
    and <link
    linkend="class-gtkrecentchoosermenu"><classname>gtk.RecentChooserMenu</classname></link>.</para>

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

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkrecentchooser--set-show-private">
      <title>gtk.RecentChooser.set_show_private</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_show_private</methodname>
        <methodparam><parameter role="keyword">show_private</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">show_private</parameter>&nbsp;:</term>
          <listitem><simpara>if <literal>True</literal> show private
          items</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Sets the "show-private" property to the value of
      <parameter>show_private</parameter>.  If
      <parameter>show_private</parameter> is <literal>True</literal> show
      recently used resources marked registered as private.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--get-show-private">
      <title>gtk.RecentChooser.get_show_private</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_show_private</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if the recent chooser
          should show private items.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns <literal>True</literal> if recently used resources
      registered as private should be displayed.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--set-show-not-found">
      <title>gtk.RecentChooser.set_show_not_found</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_show_not_found</methodname>
        <methodparam><parameter role="keyword">show_not_found</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">show_not_found</parameter>&nbsp;:</term>
          <listitem><simpara>if <literal>True</literal> show the local items
          we didn't find</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Sets the "show-not'found" property to the value specified by
      <parameter>show_not_found</parameter>. If
      <parameter>show_not_found</parameter> is <literal>True</literal>,
      display the recently used resources that it didn't find.  This only
      applies to local resources.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--get-show-not-found">
      <title>gtk.RecentChooser.get_show_not_found</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_show_not_found</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if the resources not
          found should be displayed.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns <literal>True</literal> if the recently used resources
      that were not found shoudl be shown.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--set-select-multiple">
      <title>gtk.RecentChooser.set_select_multiple</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_select_multiple</methodname>
        <methodparam><parameter role="keyword">select_multiple</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">select_multiple</parameter>&nbsp;:</term>
          <listitem><simpara>if <literal>True</literal> more than one item
          can be selected</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Sets the "select-multiple" property to the value of
      <parameter>select_multiple</parameter>. If
      <parameter>select_mulitple</parameter> is <literal>True</literal>
      multiple items can be selected.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--get-select-multiple">
      <title>gtk.RecentChooser.get_select_multiple</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_select_multiple</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if more than one item
          can be selected.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns <literal>True</literal> if multiple items can be
      selected.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--set-limit">
      <title>gtk.RecentChooser.set_limit</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_limit</methodname>
        <methodparam><parameter role="keyword">limit</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">limit</parameter>&nbsp;:</term>
          <listitem><simpara>a positive integer, or -1 for all items</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Sets the number of items that should be returned by the <link
      linkend="method-gtkrecentchooser--get-items"><methodname>gtk.RecentChooser.get_items()</methodname></link>
      and <link
      linkend="method-gtkrecentchooser--get-uris"><methodname>gtk.RecentChooser.get_uris()</methodname></link>
      methods.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--get-limit">
      <title>gtk.RecentChooser.get_limit</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_limit</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>A positive integer, or -1 meaning that all
          items are returned.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns the number of items that can be returned by the <link
      linkend="method-gtkrecentchooser--get-items"><methodname>gtk.RecentChooser.get_items()</methodname></link>
      and <link
      linkend="method-gtkrecentchooser--get-uris"><methodname>gtk.RecentChooser.get_uris()</methodname></link>
      methods.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--set-local-only">
      <title>gtk.RecentChooser.set_local_only</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_local_only</methodname>
        <methodparam><parameter role="keyword">local_only</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">local_only</parameter>&nbsp;:</term>
          <listitem><simpara>if <literal>True</literal> only local files can
          be shown</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Sets the "local-only" property to the value of
      <parameter>local_only</parameter>. If
      <parameter>local_only</parameter> is <literal>True</literal> only
      local resources, that is resources using the file:// URI scheme,
      should be shown in the recently used resources selector.  If
      <parameter>local_only</parameter> is <literal>True</literal> (the
      default) then the resources shown are guaranteed to be accessible
      through the operating system native file system.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--get-local-only">
      <title>gtk.RecentChooser.get_local_only</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_local_only</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if only local resources
          should be shown.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns <literal>True</literal> if only local resources should
      be shown in the recently used resources selector.  See the <link
      linkend="method-gtkrecentchooser--set-local-only"><methodname>gtk.RecentChooser.set_local_only()</methodname></link>
      method.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--set-show-tips">
      <title>gtk.RecentChooser.set_show_tips</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_show_tips</methodname>
        <methodparam><parameter role="keyword">show_tips</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">show_tips</parameter>&nbsp;:</term>
          <listitem><simpara>if <literal>True</literal> tooltips should be
          shown</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Sets the "show-tips" property to the value of
      <parameter>show_tips</parameter>. If <parameter>show_tips</parameter>
      is <literal>True</literal>, show a tooltips on the widget.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--get-show-tips">
      <title>gtk.RecentChooser.get_show_tips</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_show_tips</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if the recent chooser
          should show tooltips.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns <literal>True</literal> if tooltips should be
      displayed.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--set-show-numbers">
      <title>gtk.RecentChooser.set_show_numbers</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_show_numbers</methodname>
        <methodparam><parameter role="keyword">show_numbers</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">show_numbers</parameter>&nbsp;:</term>
          <listitem><simpara>if <literal>True</literal> show
          numbers</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <warning>
        <para>
          This method is deprecated in PyGTK 2.12 and above and should not be
          used in newly-written code.
          Use <link linkend="method-gtkrecentchoosermenu--set-show-numbers"><methodname>gtk.RecentChooserMenu.set_show_numbers</methodname></link>() instead.
        </para>
      </warning>

      <para>Sets the "show-number" property to the value of
      <parameter>show_numbers</parameter>. If
      <parameter>show_numbers</parameter> is <literal>True</literal>, show
      recently used resources prepended by a unique number.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--get-show-numbers">
      <title>gtk.RecentChooser.get_show_numbers</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_show_numbers</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if the recent chooser
          should show display numbers.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <warning>
        <para>
          This method is deprecated in PyGTK 2.12 and above and should not be
          used in newly-written code.
          Use <link linkend="method-gtkrecentchoosermenu--get-show-numbers"><methodname>gtk.RecentChooserMenu.get_show_numbers</methodname></link>() instead.
        </para>
      </warning>

      <para>Returns <literal>True</literal> if recently used resources
      should be displayed prepended by a unique number.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--set-show-icons">
      <title>gtk.RecentChooser.set_show_icons</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_show_icons</methodname>
        <methodparam><parameter role="keyword">show_icons</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">show_icons</parameter>&nbsp;:</term>
          <listitem><simpara>if <literal>True</literal> show an icon near
          the resource</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Sets the "show-icon" property to the value of
      <parameter>show_icon</parameter>. If <parameter>show_icon</parameter>
      is <literal>True</literal>, show an icon near the resource when
      displaying it.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--get-show-icons">
      <title>gtk.RecentChooser.get_show_icons</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_show_icons</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if the icons should be
          displayed.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns <literal>True</literal> if an icon should be shown near
      the resource.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--set-sort-type">
      <title>gtk.RecentChooser.set_sort_type</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_sort_type</methodname>
        <methodparam><parameter role="keyword">sort_type</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">sort_type</parameter>&nbsp;:</term>
          <listitem><simpara>the sort order that the chooser should use -
          one of the <xref linkend="gtk-recent-sort-type-constants"
          endterm="gtk-recent-sort-type-constants-title"></xref></simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Sets the sorting order of the recently used resources list to
      the value specified by sort_type which must be one of the <xref
      linkend="gtk-recent-sort-type-constants"
      endterm="gtk-recent-sort-type-constants-title"></xref>.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--get-sort-type">
      <title>gtk.RecentChooser.get_sort_type</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_sort_type</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>the sorting order - one of the <xref
          linkend="gtk-recent-sort-type-constants"
          endterm="gtk-recent-sort-type-constants-title"></xref>.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns the value set by the <link
      linkend="method-gtkrecentchooser--set-sort-type"><methodname>gtk.RecentChooser.set_sort_type()</methodname>
      method.</link>.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--set-sort-func">
      <title>gtk.RecentChooser.set_sort_func</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_sort_func</methodname>
        <methodparam><parameter role="keyword">sort_func</parameter></methodparam>
        <methodparam><parameter role="keyword">sort_data</parameter><initializer>None</initializer></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">sort_func</parameter>&nbsp;:</term>
          <listitem><simpara>the comparison function</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">sort_data</parameter>&nbsp;:</term>
          <listitem><simpara>user data to pass to <parameter>sort_func</parameter>, or <literal>None</literal></simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Sets the comparison function specified by
      <parameter>sort_func</parameter> to be used when sorting.  If the
      "sort-type" property is set to
      <literal>gtk.RECENT_SORT_CUSTOM</literal>, the chooser will sort using
      this function.</para>
      
      <para>The signature of the comparison function is:</para>

      <programlisting>
  def sort_func(a, b, data):
      </programlisting>

      <para>where <parameter>a</parameter> and <parameter>b</parameter> are
      two <link
      linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
      objects and <parameter>data</parameter> is
      <parameter>sort_data</parameter>. <parameter>sort_func</parameter>
      should return a positive integer if the first item comes before the
      second, zero if the two items are equal and a negative integer if the
      first item comes after the second.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--set-current-uri">
      <title>gtk.RecentChooser.set_current_uri</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_current_uri</methodname>
        <methodparam><parameter role="keyword">uri</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
          <listitem><simpara>a URI</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if the URI was
          found.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Sets <parameter>uri</parameter> as the current URI. Raises the
      gobject.GError exception when an error occurs.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--get-current-uri">
      <title>gtk.RecentChooser.get_current_uri</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_current_uri</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a URI.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns the currently selected URI.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--get-current-item">
      <title>gtk.RecentChooser.get_current_item</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_current_item</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
          object.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns the <link
      linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
      for the currently selected item.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--select-uri">
      <title>gtk.RecentChooser.select_uri</title>

      <programlisting><methodsynopsis language="python">
        <methodname>select_uri</methodname>
        <methodparam><parameter role="keyword">uri</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
          <listitem><simpara>a URI</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara><literal>True</literal> if
          <parameter>uri</parameter> was found.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Selects <parameter>uri</parameter>. Raises the gobject.GError
      exception when an error occurs.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--unselect-uri">
      <title>gtk.RecentChooser.unselect_uri</title>

      <programlisting><methodsynopsis language="python">
        <methodname>unselect_uri</methodname>
        <methodparam><parameter role="keyword">uri</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">uri</parameter>&nbsp;:</term>
          <listitem><simpara>a URI</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Unselects <parameter>uri</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--select-all">
      <title>gtk.RecentChooser.select_all</title>

      <programlisting><methodsynopsis language="python">
        <methodname>select_all</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

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

      <para>Selects all the items inside <parameter>chooser</parameter>, if
      the "select-multiple" property is <literal>True</literal>.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--unselect-all">
      <title>gtk.RecentChooser.unselect_all</title>

      <programlisting><methodsynopsis language="python">
        <methodname>unselect_all</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

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

      <para>Unselects all the items.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--get-items">
      <title>gtk.RecentChooser.get_items</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_items</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>A list of <link
          linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
          objects.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns the list of recently used resources in form of <link
      linkend="class-gtkrecentinfo"><classname>gtk.RecentInfo</classname></link>
      objects.</para>
      
      <para>The return value of this function is affected by the "sort-type"
      and "limit" properties.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--get-uris">
      <title>gtk.RecentChooser.get_uris</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_uris</methodname>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>A list of strings.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns a list of the URIs of the recently used
      resources.</para>
      
      <para>The return value of this function is affected by the "sort-type"
      and "limit" properties>.</para>
      
    </refsect2>

    <refsect2 id="method-gtkrecentchooser--add-filter">
      <title>gtk.RecentChooser.add_filter</title>

      <programlisting><methodsynopsis language="python">
        <methodname>add_filter</methodname>
        <methodparam><parameter role="keyword">filter</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">filter</parameter>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Adds <parameter>filter</parameter> to the list of <link
      linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
      objects.</para>
      
      <para>If no previous filter objects were defined, this method will
      call the <link
      linkend="method-gtkrecentchooser--set-filter"><methodname>gtk.RecentChooser.set_filter()</methodname></link>
      method.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--remove-filter">
      <title>gtk.RecentChooser.remove_filter</title>

      <programlisting><methodsynopsis language="python">
        <methodname>remove_filter</methodname>
        <methodparam><parameter role="keyword">filter</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">filter</parameter>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Removes <parameter>filter</parameter> from the list of <link
      linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
      objects.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--list-filters">
      <title>gtk.RecentChooser.list_filters</title>

      <programlisting><methodsynopsis language="python">
        <methodname>list_filters</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>A list of <link
          linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
          objects..</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns a list of the <link
      linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
      objects.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--set-filter">
      <title>gtk.RecentChooser.set_filter</title>

      <programlisting><methodsynopsis language="python">
        <methodname>set_filter</methodname>
        <methodparam><parameter role="keyword">filter</parameter></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">filter</parameter>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Sets <parameter>filter</parameter> as the current <link
      linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
      object used by the recent chooser to filter the displayed recently
      used resources.</para>

    </refsect2>

    <refsect2 id="method-gtkrecentchooser--get-filter">
      <title>gtk.RecentChooser.get_filter</title>

      <programlisting><methodsynopsis language="python">
        <methodname>get_filter</methodname>
        <methodparam></methodparam>
      </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a <link
          linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
          object.</simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Returns the currently used <link
      linkend="class-gtkrecentfilter"><classname>gtk.RecentFilter</classname></link>
      object.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Signals</title>

    <refsect2 id="signal-gtkrecentchooser--item-activated">
      <title>The "item-activated" gtk.RecentChooser Signal</title>

      <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>chooser</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter>chooser</parameter>&nbsp;:</term>
          <listitem><simpara>the object which received the signal</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
          with the <link
          linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
          method</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>...</parameter>&nbsp;:</term>
          <listitem><simpara>additional user parameters (if any)</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This signal is available in GTK+ 2.10 and above.</para>
      </note>

      <para>This signal is emitted when the user "activates" a recent item
      in the recent chooser.  This can happen by double-clicking on an item
      in the recently used resources list, or by pressing
      <keycap>Enter</keycap>.</para>

    </refsect2>

    <refsect2 id="signal-gtkrecentchooser--selection-changed">
      <title>The "selection-changed" gtk.RecentChooser Signal</title>

      <programlisting><methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>chooser</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><parameter>chooser</parameter>&nbsp;:</term>
          <listitem><simpara>the object which received the signal</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
          with the <link
          linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
          method</simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter>...</parameter>&nbsp;:</term>
          <listitem><simpara>additional user parameters (if any)</simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This signal is available in GTK+ 2.10 and above.</para>
      </note>

      <para>This signal is emitted when there is a change in the set of
      selected recently used resources.  This can happen when a user
      modifies the selection with the mouse or the keyboard, or when
      explicitly calling methods to change the selection.</para>

    </refsect2>

</refsect1>

</refentry>
