296 lines
18 KiB
HTML
296 lines
18 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>GtkRecentChooserMenu: GTK+ 3 Reference Manual</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
|
||
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
|
||
<link rel="up" href="RecentDocuments.html" title="Recently Used Documents">
|
||
<link rel="prev" href="GtkRecentChooserDialog.html" title="GtkRecentChooserDialog">
|
||
<link rel="next" href="GtkRecentChooserWidget.html" title="GtkRecentChooserWidget">
|
||
<meta name="generator" content="GTK-Doc V1.29 (XML mode)">
|
||
<link rel="stylesheet" href="style.css" type="text/css">
|
||
</head>
|
||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
|
||
<td width="100%" align="left" class="shortcuts">
|
||
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
|
||
<a href="#GtkRecentChooserMenu.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||
<a href="#GtkRecentChooserMenu.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
|
||
<a href="#GtkRecentChooserMenu.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
|
||
<a href="#GtkRecentChooserMenu.properties" class="shortcut">Properties</a></span>
|
||
</td>
|
||
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
|
||
<td><a accesskey="u" href="RecentDocuments.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
|
||
<td><a accesskey="p" href="GtkRecentChooserDialog.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="n" href="GtkRecentChooserWidget.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
|
||
</tr></table>
|
||
<div class="refentry">
|
||
<a name="GtkRecentChooserMenu"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="GtkRecentChooserMenu.top_of_page"></a>GtkRecentChooserMenu</span></h2>
|
||
<p>GtkRecentChooserMenu — Displays recently used files in a menu</p>
|
||
</td>
|
||
<td class="gallery_image" valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsect1">
|
||
<a name="GtkRecentChooserMenu.functions"></a><h2>Functions</h2>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="functions_return">
|
||
<col class="functions_name">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkRecentChooserMenu.html#gtk-recent-chooser-menu-new" title="gtk_recent_chooser_menu_new ()">gtk_recent_chooser_menu_new</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkRecentChooserMenu.html#gtk-recent-chooser-menu-new-for-manager" title="gtk_recent_chooser_menu_new_for_manager ()">gtk_recent_chooser_menu_new_for_manager</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">gboolean</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkRecentChooserMenu.html#gtk-recent-chooser-menu-get-show-numbers" title="gtk_recent_chooser_menu_get_show_numbers ()">gtk_recent_chooser_menu_get_show_numbers</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="GtkRecentChooserMenu.html#gtk-recent-chooser-menu-set-show-numbers" title="gtk_recent_chooser_menu_set_show_numbers ()">gtk_recent_chooser_menu_set_show_numbers</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkRecentChooserMenu.properties"></a><h2>Properties</h2>
|
||
<div class="informaltable"><table class="informaltable" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="properties_type">
|
||
<col width="300px" class="properties_name">
|
||
<col width="200px" class="properties_flags">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="property_type"><span class="type">gboolean</span></td>
|
||
<td class="property_name"><a class="link" href="GtkRecentChooserMenu.html#GtkRecentChooserMenu--show-numbers" title="The “show-numbers” property">show-numbers</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkRecentChooserMenu.other"></a><h2>Types and Values</h2>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="name">
|
||
<col class="description">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="datatype_keyword">struct</td>
|
||
<td class="function_name"><a class="link" href="GtkRecentChooserMenu.html#GtkRecentChooserMenu-struct" title="struct GtkRecentChooserMenu">GtkRecentChooserMenu</a></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkRecentChooserMenu.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||
<pre class="screen"> GObject
|
||
<span class="lineart">╰──</span> GInitiallyUnowned
|
||
<span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
|
||
<span class="lineart">╰──</span> <a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
|
||
<span class="lineart">╰──</span> <a class="link" href="GtkMenuShell.html" title="GtkMenuShell">GtkMenuShell</a>
|
||
<span class="lineart">╰──</span> <a class="link" href="GtkMenu.html" title="GtkMenu">GtkMenu</a>
|
||
<span class="lineart">╰──</span> GtkRecentChooserMenu
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkRecentChooserMenu.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
|
||
<p>
|
||
GtkRecentChooserMenu implements
|
||
AtkImplementorIface, <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>, <a class="link" href="GtkRecentChooser.html" title="GtkRecentChooser">GtkRecentChooser</a> and <a class="link" href="GtkActivatable.html" title="GtkActivatable">GtkActivatable</a>.</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkRecentChooserMenu.includes"></a><h2>Includes</h2>
|
||
<pre class="synopsis">#include <gtk/gtk.h>
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkRecentChooserMenu.description"></a><h2>Description</h2>
|
||
<p><a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> is a widget suitable for displaying recently used files
|
||
inside a menu. It can be used to set a sub-menu of a <a class="link" href="GtkMenuItem.html" title="GtkMenuItem"><span class="type">GtkMenuItem</span></a> using
|
||
<a class="link" href="GtkMenuItem.html#gtk-menu-item-set-submenu" title="gtk_menu_item_set_submenu ()"><code class="function">gtk_menu_item_set_submenu()</code></a>, or as the menu of a <a class="link" href="GtkMenuToolButton.html" title="GtkMenuToolButton"><span class="type">GtkMenuToolButton</span></a>.</p>
|
||
<p>Note that <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> does not have any methods of its own. Instead,
|
||
you should use the functions that work on a <a class="link" href="GtkRecentChooser.html" title="GtkRecentChooser"><span class="type">GtkRecentChooser</span></a>.</p>
|
||
<p>Note also that <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> does not support multiple filters, as it
|
||
has no way to let the user choose between them as the <a class="link" href="GtkRecentChooserWidget.html" title="GtkRecentChooserWidget"><span class="type">GtkRecentChooserWidget</span></a>
|
||
and <a class="link" href="GtkRecentChooserDialog.html" title="GtkRecentChooserDialog"><span class="type">GtkRecentChooserDialog</span></a> widgets do. Thus using <a class="link" href="GtkRecentChooser.html#gtk-recent-chooser-add-filter" title="gtk_recent_chooser_add_filter ()"><code class="function">gtk_recent_chooser_add_filter()</code></a>
|
||
on a <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> widget will yield the same effects as using
|
||
<a class="link" href="GtkRecentChooser.html#gtk-recent-chooser-set-filter" title="gtk_recent_chooser_set_filter ()"><code class="function">gtk_recent_chooser_set_filter()</code></a>, replacing any currently set filter
|
||
with the supplied filter; <a class="link" href="GtkRecentChooser.html#gtk-recent-chooser-remove-filter" title="gtk_recent_chooser_remove_filter ()"><code class="function">gtk_recent_chooser_remove_filter()</code></a> will remove
|
||
any currently set <a class="link" href="GtkRecentFilter.html" title="GtkRecentFilter"><span class="type">GtkRecentFilter</span></a> object and will unset the current filter;
|
||
<a class="link" href="GtkRecentChooser.html#gtk-recent-chooser-list-filters" title="gtk_recent_chooser_list_filters ()"><code class="function">gtk_recent_chooser_list_filters()</code></a> will return a list containing a single
|
||
<a class="link" href="GtkRecentFilter.html" title="GtkRecentFilter"><span class="type">GtkRecentFilter</span></a> object.</p>
|
||
<p>Recently used files are supported since GTK+ 2.10.</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkRecentChooserMenu.functions_details"></a><h2>Functions</h2>
|
||
<div class="refsect2">
|
||
<a name="gtk-recent-chooser-menu-new"></a><h3>gtk_recent_chooser_menu_new ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
gtk_recent_chooser_menu_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||
<p>Creates a new <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> widget.</p>
|
||
<p>This kind of widget shows the list of recently used resources as
|
||
a menu, each item as a menu item. Each item inside the menu might
|
||
have an icon, representing its MIME type, and a number, for mnemonic
|
||
access.</p>
|
||
<p>This widget implements the <a class="link" href="GtkRecentChooser.html" title="GtkRecentChooser"><span class="type">GtkRecentChooser</span></a> interface.</p>
|
||
<p>This widget creates its own <a class="link" href="GtkRecentManager.html" title="GtkRecentManager"><span class="type">GtkRecentManager</span></a> object. See the
|
||
<a class="link" href="GtkRecentChooserMenu.html#gtk-recent-chooser-menu-new-for-manager" title="gtk_recent_chooser_menu_new_for_manager ()"><code class="function">gtk_recent_chooser_menu_new_for_manager()</code></a> function to know how to create
|
||
a <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> widget bound to another <a class="link" href="GtkRecentManager.html" title="GtkRecentManager"><span class="type">GtkRecentManager</span></a> object.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-recent-chooser-menu-new.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a></p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-recent-chooser-menu-new-for-manager"></a><h3>gtk_recent_chooser_menu_new_for_manager ()</h3>
|
||
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
|
||
gtk_recent_chooser_menu_new_for_manager
|
||
(<em class="parameter"><code><a class="link" href="GtkRecentManager.html" title="GtkRecentManager"><span class="type">GtkRecentManager</span></a> *manager</code></em>);</pre>
|
||
<p>Creates a new <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> widget using <em class="parameter"><code>manager</code></em>
|
||
as
|
||
the underlying recently used resources manager.</p>
|
||
<p>This is useful if you have implemented your own recent manager,
|
||
or if you have a customized instance of a <a class="link" href="GtkRecentManager.html" title="GtkRecentManager"><span class="type">GtkRecentManager</span></a>
|
||
object or if you wish to share a common <a class="link" href="GtkRecentManager.html" title="GtkRecentManager"><span class="type">GtkRecentManager</span></a> object
|
||
among multiple <a class="link" href="GtkRecentChooser.html" title="GtkRecentChooser"><span class="type">GtkRecentChooser</span></a> widgets.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-recent-chooser-menu-new-for-manager.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>manager</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkRecentManager.html" title="GtkRecentManager"><span class="type">GtkRecentManager</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-recent-chooser-menu-new-for-manager.returns"></a><h4>Returns</h4>
|
||
<p> a new <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a>, bound to <em class="parameter"><code>manager</code></em>
|
||
.</p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-recent-chooser-menu-get-show-numbers"></a><h3>gtk_recent_chooser_menu_get_show_numbers ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">gboolean</span>
|
||
gtk_recent_chooser_menu_get_show_numbers
|
||
(<em class="parameter"><code><a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> *menu</code></em>);</pre>
|
||
<p>Returns the value set by <a class="link" href="GtkRecentChooserMenu.html#gtk-recent-chooser-menu-set-show-numbers" title="gtk_recent_chooser_menu_set_show_numbers ()"><code class="function">gtk_recent_chooser_menu_set_show_numbers()</code></a>.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-recent-chooser-menu-get-show-numbers.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>menu</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="gtk-recent-chooser-menu-get-show-numbers.returns"></a><h4>Returns</h4>
|
||
<p> <code class="literal">TRUE</code> if numbers should be shown.</p>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="gtk-recent-chooser-menu-set-show-numbers"></a><h3>gtk_recent_chooser_menu_set_show_numbers ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
gtk_recent_chooser_menu_set_show_numbers
|
||
(<em class="parameter"><code><a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> *menu</code></em>,
|
||
<em class="parameter"><code><span class="type">gboolean</span> show_numbers</code></em>);</pre>
|
||
<p>Sets whether a number should be added to the items of <em class="parameter"><code>menu</code></em>
|
||
. The
|
||
numbers are shown to provide a unique character for a mnemonic to
|
||
be used inside ten menu item’s label. Only the first the items
|
||
get a number to avoid clashes.</p>
|
||
<div class="refsect3">
|
||
<a name="gtk-recent-chooser-menu-set-show-numbers.parameters"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table class="informaltable" width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>menu</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a></p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>show_numbers</p></td>
|
||
<td class="parameter_description"><p>whether to show numbers</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkRecentChooserMenu.other_details"></a><h2>Types and Values</h2>
|
||
<div class="refsect2">
|
||
<a name="GtkRecentChooserMenu-struct"></a><h3>struct GtkRecentChooserMenu</h3>
|
||
<pre class="programlisting">struct GtkRecentChooserMenu;</pre>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkRecentChooserMenu.property-details"></a><h2>Property Details</h2>
|
||
<div class="refsect2">
|
||
<a name="GtkRecentChooserMenu--show-numbers"></a><h3>The <code class="literal">“show-numbers”</code> property</h3>
|
||
<pre class="programlisting"> “show-numbers” <span class="type">gboolean</span></pre>
|
||
<p>Whether the first ten items in the menu should be prepended by
|
||
a number acting as a unique mnemonic.</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Default value: FALSE</p>
|
||
<p class="since">Since: 2.10</p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="GtkRecentChooserMenu.see-also"></a><h2>See Also</h2>
|
||
<p><a class="link" href="GtkRecentChooser.html" title="GtkRecentChooser"><span class="type">GtkRecentChooser</span></a></p>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>Generated by GTK-Doc V1.29</div>
|
||
</body>
|
||
</html> |