~inkscape.dev/inkscape-devlibs/devlibs-gtk3

« back to all changes in this revision

Viewing changes to share/gtk-doc/html/gtk2/GtkRecentChooserMenu.html

  • Committer: JazzyNico
  • Date: 2013-01-21 10:11:05 UTC
  • Revision ID: nicoduf@yahoo.fr-20130121101105-i8d8slkq9ng4olx8
Adding gtk2 libraries.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>GtkRecentChooserMenu</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
 
7
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
 
8
<link rel="up" href="RecentDocuments.html" title="Recently Used Documents">
 
9
<link rel="prev" href="GtkRecentChooserDialog.html" title="GtkRecentChooserDialog">
 
10
<link rel="next" href="GtkRecentChooserWidget.html" title="GtkRecentChooserWidget">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="GtkRecentChooserDialog.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="RecentDocuments.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">GTK+ 2 Reference Manual</th>
 
21
<td><a accesskey="n" href="GtkRecentChooserWidget.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#GtkRecentChooserMenu.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#GtkRecentChooserMenu.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#GtkRecentChooserMenu.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#GtkRecentChooserMenu.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#GtkRecentChooserMenu.properties" class="shortcut">Properties</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry">
 
36
<a name="GtkRecentChooserMenu"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="GtkRecentChooserMenu.top_of_page"></a>GtkRecentChooserMenu</span></h2>
 
40
<p>GtkRecentChooserMenu — Displays recently used files in a menu</p>
 
41
</td>
 
42
<td valign="top" align="right"></td>
 
43
</tr></table></div>
 
44
<div class="refsynopsisdiv">
 
45
<a name="GtkRecentChooserMenu.synopsis"></a><h2>Synopsis</h2>
 
46
<pre class="synopsis">
 
47
#include &lt;gtk/gtk.h&gt;
 
48
 
 
49
struct              <a class="link" href="GtkRecentChooserMenu.html#GtkRecentChooserMenu-struct" title="struct GtkRecentChooserMenu">GtkRecentChooserMenu</a>;
 
50
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkRecentChooserMenu.html#gtk-recent-chooser-menu-new" title="gtk_recent_chooser_menu_new ()">gtk_recent_chooser_menu_new</a>         (<em class="parameter"><code><span class="type">void</span></code></em>);
 
51
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <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>
 
52
                                                        (<em class="parameter"><code><a class="link" href="GtkRecentManager.html" title="GtkRecentManager"><span class="type">GtkRecentManager</span></a> *manager</code></em>);
 
53
<span class="returnvalue">gboolean</span>            <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>
 
54
                                                        (<em class="parameter"><code><a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> *menu</code></em>);
 
55
<span class="returnvalue">void</span>                <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>
 
56
                                                        (<em class="parameter"><code><a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> *menu</code></em>,
 
57
                                                         <em class="parameter"><code><span class="type">gboolean</span> show_numbers</code></em>);
 
58
</pre>
 
59
</div>
 
60
<div class="refsect1">
 
61
<a name="GtkRecentChooserMenu.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
62
<pre class="synopsis">
 
63
  GObject
 
64
   +----GInitiallyUnowned
 
65
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
 
66
               +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
 
67
                     +----<a class="link" href="GtkContainer.html" title="GtkContainer">GtkContainer</a>
 
68
                           +----<a class="link" href="GtkMenuShell.html" title="GtkMenuShell">GtkMenuShell</a>
 
69
                                 +----<a class="link" href="GtkMenu.html" title="GtkMenu">GtkMenu</a>
 
70
                                       +----GtkRecentChooserMenu
 
71
</pre>
 
72
</div>
 
73
<div class="refsect1">
 
74
<a name="GtkRecentChooserMenu.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
75
<p>
 
76
GtkRecentChooserMenu implements
 
77
 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>
 
78
</div>
 
79
<div class="refsect1">
 
80
<a name="GtkRecentChooserMenu.properties"></a><h2>Properties</h2>
 
81
<pre class="synopsis">
 
82
  "<a class="link" href="GtkRecentChooserMenu.html#GtkRecentChooserMenu--show-numbers" title='The "show-numbers" property'>show-numbers</a>"             <span class="type">gboolean</span>              : Read / Write
 
83
</pre>
 
84
</div>
 
85
<div class="refsect1">
 
86
<a name="GtkRecentChooserMenu.description"></a><h2>Description</h2>
 
