1
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.RecentManager</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkrecentinfo.html" title="gtk.RecentInfo"><link rel="next" href="class-gtkrequisition.html" title="gtk.Requisition"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.RecentManager</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkrecentinfo.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkrequisition.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkrecentmanager"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.RecentManager</h2><p>gtk.RecentManager — manages recently used files (new in PyGTK
2
2.10)</p></div><div class="refsect1" lang="en"><a name="id3635398"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.RecentManager</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
2
2.10)</p></div><div class="refsect1" lang="en"><a name="id3836203"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.RecentManager</span></span>(<span class="ooclass"><span class="classname"><PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK></span></span>):
3
3
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#constructor-gtkrecentmanager" title="gtk.RecentManager">gtk.RecentManager</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#method-gtkrecentmanager--set-screen" title="gtk.RecentManager.set_screen">set_screen</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#method-gtkrecentmanager--add-item" title="gtk.RecentManager.add_item">add_item</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#method-gtkrecentmanager--add-full" title="gtk.RecentManager.add_full">add_full</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>recent_data</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#method-gtkrecentmanager--remove-item" title="gtk.RecentManager.remove_item">remove_item</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#method-gtkrecentmanager--lookup-item" title="gtk.RecentManager.lookup_item">lookup_item</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#method-gtkrecentmanager--has-item" title="gtk.RecentManager.has_item">has_item</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#method-gtkrecentmanager--move-item" title="gtk.RecentManager.move_item">move_item</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>new_uri</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#method-gtkrecentmanager--set-limit" title="gtk.RecentManager.set_limit">set_limit</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>limit</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#method-gtkrecentmanager--get-limit" title="gtk.RecentManager.get_limit">get_limit</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#method-gtkrecentmanager--get-items" title="gtk.RecentManager.get_items">get_items</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#method-gtkrecentmanager--purge-items" title="gtk.RecentManager.purge_items">purge_items</a></span>()</code><br></pre></td></tr></table><pre class="programlisting">
4
4
<span class="bold"><strong>Functions</strong></span>
6
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#function-gtk--recent-manager-get-default" title="gtk.recent_manager_get_default">gtk.recent_manager_get_default</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#function-gtk--recent-manager-get-for-screen" title="gtk.recent_manager_get_for_screen">gtk.recent_manager_get_for_screen</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id3635806"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
6
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#function-gtk--recent-manager-get-default" title="gtk.recent_manager_get_default">gtk.recent_manager_get_default</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrecentmanager.html#function-gtk--recent-manager-get-for-screen" title="gtk.recent_manager_get_for_screen">gtk.recent_manager_get_for_screen</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>)</code></pre></div><div class="refsect1" lang="en"><a name="id3836612"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
7
7
+-- <a class="link" href="class-gtkrecentmanager.html" title="gtk.RecentManager">gtk.RecentManager</a>
8
8
</pre></div><div class="refsect1" lang="en"><a name="properties-gtkrecentmanager"></a><h2>gtk.RecentManager Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"filename"</td><td valign="top">Read-Write-Construct Only</td><td valign="top">The full path to the file to be used to store and read the
9
9
recently used resources list This property is available in GTK+
10
10
2.10 and above.</td></tr><tr valign="top"><td valign="top">"limit"</td><td valign="top">Read-Write</td><td valign="top">The maximum number of items to be returned by the <a class="link" href="class-gtkrecentmanager.html#method-gtkrecentmanager--get-items" title="gtk.RecentManager.get_items"><code class="methodname">gtk.RecentManager.get_items()</code></a>
11
11
function. This property is available in GTK+ 2.10 and
12
12
above.</td></tr><tr valign="top"><td valign="top">"size"</td><td valign="top">Read</td><td valign="top">The size of the recently used resources list. This
13
property is available in GTK+ 2.10 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkrecentmanager"></a><h2>gtk.RecentManager Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkrecentmanager.html#signal-gtkrecentmanager--changed" title='The "changed" gtk.RecentManager Signal'>changed</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>recent_manager</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3636038"></a><h2>Description</h2><p><a class="link" href="class-gtkrecentmanager.html" title="gtk.RecentManager"><code class="classname">gtk.RecentManager</code></a>
13
property is available in GTK+ 2.10 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkrecentmanager"></a><h2>gtk.RecentManager Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkrecentmanager.html#signal-gtkrecentmanager--changed" title='The "changed" gtk.RecentManager Signal'>changed</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>recent_manager</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3836844"></a><h2>Description</h2><p><a class="link" href="class-gtkrecentmanager.html" title="gtk.RecentManager"><code class="classname">gtk.RecentManager</code></a>
14
14
provides a facility for adding, removing and looking up recently used
15
15
files. Each recently used file is identified by its URI, and has
16
16
meta-data associated to it, like the names and command lines of the
33
33
info = manager.lookup_item(file_uri)
34
34
except gobject.GError:
35
35
print "Could not find the file: ", file_uri
36
</pre></div><p>Recently used files are supported since GTK+ 2.10.</p></div><div class="refsect1" lang="en"><a name="id3636127"></a><h2>Constructor</h2><div class="refsect2" lang="en"><a name="constructor-gtkrecentmanager"></a><h3>gtk.RecentManager</h3><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.RecentManager</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>A newly created <a class="link" href="class-gtkrecentmanager.html" title="gtk.RecentManager"><code class="classname">gtk.RecentManager</code></a>
36
</pre></div><p>Recently used files are supported since GTK+ 2.10.</p></div><div class="refsect1" lang="en"><a name="id3836932"></a><h2>Constructor</h2><div class="refsect2" lang="en"><a name="constructor-gtkrecentmanager"></a><h3>gtk.RecentManager</h3><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.RecentManager</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>A newly created <a class="link" href="class-gtkrecentmanager.html" title="gtk.RecentManager"><code class="classname">gtk.RecentManager</code></a>
37
37
object.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.10 and above.</p></div><p>Creates a new recent manager object. Recent manager objects are
38
38
used to handle the list of recently used resources. A <a class="link" href="class-gtkrecentmanager.html" title="gtk.RecentManager"><code class="classname">gtk.RecentManager</code></a>
39
39
object monitors the recently used resources list, and emits the
41
41
objects are expansive: be sure to create them only when needed. You
42
42
should use the <a class="link" href="class-gtkrecentmanager.html#function-gtk--recent-manager-get-for-screen" title="gtk.recent_manager_get_for_screen"><code class="function">gtk.recent_manager_get_for_screen</code>()</a>
43
43
or the <a class="link" href="class-gtkrecentmanager.html#function-gtk--recent-manager-get-default" title="gtk.recent_manager_get_default"><code class="function">gtk.recent_manager_get_default</code>()</a>
44
functions instead.</p></div></div><div class="refsect1" lang="en"><a name="id3636252"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkrecentmanager--set-screen"></a><h3>gtk.RecentManager.set_screen</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_screen</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>screen</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>Sets the screen for a recent manager; the screen is used to
44
functions instead.</p></div></div><div class="refsect1" lang="en"><a name="id3837057"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkrecentmanager--set-screen"></a><h3>gtk.RecentManager.set_screen</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_screen</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>screen</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>screen</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkscreen.html" title="gtk.gdk.Screen"><code class="classname">gtk.gdk.Screen</code></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>Sets the screen for a recent manager; the screen is used to
45
45
track the user's currently configured recently used documents
46
46
storage.</p></div><div class="refsect2" lang="en"><a name="method-gtkrecentmanager--add-item"></a><h3>gtk.RecentManager.add_item</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">add_item</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>uri</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>uri</code></strong> :</span></p></td><td>a valid URI</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the new item was
47
47
successfully added to the recently used resources
94
94
objects.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>Returns the list of recently used resources as <a class="link" href="class-gtkrecentinfo.html" title="gtk.RecentInfo"><code class="classname">gtk.RecentInfo</code></a>
95
95
objects.</p></div><div class="refsect2" lang="en"><a name="method-gtkrecentmanager--purge-items"></a><h3>gtk.RecentManager.purge_items</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">purge_items</span>()</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the number of items that have been removed from
96
96
the recently used resources list.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>Purges every item from the recently used resources list. Raises
97
the gobject.GError when an error occurs.</p></div></div><div class="refsect1" lang="en"><a name="id3637427"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtk--recent-manager-get-default"></a><h3>gtk.recent_manager_get_default</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.recent_manager_get_default</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>A unique <a class="link" href="class-gtkrecentmanager.html" title="gtk.RecentManager"><code class="classname">gtk.RecentManager</code></a>
97
the gobject.GError when an error occurs.</p></div></div><div class="refsect1" lang="en"><a name="id3838233"></a><h2>Functions</h2><div class="refsect2" lang="en"><a name="function-gtk--recent-manager-get-default"></a><h3>gtk.recent_manager_get_default</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">gtk.recent_manager_get_default</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>A unique <a class="link" href="class-gtkrecentmanager.html" title="gtk.RecentManager"><code class="classname">gtk.RecentManager</code></a>
98
98
associated with the default screen. This recent manager is
99
99
associated to the screen and can be used as long as the screen is
100
100
open.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This function is available in PyGTK 2.10 and above.</p></div><p>Gets the recent manager for the default screen. See the <a class="link" href="class-gtkrecentmanager.html#function-gtk--recent-manager-get-for-screen" title="gtk.recent_manager_get_for_screen"><code class="function">gtk.recent_manager_get_for_screen</code>()</a>
108
108
fairly expensive to create, so using this function is usually a better
109
109
choice than calling the <a class="link" href="class-gtkrecentmanager.html#constructor-gtkrecentmanager" title="gtk.RecentManager">gtk.RecentManager</a>()
110
110
constructor and setting the screen yourself; by using this function a
111
single recent manager object will be shared between users.</p></div></div><div class="refsect1" lang="en"><a name="id3637646"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkrecentmanager--changed"></a><h3>The "changed" gtk.RecentManager Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>recent_manager</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>recent_manager</code></em> :</span></p></td><td>the recent manager</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
111
single recent manager object will be shared between users.</p></div></div><div class="refsect1" lang="en"><a name="id3838451"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkrecentmanager--changed"></a><h3>The "changed" gtk.RecentManager Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>recent_manager</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>recent_manager</code></em> :</span></p></td><td>the recent manager</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
112
112
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
113
113
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if any)</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.10 and above.</p></div><p>Emitted when the current recently used resources manager changes
114
114
its contents.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtkrecentinfo.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtkrequisition.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.RecentInfo </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.Requisition</td></tr></table></div></body></html>
added
removed
docs/html/class-gtkrecentmanager.html