87
<p>
 
88
<a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> is a widget suitable for displaying recently used files
 
89
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
 
90
<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>.
 
91
</p>
 
92
<p>
 
93
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,
 
94
you should use the functions that work on a <a class="link" href="GtkRecentChooser.html" title="GtkRecentChooser"><span class="type">GtkRecentChooser</span></a>.
 
95
</p>
 
96
<p>
 
97
Note also that <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> does not support multiple filters, as it
 
98
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>
 
99
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>
 
100
on a <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> widget will yield the same effects as using
 
101
<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
 
102
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
 
103
any currently set <a class="link" href="GtkRecentFilter.html" title="GtkRecentFilter"><span class="type">GtkRecentFilter</span></a> object and will unset the current filter;
 
104
<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
 
105
<a class="link" href="GtkRecentFilter.html" title="GtkRecentFilter"><span class="type">GtkRecentFilter</span></a> object.
 
106
</p>
 
107
<p>
 
108
Recently used files are supported since GTK+ 2.10.
 
109
</p>
 
110
</div>
 
111
<div class="refsect1">
 
112
<a name="GtkRecentChooserMenu.details"></a><h2>Details</h2>
 
113
<div class="refsect2">
 
114
<a name="GtkRecentChooserMenu-struct"></a><h3>struct GtkRecentChooserMenu</h3>
 
115
<pre class="programlisting">struct GtkRecentChooserMenu;</pre>
 
116
<p>
 
117
</p>
 
118
</div>
 
119
<hr>
 
120
<div class="refsect2">
 
121
<a name="gtk-recent-chooser-menu-new"></a><h3>gtk_recent_chooser_menu_new ()</h3>
 
122
<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>
 
123
<p>
 
124
Creates a new <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> widget.
 
125
</p>
 
126
<p>
 
127
This kind of widget shows the list of recently used resources as
 
128
a menu, each item as a menu item.  Each item inside the menu might
 
129
have an icon, representing its MIME type, and a number, for mnemonic
 
130
access.
 
131
</p>
 
132
<p>
 
133
This widget implements the <a class="link" href="GtkRecentChooser.html" title="GtkRecentChooser"><span class="type">GtkRecentChooser</span></a> interface.
 
134
</p>
 
135
<p>
 
136
This widget creates its own <a class="link" href="GtkRecentManager.html" title="GtkRecentManager"><span class="type">GtkRecentManager</span></a> object.  See the
 
137
<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
 
138
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.
 
139
</p>
 
140
<div class="variablelist"><table border="0" class="variablelist">
 
141
<colgroup>
 
142
<col align="left" valign="top">
 
143
<col>
 
144
</colgroup>
 
145
<tbody><tr>
 
146
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
147
<td>a new <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a>
 
148
</td>
 
149
</tr></tbody>
 
150
</table></div>
 
151
<p class="since">Since 2.10</p>
 
152
</div>
 
153
<hr>
 
154
<div class="refsect2">
 
155
<a name="gtk-recent-chooser-menu-new-for-manager"></a><h3>gtk_recent_chooser_menu_new_for_manager ()</h3>
 
156
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_recent_chooser_menu_new_for_manager
 
157
                                                        (<em class="parameter"><code><a class="link" href="GtkRecentManager.html" title="GtkRecentManager"><span class="type">GtkRecentManager</span></a> *manager</code></em>);</pre>
 
158
<p>
 
159
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
 
160
the underlying recently used resources manager.
 
161
</p>
 
162
<p>
 
163
This is useful if you have implemented your own recent manager,
 
164
or if you have a customized instance of a <a class="link" href="GtkRecentManager.html" title="GtkRecentManager"><span class="type">GtkRecentManager</span></a>
 
165
object or if you wish to share a common <a class="link" href="GtkRecentManager.html" title="GtkRecentManager"><span class="type">GtkRecentManager</span></a> object
 
166
among multiple <a class="link" href="GtkRecentChooser.html" title="GtkRecentChooser"><span class="type">GtkRecentChooser</span></a> widgets.
 
167
</p>
 
168
<div class="variablelist"><table border="0" class="variablelist">
 
169
<colgroup>
 
170
<col align="left" valign="top">
 
171
<col>
 
172
</colgroup>
 
173
<tbody>
 
174
<tr>
 
175
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
 
176
<td>a <a class="link" href="GtkRecentManager.html" title="GtkRecentManager"><span class="type">GtkRecentManager</span></a>
 
177
</td>
 
178
</tr>
 
179
<tr>
 
180
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
181
<td>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>.</td>
 
182
</tr>
 
183
</tbody>
 
184
</table></div>
 
185
<p class="since">Since 2.10</p>
 
186
</div>
 
187
<hr>
 
188
<div class="refsect2">
 
189
<a name="gtk-recent-chooser-menu-get-show-numbers"></a><h3>gtk_recent_chooser_menu_get_show_numbers ()</h3>
 
190
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gtk_recent_chooser_menu_get_show_numbers
 
191
                                                        (<em class="parameter"><code><a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> *menu</code></em>);</pre>
 
192
<p>
 
193
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>.
 
194
</p>
 
195
<div class="variablelist"><table border="0" class="variablelist">
 
196
<colgroup>
 
197
<col align="left" valign="top">
 
198
<col>
 
199
</colgroup>
 
200
<tbody>
 
201
<tr>
 
202
<td><p><span class="term"><em class="parameter"><code>menu</code></em> :</span></p></td>
 
203
<td>a <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a>
 
204
</td>
 
205
</tr>
 
206
<tr>
 
207
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
208
<td>
 
209
<code class="literal">TRUE</code> if numbers should be shown.</td>
 
210
</tr>
 
211
</tbody>
 
212
</table></div>
 
213
<p class="since">Since 2.10</p>
 
214
</div>
 
215
<hr>
 
216
<div class="refsect2">
 
217
<a name="gtk-recent-chooser-menu-set-show-numbers"></a><h3>gtk_recent_chooser_menu_set_show_numbers ()</h3>
 
218
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_recent_chooser_menu_set_show_numbers
 
219
                                                        (<em class="parameter"><code><a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a> *menu</code></em>,
 
220
                                                         <em class="parameter"><code><span class="type">gboolean</span> show_numbers</code></em>);</pre>
 
221
<p>
 
222
Sets whether a number should be added to the items of <em class="parameter"><code>menu</code></em>.  The
 
223
numbers are shown to provide a unique character for a mnemonic to
 
224
be used inside ten menu item's label.  Only the first the items
 
225
get a number to avoid clashes.
 
226
</p>
 
227
<div class="variablelist"><table border="0" class="variablelist">
 
228
<colgroup>
 
229
<col align="left" valign="top">
 
230
<col>
 
231
</colgroup>
 
232
<tbody>
 
233
<tr>
 
234
<td><p><span class="term"><em class="parameter"><code>menu</code></em> :</span></p></td>
 
235
<td>a <a class="link" href="GtkRecentChooserMenu.html" title="GtkRecentChooserMenu"><span class="type">GtkRecentChooserMenu</span></a>
 
236
</td>
 
237
</tr>
 
238
<tr>
 
239
<td><p><span class="term"><em class="parameter"><code>show_numbers</code></em> :</span></p></td>
 
240
<td>whether to show numbers</td>
 
241
</tr>
 
242
</tbody>
 
243
</table></div>
 
244
<p class="since">Since 2.10</p>
 
245
</div>
 
246
</div>
 
247
<div class="refsect1">
 
248
<a name="GtkRecentChooserMenu.property-details"></a><h2>Property Details</h2>
 
249
<div class="refsect2">
 
250
<a name="GtkRecentChooserMenu--show-numbers"></a><h3>The <code class="literal">"show-numbers"</code> property</h3>
 
251
<pre class="programlisting">  "show-numbers"             <span class="type">gboolean</span>              : Read / Write</pre>
 
252
<p>
 
253
Whether the first ten items in the menu should be prepended by
 
254
a number acting as a unique mnemonic.
 
255
</p>
 
256
<p>Default value: FALSE</p>
 
257
<p class="since">Since 2.10</p>
 
258
</div>
 
259
</div>
 
260
<div class="refsect1">
 
261
<a name="GtkRecentChooserMenu.see-also"></a><h2>See Also</h2>
 
262
<p>
 
263
<a class="link" href="GtkRecentChooser.html" title="GtkRecentChooser"><span class="type">GtkRecentChooser</span></a>
 
264
</p>
 
265
</div>
 
266
</div>
 
267
<div class="footer">
 
268
<hr>
 
269
          Generated by GTK-Doc V1.18</div>
 
270
</body>
 
271
</html>
 
 
b'\\ No newline at end of file'