← Back to branch summary

~canonical-dx-team/ubuntu/maverick/gtk+2.0/menuproxy

« back to all changes in this revision

Viewing changes to docs/reference/gtk/xml/gtkitemfactory.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-05-04 12:24:25 UTC
  • mfrom: (1.1.21 upstream)
  • Revision ID: james.westby@ubuntu.com-20070504122425-0m8midgzrp40y8w2
Tags: 2.10.12-1ubuntu1
* Sync with Debian
* New upstream version:
  Fixed bugs:
  - 379414 file chooser warnings when changing path in the entry
  - 418585 GtkFileChooserDefault sizing code is not DPI independent
  - 419568 Crash in search if start with special letter
  - 435062 build dies with icon cache validation
  - 379399 Segfault to call gtk_print_operation_run twice.
  - 387889 cups backend has problems when there are too many printers
  - 418531 invalid read to gtkicontheme.c gtk_icon_theme_lookup_icon...
  - 423916 crash in color scheme code
  - 424042 Segmentation fault while quickly pressing Alt+arrows
  - 415260 Protect against negative indices when setting values in G...
  - 419171 XGetVisualInfo() may not set nxvisuals
  - 128852 Gdk cursors don't look good on win32
  - 344657 Ctrl-H doesn't toggle "Show Hidden Files" setting
  - 345345 PrintOperation::paginate is not emitted for class handler
  - 347567 GtkPrintOperation::end-print is not emitted if it's cance...
  - 369112 gtk_ui_manager_add_ui should accept unnamed separator
  - 392015 Selected menu item invisible on Windows Vista
  - 399253 MS-Windows Theme Bottom Tab placement rendering glitches
  - 399425 gtk_input_dialog_fill_axes() adds child to gtkscrolledwin...
  - 403251 [patch] little memory leak in GtkPrintJob
  - 403267 [patch] memory leak in GtkPageSetupUnixDialog
  - 403470 MS-Windows Theme tab placement other than on top leaks a ...
  - 404506 Windows system fonts that have multi-byte font names cann...
  - 405089 Incorrect window placement for GtkEventBox private window
  - 405515 Minor leak in gtkfilesystemmodel.c
  - 405539 gdk_pixbuf_save() for PNG saver can return FALSE without ...
  - 415681 gdk_window_clear_area includes an extra line and column o...
  - 418219 GtkRecentChooser should apply filter before sorting and c...
  - 418403 Scroll to printer after selecting it from settings
  - 421985 _gtk_print_operation_platform_backend_launch_preview
  - 421990 gtk_print_job_get_surface
  - 421993 gtk_print_operation_init
  - 423064 Conditional jump or move depends on uninitialised value(s...
  - 423722 Fix printing header in gtk-demo
  - 424168 gtk_print_operation_run on async preview
  - 425655 Don't install gtk+-unix-print-2.0.pc on non-UNIX platforms
  - 425786 GDK segfaults if XineramaQueryScreens fails
  - 428665 Lpr Backend gets stuck in infinite loop during gtk_enumer...
  - 429902 GtkPrintOperation leaks cairo contextes
  - 431997 First delay of GdkPixbufAnimationIter is wrong
  - 433242 Inconsistent scroll arrow position calculations
  - 433972 Placing gtk.Expander inside a gtk.TextView() changes gtk....
  - 434261 _gtk_toolbar_elide_underscores incorrectly handles some s...
  - 383354 ctrl-L should make 'Location' entry disappear
  - 418673 gtk_recent_manager_add_item
  - 429732 gtk_accel_group_finalize accesses invalid memory
  - 435028 WM_CLIENT_LEADER is wrong on the leader_window
  - 431067 Background of the header window is not updated
  - 338843 add recent files support inside the ui manager
  - 148535 add drop shadow to menus, tooltips, etc. under Windows XP
* debian/control.in:
  - Conflicts on ubuntulooks (<= 0.9.11-1)
* debian/patches/15_default-fallback-icon-theme.patch:
  - patch from Debian, fallback on gnome icon theme

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/xml/gtkitemfactory.xml
 
1
<refentry id="GtkItemFactory">
 
2
<refmeta>
 
3
<refentrytitle role="top_of_page">GtkItemFactory</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>GTK Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>GtkItemFactory</refname>
 
10
<refpurpose>A factory for menus</refpurpose>
 
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
12
</refnamediv>
 
13
 
 
14
<refsynopsisdiv role="synopsis">
 
15
<title role="synopsis.title">Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
#include &lt;gtk/gtk.h&gt;
 
20
 
 
21
 
 
22
                    <link linkend="GtkItemFactory-struct">GtkItemFactory</link>;
 
23
<link linkend="void">void</link>                (<link linkend="GtkPrintFunc">*GtkPrintFunc</link>)                     (<link linkend="gpointer">gpointer</link> func_data,
 
24
                                                         const <link linkend="gchar">gchar</link> *str);
 
25
<link linkend="gchar">gchar</link>*              (<link linkend="GtkTranslateFunc">*GtkTranslateFunc</link>)                 (const <link linkend="gchar">gchar</link> *path,
 
26
                                                         <link linkend="gpointer">gpointer</link> func_data);
 
27
<link linkend="void">void</link>                (<link linkend="GtkItemFactoryCallback">*GtkItemFactoryCallback</link>)           ();
 
28
<link linkend="void">void</link>                (<link linkend="GtkItemFactoryCallback1">*GtkItemFactoryCallback1</link>)          (<link linkend="gpointer">gpointer</link> callback_data,
 
29
                                                         <link linkend="guint">guint</link> callback_action,
 
30
                                                         <link linkend="GtkWidget">GtkWidget</link> *widget);
 
31
<link linkend="void">void</link>                (<link linkend="GtkItemFactoryCallback2">*GtkItemFactoryCallback2</link>)          (<link linkend="GtkWidget">GtkWidget</link> *widget,
 
32
                                                         <link linkend="gpointer">gpointer</link> callback_data,
 
33
                                                         <link linkend="guint">guint</link> callback_action);
 
34
                    <link linkend="GtkItemFactoryEntry">GtkItemFactoryEntry</link>;
 
35
                    <link linkend="GtkItemFactoryItem">GtkItemFactoryItem</link>;
 
36
<link linkend="GtkItemFactory">GtkItemFactory</link>*     <link linkend="gtk-item-factory-new">gtk_item_factory_new</link>                (<link linkend="GType">GType</link> container_type,
 
37
                                                         const <link linkend="gchar">gchar</link> *path,
 
38
                                                         <link linkend="GtkAccelGroup">GtkAccelGroup</link> *accel_group);
 
39
<link linkend="void">void</link>                <link linkend="gtk-item-factory-construct">gtk_item_factory_construct</link>          (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
40
                                                         <link linkend="GType">GType</link> container_type,
 
41
                                                         const <link linkend="gchar">gchar</link> *path,
 
42
                                                         <link linkend="GtkAccelGroup">GtkAccelGroup</link> *accel_group);
 
43
<link linkend="void">void</link>                <link linkend="gtk-item-factory-add-foreign">gtk_item_factory_add_foreign</link>        (<link linkend="GtkWidget">GtkWidget</link> *accel_widget,
 
44
                                                         const <link linkend="gchar">gchar</link> *full_path,
 
45
                                                         <link linkend="GtkAccelGroup">GtkAccelGroup</link> *accel_group,
 
46
                                                         <link linkend="guint">guint</link> keyval,
 
47
                                                         <link linkend="GdkModifierType">GdkModifierType</link> modifiers);
 
48
<link linkend="GtkItemFactory">GtkItemFactory</link>*     <link linkend="gtk-item-factory-from-widget">gtk_item_factory_from_widget</link>        (<link linkend="GtkWidget">GtkWidget</link> *widget);
 
49
const <link linkend="gchar">gchar</link>*        <link linkend="gtk-item-factory-path-from-widget">gtk_item_factory_path_from_widget</link>   (<link linkend="GtkWidget">GtkWidget</link> *widget);
 
50
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-item-factory-get-item">gtk_item_factory_get_item</link>           (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
51
                                                         const <link linkend="gchar">gchar</link> *path);
 
52
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-item-factory-get-widget">gtk_item_factory_get_widget</link>         (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
53
                                                         const <link linkend="gchar">gchar</link> *path);
 
54
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-item-factory-get-widget-by-action">gtk_item_factory_get_widget_by_action</link>
 
55
                                                        (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
56
                                                         <link linkend="guint">guint</link> action);
 
57
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-item-factory-get-item-by-action">gtk_item_factory_get_item_by_action</link> (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
58
                                                         <link linkend="guint">guint</link> action);
 
59
<link linkend="void">void</link>                <link linkend="gtk-item-factory-create-item">gtk_item_factory_create_item</link>        (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
60
                                                         <link linkend="GtkItemFactoryEntry">GtkItemFactoryEntry</link> *entry,
 
61
                                                         <link linkend="gpointer">gpointer</link> callback_data,
 
62
                                                         <link linkend="guint">guint</link> callback_type);
 
63
<link linkend="void">void</link>                <link linkend="gtk-item-factory-create-items">gtk_item_factory_create_items</link>       (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
64
                                                         <link linkend="guint">guint</link> n_entries,
 
65
                                                         <link linkend="GtkItemFactoryEntry">GtkItemFactoryEntry</link> *entries,
 
66
                                                         <link linkend="gpointer">gpointer</link> callback_data);
 
67
<link linkend="void">void</link>                <link linkend="gtk-item-factory-create-items-ac">gtk_item_factory_create_items_ac</link>    (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
68
                                                         <link linkend="guint">guint</link> n_entries,
 
69
                                                         <link linkend="GtkItemFactoryEntry">GtkItemFactoryEntry</link> *entries,
 
70
                                                         <link linkend="gpointer">gpointer</link> callback_data,
 
71
                                                         <link linkend="guint">guint</link> callback_type);
 
72
<link linkend="void">void</link>                <link linkend="gtk-item-factory-delete-item">gtk_item_factory_delete_item</link>        (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
73
                                                         const <link linkend="gchar">gchar</link> *path);
 
74
<link linkend="void">void</link>                <link linkend="gtk-item-factory-delete-entry">gtk_item_factory_delete_entry</link>       (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
75
                                                         <link linkend="GtkItemFactoryEntry">GtkItemFactoryEntry</link> *entry);
 
76
<link linkend="void">void</link>                <link linkend="gtk-item-factory-delete-entries">gtk_item_factory_delete_entries</link>     (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
77
                                                         <link linkend="guint">guint</link> n_entries,
 
78
                                                         <link linkend="GtkItemFactoryEntry">GtkItemFactoryEntry</link> *entries);
 
79
<link linkend="void">void</link>                <link linkend="gtk-item-factory-popup">gtk_item_factory_popup</link>              (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
80
                                                         <link linkend="guint">guint</link> x,
 
81
                                                         <link linkend="guint">guint</link> y,
 
82
                                                         <link linkend="guint">guint</link> mouse_button,
 
83
                                                         <link linkend="guint32">guint32</link> time_);
 
84
<link linkend="void">void</link>                <link linkend="gtk-item-factory-popup-with-data">gtk_item_factory_popup_with_data</link>    (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
85
                                                         <link linkend="gpointer">gpointer</link> popup_data,
 
86
                                                         <link linkend="GtkDestroyNotify">GtkDestroyNotify</link> destroy,
 
87
                                                         <link linkend="guint">guint</link> x,
 
88
                                                         <link linkend="guint">guint</link> y,
 
89
                                                         <link linkend="guint">guint</link> mouse_button,
 
90
                                                         <link linkend="guint32">guint32</link> time_);
 
91
<link linkend="gpointer">gpointer</link>            <link linkend="gtk-item-factory-popup-data">gtk_item_factory_popup_data</link>         (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory);
 
92
<link linkend="gpointer">gpointer</link>            <link linkend="gtk-item-factory-popup-data-from-widget">gtk_item_factory_popup_data_from_widget</link>
 
93
                                                        (<link linkend="GtkWidget">GtkWidget</link> *widget);
 
94
<link linkend="GtkItemFactory">GtkItemFactory</link>*     <link linkend="gtk-item-factory-from-path">gtk_item_factory_from_path</link>          (const <link linkend="gchar">gchar</link> *path);
 
95
<link linkend="void">void</link>                <link linkend="gtk-item-factory-create-menu-entries">gtk_item_factory_create_menu_entries</link>
 
96
                                                        (<link linkend="guint">guint</link> n_entries,
 
97
                                                         <link linkend="GtkMenuEntry">GtkMenuEntry</link> *entries);
 
98
<link linkend="void">void</link>                <link linkend="gtk-item-factories-path-delete">gtk_item_factories_path_delete</link>      (const <link linkend="gchar">gchar</link> *ifactory_path,
 
99
                                                         const <link linkend="gchar">gchar</link> *path);
 
100
<link linkend="void">void</link>                <link linkend="gtk-item-factory-set-translate-func">gtk_item_factory_set_translate_func</link> (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
101
                                                         <link linkend="GtkTranslateFunc">GtkTranslateFunc</link> func,
 
102
                                                         <link linkend="gpointer">gpointer</link> data,
 
103
                                                         <link linkend="GtkDestroyNotify">GtkDestroyNotify</link> notify);
 
104
 
 
105
 
 
106
</synopsis>
 
107
</refsynopsisdiv>
 
108
 
 
109
<refsect1 role="object_hierarchy">
 
110
<title role="object_hierarchy.title">Object Hierarchy</title>
 
111
<synopsis>
 
112
 
 
113
  <link linkend="GObject">GObject</link>
 
114
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
115
         +----<link linkend="GtkObject">GtkObject</link>
 
116
               +----GtkItemFactory
 
117
</synopsis>
 
118
 
 
119
</refsect1>
 
120
 
 
121
 
 
122
 
 
123
 
 
124
 
 
125
 
 
126
 
 
127
 
 
128
<refsect1 role="desc">
 
129
<title role="desc.title">Description</title>
 
130
<para>
 
131
As of GTK+ 2.4, <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link> has been deprecated in favour of <link linkend="GtkUIManager"><type>GtkUIManager</type></link>.
 
132
</para>
 
133
</refsect1>
 
134
 
 
135
<refsect1 role="details">
 
136
<title role="details.title">Details</title>
 
137
<refsect2>
 
138
<title><anchor id="GtkItemFactory-struct" role="struct"/>GtkItemFactory</title>
 
139
<indexterm role="deprecated"><primary>GtkItemFactory</primary></indexterm><programlisting>typedef struct _GtkItemFactory GtkItemFactory;</programlisting>
 
140
<warning><para><literal>GtkItemFactory</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
141
<para>
 
142
 
 
143
</para></refsect2>
 
144
<refsect2>
 
145
<title><anchor id="GtkPrintFunc" role="function" condition="deprecated:"/>GtkPrintFunc ()</title>
 
146
<indexterm role="deprecated"><primary>GtkPrintFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*GtkPrintFunc)                     (<link linkend="gpointer">gpointer</link> func_data,
 
147
                                                         const <link linkend="gchar">gchar</link> *str);</programlisting>
 
148
<warning><para><literal>GtkPrintFunc</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
149
<para>
 
150
 
 
151
</para><variablelist role="params">
 
152
<varlistentry><term><parameter>func_data</parameter>&nbsp;:</term>
 
153
<listitem><simpara>
 
154
</simpara></listitem></varlistentry>
 
155
<varlistentry><term><parameter>str</parameter>&nbsp;:</term>
 
156
<listitem><simpara>
 
157
 
 
158
 
 
159
</simpara></listitem></varlistentry>
 
160
</variablelist></refsect2>
 
161
<refsect2>
 
162
<title><anchor id="GtkTranslateFunc" role="function"/>GtkTranslateFunc ()</title>
 
163
<indexterm><primary>GtkTranslateFunc</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              (*GtkTranslateFunc)                 (const <link linkend="gchar">gchar</link> *path,
 
164
                                                         <link linkend="gpointer">gpointer</link> func_data);</programlisting>
 
165
<para>
 
166
The function used to translate messages in e.g. <link linkend="GtkIconFactory"><type>GtkIconFactory</type></link>
 
167
and <link linkend="GtkActionGroup"><type>GtkActionGroup</type></link>. 
 
168
</para><variablelist role="params">
 
169
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
170
<listitem><simpara>The id of the message. In <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link> this will be a path
 
171
  from a <link linkend="GtkItemFactoryEntry"><type>GtkItemFactoryEntry</type></link>, in <link linkend="GtkActionGroup"><type>GtkActionGroup</type></link>, it will be a label
 
172
  or tooltip from a <link linkend="GtkActionEntry"><type>GtkActionEntry</type></link>.
 
173
</simpara></listitem></varlistentry>
 
174
<varlistentry><term><parameter>func_data</parameter>&nbsp;:</term>
 
175
<listitem><simpara>user data passed in when registering the function
 
176
</simpara></listitem></varlistentry>
 
177
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the translated message
 
178
 
 
179
 
 
180
</simpara></listitem></varlistentry>
 
181
</variablelist></refsect2>
 
182
<refsect2>
 
183
<title><anchor id="GtkItemFactoryCallback" role="function" condition="deprecated:"/>GtkItemFactoryCallback ()</title>
 
184
<indexterm role="deprecated"><primary>GtkItemFactoryCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GtkItemFactoryCallback)           ();</programlisting>
 
185
<warning><para><literal>GtkItemFactoryCallback</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
186
<para>
 
187
 
 
188
</para></refsect2>
 
189
<refsect2>
 
190
<title><anchor id="GtkItemFactoryCallback1" role="function" condition="deprecated:"/>GtkItemFactoryCallback1 ()</title>
 
191
<indexterm role="deprecated"><primary>GtkItemFactoryCallback1</primary></indexterm><programlisting><link linkend="void">void</link>                (*GtkItemFactoryCallback1)          (<link linkend="gpointer">gpointer</link> callback_data,
 
192
                                                         <link linkend="guint">guint</link> callback_action,
 
193
                                                         <link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>
 
194
<warning><para><literal>GtkItemFactoryCallback1</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
195
<para>
 
196
 
 
197
</para><variablelist role="params">
 
198
<varlistentry><term><parameter>callback_data</parameter>&nbsp;:</term>
 
199
<listitem><simpara>
 
200
</simpara></listitem></varlistentry>
 
201
<varlistentry><term><parameter>callback_action</parameter>&nbsp;:</term>
 
202
<listitem><simpara>
 
203
</simpara></listitem></varlistentry>
 
204
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
 
205
<listitem><simpara>
 
206
 
 
207
 
 
208
</simpara></listitem></varlistentry>
 
209
</variablelist></refsect2>
 
210
<refsect2>
 
211
<title><anchor id="GtkItemFactoryCallback2" role="function" condition="deprecated:"/>GtkItemFactoryCallback2 ()</title>
 
212
<indexterm role="deprecated"><primary>GtkItemFactoryCallback2</primary></indexterm><programlisting><link linkend="void">void</link>                (*GtkItemFactoryCallback2)          (<link linkend="GtkWidget">GtkWidget</link> *widget,
 
213
                                                         <link linkend="gpointer">gpointer</link> callback_data,
 
214
                                                         <link linkend="guint">guint</link> callback_action);</programlisting>
 
215
<warning><para><literal>GtkItemFactoryCallback2</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
216
<para>
 
217
 
 
218
</para><variablelist role="params">
 
219
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
 
220
<listitem><simpara>
 
221
</simpara></listitem></varlistentry>
 
222
<varlistentry><term><parameter>callback_data</parameter>&nbsp;:</term>
 
223
<listitem><simpara>
 
224
</simpara></listitem></varlistentry>
 
225
<varlistentry><term><parameter>callback_action</parameter>&nbsp;:</term>
 
226
<listitem><simpara>
 
227
 
 
228
 
 
229
</simpara></listitem></varlistentry>
 
230
</variablelist></refsect2>
 
231
<refsect2>
 
232
<title><anchor id="GtkItemFactoryEntry" role="struct" condition="deprecated:"/>GtkItemFactoryEntry</title>
 
233
<indexterm role="deprecated"><primary>GtkItemFactoryEntry</primary></indexterm><programlisting>typedef struct {
 
234
  gchar *path;
 
235
  gchar *accelerator;
 
236
 
 
237
  GtkItemFactoryCallback callback;
 
238
  guint                  callback_action;
 
239
 
 
240
  /* possible values:
 
241
   * NULL               -&gt; "&lt;Item&gt;"
 
242
   * ""                 -&gt; "&lt;Item&gt;"
 
243
   * "&lt;Title&gt;"            -&gt; create a title item
 
244
   * "&lt;Item&gt;"             -&gt; create a simple item
 
245
   * "&lt;ImageItem&gt;"        -&gt; create an item holding an image
 
246
   * "&lt;StockItem&gt;"        -&gt; create an item holding a stock image
 
247
   * "&lt;CheckItem&gt;"        -&gt; create a check item
 
248
   * "&lt;ToggleItem&gt;"       -&gt; create a toggle item
 
249
   * "&lt;RadioItem&gt;"        -&gt; create a radio item
 
250
   * &lt;path&gt;               -&gt; path of a radio item to link against
 
251
   * "&lt;Separator&gt;"        -&gt; create a separator
 
252
   * "&lt;Tearoff&gt;"  -&gt; create a tearoff separator
 
253
   * "&lt;Branch&gt;"           -&gt; create an item to hold sub items
 
254
   * "&lt;LastBranch&gt;"       -&gt; create a right justified item to hold sub items
 
255
   */
 
256
  gchar          *item_type;
 
257
 
 
258
  /* Extra data for some item types:
 
259
   *  ImageItem  -&gt; pointer to inlined pixbuf stream
 
260
   *  StockItem  -&gt; name of stock item
 
261
   */
 
262
  gconstpointer extra_data;
 
263
} GtkItemFactoryEntry;
 
264
</programlisting>
 
265
<warning><para><literal>GtkItemFactoryEntry</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
266
<para>
 
267
 
 
268
</para></refsect2>
 
269
<refsect2>
 
270
<title><anchor id="GtkItemFactoryItem" role="struct" condition="deprecated:"/>GtkItemFactoryItem</title>
 
271
<indexterm role="deprecated"><primary>GtkItemFactoryItem</primary></indexterm><programlisting>typedef struct {
 
272
  gchar *path;
 
273
  GSList *widgets;
 
274
} GtkItemFactoryItem;
 
275
</programlisting>
 
276
<warning><para><literal>GtkItemFactoryItem</literal> is deprecated and should not be used in newly-written code.</para></warning>
 
277
<para>
 
278
 
 
279
</para></refsect2>
 
280
<refsect2>
 
281
<title><anchor id="gtk-item-factory-new" role="function" condition="deprecated:2.4:"/>gtk_item_factory_new ()</title>
 
282
<indexterm role="deprecated"><primary>gtk_item_factory_new</primary></indexterm><programlisting><link linkend="GtkItemFactory">GtkItemFactory</link>*     gtk_item_factory_new                (<link linkend="GType">GType</link> container_type,
 
283
                                                         const <link linkend="gchar">gchar</link> *path,
 
284
                                                         <link linkend="GtkAccelGroup">GtkAccelGroup</link> *accel_group);</programlisting>
 
285
<warning><para><literal>gtk_item_factory_new</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
286
<para>
 
287
Creates a new <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>.
 
288
</para>
 
289
<para>
 
290
Beware that the returned object does not have a floating reference.</para>
 
291
<para>
 
292
 
 
293
</para><variablelist role="params">
 
294
<varlistentry><term><parameter>container_type</parameter>&nbsp;:</term>
 
295
<listitem><simpara> the kind of menu to create; can be
 
296
   <link linkend="GTK-TYPE-MENU-BAR:CAPS"><type>GTK_TYPE_MENU_BAR</type></link>, <link linkend="GTK-TYPE-MENU:CAPS"><type>GTK_TYPE_MENU</type></link> or <link linkend="GTK-TYPE-OPTION-MENU:CAPS"><type>GTK_TYPE_OPTION_MENU</type></link>
 
297
</simpara></listitem></varlistentry>
 
298
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
299
<listitem><simpara> the factory path of the new item factory, a string of the form 
 
300
   <literal>"&lt;name&gt;"</literal>
 
301
</simpara></listitem></varlistentry>
 
302
<varlistentry><term><parameter>accel_group</parameter>&nbsp;:</term>
 
303
<listitem><simpara> a <link linkend="GtkAccelGroup"><type>GtkAccelGroup</type></link> to which the accelerators for the
 
304
   menu items will be added, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to create a new one
 
305
</simpara></listitem></varlistentry>
 
306
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>
 
307
</simpara></listitem></varlistentry>
 
308
</variablelist></refsect2>
 
309
<refsect2>
 
310
<title><anchor id="gtk-item-factory-construct" role="function" condition="deprecated:2.4:"/>gtk_item_factory_construct ()</title>
 
311
<indexterm role="deprecated"><primary>gtk_item_factory_construct</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_item_factory_construct          (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
312
                                                         <link linkend="GType">GType</link> container_type,
 
313
                                                         const <link linkend="gchar">gchar</link> *path,
 
314
                                                         <link linkend="GtkAccelGroup">GtkAccelGroup</link> *accel_group);</programlisting>
 
315
<warning><para><literal>gtk_item_factory_construct</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
316
<para>
 
317
Initializes an item factory.</para>
 
318
<para>
 
319
 
 
320
</para><variablelist role="params">
 
321
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
322
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>
 
323
</simpara></listitem></varlistentry>
 
324
<varlistentry><term><parameter>container_type</parameter>&nbsp;:</term>
 
325
<listitem><simpara> the kind of menu to create; can be
 
326
   <link linkend="GTK-TYPE-MENU-BAR:CAPS"><type>GTK_TYPE_MENU_BAR</type></link>, <link linkend="GTK-TYPE-MENU:CAPS"><type>GTK_TYPE_MENU</type></link> or <link linkend="GTK-TYPE-OPTION-MENU:CAPS"><type>GTK_TYPE_OPTION_MENU</type></link>
 
327
</simpara></listitem></varlistentry>
 
328
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
329
<listitem><simpara> the factory path of <parameter>ifactory</parameter>, a string of the form 
 
330
   <literal>"&lt;name&gt;"</literal>
 
331
</simpara></listitem></varlistentry>
 
332
<varlistentry><term><parameter>accel_group</parameter>&nbsp;:</term>
 
333
<listitem><simpara> a <link linkend="GtkAccelGroup"><type>GtkAccelGroup</type></link> to which the accelerators for the
 
334
   menu items will be added, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to create a new one
 
335
</simpara></listitem></varlistentry>
 
336
</variablelist></refsect2>
 
337
<refsect2>
 
338
<title><anchor id="gtk-item-factory-add-foreign" role="function" condition="deprecated"/>gtk_item_factory_add_foreign ()</title>
 
339
<indexterm role="deprecated"><primary>gtk_item_factory_add_foreign</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_item_factory_add_foreign        (<link linkend="GtkWidget">GtkWidget</link> *accel_widget,
 
340
                                                         const <link linkend="gchar">gchar</link> *full_path,
 
341
                                                         <link linkend="GtkAccelGroup">GtkAccelGroup</link> *accel_group,
 
342
                                                         <link linkend="guint">guint</link> keyval,
 
343
                                                         <link linkend="GdkModifierType">GdkModifierType</link> modifiers);</programlisting>
 
344
<warning><para><literal>gtk_item_factory_add_foreign</literal> has been deprecated since version 2.4 and should not be used in newly-written code. The recommended API for this purpose are the functions 
 
345
<link linkend="gtk-menu-item-set-accel-path"><function>gtk_menu_item_set_accel_path()</function></link> and <link linkend="gtk-widget-set-accel-path"><function>gtk_widget_set_accel_path()</function></link>; don't 
 
346
use <link linkend="gtk-item-factory-add-foreign"><function>gtk_item_factory_add_foreign()</function></link> in new code, since it is likely to
 
347
be removed in the future.</para></warning>
 
348
<para>
 
349
Installs an accelerator for <parameter>accel_widget</parameter> in <parameter>accel_group</parameter>, that causes
 
350
the ::activate signal to be emitted if the accelerator is activated.
 
351
</para>
 
352
<para>
 
353
This function can be used to make widgets participate in the accel
 
354
saving/restoring functionality provided by <link linkend="gtk-accel-map-save"><function>gtk_accel_map_save()</function></link> and
 
355
<link linkend="gtk-accel-map-load"><function>gtk_accel_map_load()</function></link>, even if they haven't been created by an item
 
356
factory.</para>
 
357
<para>
 
358
 
 
359
</para><variablelist role="params">
 
360
<varlistentry><term><parameter>accel_widget</parameter>&nbsp;:</term>
 
361
<listitem><simpara>     widget to install an accelerator on 
 
362
</simpara></listitem></varlistentry>
 
363
<varlistentry><term><parameter>full_path</parameter>&nbsp;:</term>
 
364
<listitem><simpara>           the full path for the <parameter>accel_widget</parameter> 
 
365
</simpara></listitem></varlistentry>
 
366
<varlistentry><term><parameter>accel_group</parameter>&nbsp;:</term>
 
367
<listitem><simpara>      the accelerator group to install the accelerator in
 
368
</simpara></listitem></varlistentry>
 
369
<varlistentry><term><parameter>keyval</parameter>&nbsp;:</term>
 
370
<listitem><simpara>           key value of the accelerator
 
371
</simpara></listitem></varlistentry>
 
372
<varlistentry><term><parameter>modifiers</parameter>&nbsp;:</term>
 
373
<listitem><simpara>        modifier combination of the accelerator
 
374
</simpara></listitem></varlistentry>
 
375
</variablelist></refsect2>
 
376
<refsect2>
 
377
<title><anchor id="gtk-item-factory-from-widget" role="function" condition="deprecated:2.4"/>gtk_item_factory_from_widget ()</title>
 
378
<indexterm role="deprecated"><primary>gtk_item_factory_from_widget</primary></indexterm><programlisting><link linkend="GtkItemFactory">GtkItemFactory</link>*     gtk_item_factory_from_widget        (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>
 
379
<warning><para><literal>gtk_item_factory_from_widget</literal> is deprecated and should not be used in newly-written code. 2.4</para></warning>
 
380
<para>
 
381
Obtains the item factory from which a widget was created.</para>
 
382
<para>
 
383
 
 
384
</para><variablelist role="params">
 
385
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
 
386
<listitem><simpara> a widget
 
387
</simpara></listitem></varlistentry>
 
388
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the item factory from which <parameter>widget</parameter> was created, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
389
</simpara></listitem></varlistentry>
 
390
</variablelist></refsect2>
 
391
<refsect2>
 
392
<title><anchor id="gtk-item-factory-path-from-widget" role="function" condition="deprecated:2.4:"/>gtk_item_factory_path_from_widget ()</title>
 
393
<indexterm role="deprecated"><primary>gtk_item_factory_path_from_widget</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        gtk_item_factory_path_from_widget   (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>
 
394
<warning><para><literal>gtk_item_factory_path_from_widget</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
395
<para>
 
396
If <parameter>widget</parameter> has been created by an item factory, returns the full path
 
397
to it. (The full path of a widget is the concatenation of the factory 
 
398
path specified in <link linkend="gtk-item-factory-new"><function>gtk_item_factory_new()</function></link> with the path specified in the 
 
399
<link linkend="GtkItemFactoryEntry"><type>GtkItemFactoryEntry</type></link> from which the widget was created.)</para>
 
400
<para>
 
401
 
 
402
</para><variablelist role="params">
 
403
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
 
404
<listitem><simpara> a widget
 
405
</simpara></listitem></varlistentry>
 
406
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the full path to <parameter>widget</parameter> if it has been created by an item
 
407
  factory, <link linkend="NULL:CAPS"><literal>NULL</literal></link> otherwise. This value is owned by GTK+ and must not be
 
408
  modified or freed.
 
409
</simpara></listitem></varlistentry>
 
410
</variablelist></refsect2>
 
411
<refsect2>
 
412
<title><anchor id="gtk-item-factory-get-item" role="function" condition="deprecated:2.4:"/>gtk_item_factory_get_item ()</title>
 
413
<indexterm role="deprecated"><primary>gtk_item_factory_get_item</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_item_factory_get_item           (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
414
                                                         const <link linkend="gchar">gchar</link> *path);</programlisting>
 
415
<warning><para><literal>gtk_item_factory_get_item</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
416
<para>
 
417
Obtains the menu item which corresponds to <parameter>path</parameter>. 
 
418
</para>
 
419
<para>
 
420
If the widget corresponding to <parameter>path</parameter> is a menu item which opens a 
 
421
submenu, then the item is returned. If you are interested in the submenu, 
 
422
use <link linkend="gtk-item-factory-get-widget"><function>gtk_item_factory_get_widget()</function></link> instead.</para>
 
423
<para>
 
424
 
 
425
</para><variablelist role="params">
 
426
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
427
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>
 
428
</simpara></listitem></varlistentry>
 
429
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
430
<listitem><simpara> the path to the menu item
 
431
</simpara></listitem></varlistentry>
 
432
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the menu item for the given path, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>path</parameter> doesn't
 
433
  lead to a menu item
 
434
</simpara></listitem></varlistentry>
 
435
</variablelist></refsect2>
 
436
<refsect2>
 
437
<title><anchor id="gtk-item-factory-get-widget" role="function" condition="deprecated:2.4:"/>gtk_item_factory_get_widget ()</title>
 
438
<indexterm role="deprecated"><primary>gtk_item_factory_get_widget</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_item_factory_get_widget         (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
439
                                                         const <link linkend="gchar">gchar</link> *path);</programlisting>
 
440
<warning><para><literal>gtk_item_factory_get_widget</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
441
<para>
 
442
Obtains the widget which corresponds to <parameter>path</parameter>. 
 
443
</para>
 
444
<para>
 
445
If the widget corresponding to <parameter>path</parameter> is a menu item which opens a 
 
446
submenu, then the submenu is returned. If you are interested in the menu 
 
447
item, use <link linkend="gtk-item-factory-get-item"><function>gtk_item_factory_get_item()</function></link> instead.</para>
 
448
<para>
 
449
 
 
450
</para><variablelist role="params">
 
451
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
452
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>
 
453
</simpara></listitem></varlistentry>
 
454
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
455
<listitem><simpara> the path to the widget
 
456
</simpara></listitem></varlistentry>
 
457
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the widget for the given path, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>path</parameter> doesn't lead
 
458
  to a widget
 
459
</simpara></listitem></varlistentry>
 
460
</variablelist></refsect2>
 
461
<refsect2>
 
462
<title><anchor id="gtk-item-factory-get-widget-by-action" role="function" condition="deprecated:2.4:"/>gtk_item_factory_get_widget_by_action ()</title>
 
463
<indexterm role="deprecated"><primary>gtk_item_factory_get_widget_by_action</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_item_factory_get_widget_by_action
 
464
                                                        (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
465
                                                         <link linkend="guint">guint</link> action);</programlisting>
 
466
<warning><para><literal>gtk_item_factory_get_widget_by_action</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
467
<para>
 
468
Obtains the widget which was constructed from the <link linkend="GtkItemFactoryEntry"><type>GtkItemFactoryEntry</type></link>
 
469
with the given <parameter>action</parameter>.
 
470
</para>
 
471
<para>
 
472
If there are multiple items with the same action, the result is 
 
473
undefined.</para>
 
474
<para>
 
475
 
 
476
</para><variablelist role="params">
 
477
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
478
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>
 
479
</simpara></listitem></varlistentry>
 
480
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
 
481
<listitem><simpara> an action as specified in the <parameter>callback_action</parameter> field
 
482
  of <link linkend="GtkItemFactoryEntry"><type>GtkItemFactoryEntry</type></link>
 
483
</simpara></listitem></varlistentry>
 
484
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the widget which corresponds to the given action, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
485
  if no widget was found
 
486
</simpara></listitem></varlistentry>
 
487
</variablelist></refsect2>
 
488
<refsect2>
 
489
<title><anchor id="gtk-item-factory-get-item-by-action" role="function" condition="deprecated:2.4:"/>gtk_item_factory_get_item_by_action ()</title>
 
490
<indexterm role="deprecated"><primary>gtk_item_factory_get_item_by_action</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_item_factory_get_item_by_action (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
491
                                                         <link linkend="guint">guint</link> action);</programlisting>
 
492
<warning><para><literal>gtk_item_factory_get_item_by_action</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
493
<para>
 
494
Obtains the menu item which was constructed from the first 
 
495
<link linkend="GtkItemFactoryEntry"><type>GtkItemFactoryEntry</type></link> with the given <parameter>action</parameter>.</para>
 
496
<para>
 
497
 
 
498
</para><variablelist role="params">
 
499
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
500
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>
 
501
</simpara></listitem></varlistentry>
 
502
<varlistentry><term><parameter>action</parameter>&nbsp;:</term>
 
503
<listitem><simpara> an action as specified in the <parameter>callback_action</parameter> field
 
504
  of <link linkend="GtkItemFactoryEntry"><type>GtkItemFactoryEntry</type></link>
 
505
</simpara></listitem></varlistentry>
 
506
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the menu item which corresponds to the given action, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
507
  if no menu item was found
 
508
</simpara></listitem></varlistentry>
 
509
</variablelist></refsect2>
 
510
<refsect2>
 
511
<title><anchor id="gtk-item-factory-create-item" role="function" condition="deprecated:2.4:"/>gtk_item_factory_create_item ()</title>
 
512
<indexterm role="deprecated"><primary>gtk_item_factory_create_item</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_item_factory_create_item        (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
513
                                                         <link linkend="GtkItemFactoryEntry">GtkItemFactoryEntry</link> *entry,
 
514
                                                         <link linkend="gpointer">gpointer</link> callback_data,
 
515
                                                         <link linkend="guint">guint</link> callback_type);</programlisting>
 
516
<warning><para><literal>gtk_item_factory_create_item</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
517
<para>
 
518
Creates an item for <parameter>entry</parameter>.</para>
 
519
<para>
 
520
 
 
521
</para><variablelist role="params">
 
522
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
523
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>
 
524
</simpara></listitem></varlistentry>
 
525
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
526
<listitem><simpara> the <link linkend="GtkItemFactoryEntry"><type>GtkItemFactoryEntry</type></link> to create an item for
 
527
</simpara></listitem></varlistentry>
 
528
<varlistentry><term><parameter>callback_data</parameter>&nbsp;:</term>
 
529
<listitem><simpara> data passed to the callback function of <parameter>entry</parameter>
 
530
</simpara></listitem></varlistentry>
 
531
<varlistentry><term><parameter>callback_type</parameter>&nbsp;:</term>
 
532
<listitem><simpara> 1 if the callback function of <parameter>entry</parameter> is of type
 
533
   <link linkend="GtkItemFactoryCallback1"><type>GtkItemFactoryCallback1</type></link>, 2 if it is of type <link linkend="GtkItemFactoryCallback2"><type>GtkItemFactoryCallback2</type></link> 
 
534
</simpara></listitem></varlistentry>
 
535
</variablelist></refsect2>
 
536
<refsect2>
 
537
<title><anchor id="gtk-item-factory-create-items" role="function" condition="deprecated:2.4:"/>gtk_item_factory_create_items ()</title>
 
538
<indexterm role="deprecated"><primary>gtk_item_factory_create_items</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_item_factory_create_items       (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
539
                                                         <link linkend="guint">guint</link> n_entries,
 
540
                                                         <link linkend="GtkItemFactoryEntry">GtkItemFactoryEntry</link> *entries,
 
541
                                                         <link linkend="gpointer">gpointer</link> callback_data);</programlisting>
 
542
<warning><para><literal>gtk_item_factory_create_items</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
543
<para>
 
544
Creates the menu items from the <parameter>entries</parameter>.</para>
 
545
<para>
 
546
 
 
547
</para><variablelist role="params">
 
548
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
549
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>
 
550
</simpara></listitem></varlistentry>
 
551
<varlistentry><term><parameter>n_entries</parameter>&nbsp;:</term>
 
552
<listitem><simpara> the length of <parameter>entries</parameter>
 
553
</simpara></listitem></varlistentry>
 
554
<varlistentry><term><parameter>entries</parameter>&nbsp;:</term>
 
555
<listitem><simpara> an array of <link linkend="GtkItemFactoryEntry"><type>GtkItemFactoryEntry</type></link><!-- -->s whose <parameter>callback</parameter> members
 
556
   must by of type <link linkend="GtkItemFactoryCallback1"><type>GtkItemFactoryCallback1</type></link>
 
557
</simpara></listitem></varlistentry>
 
558
<varlistentry><term><parameter>callback_data</parameter>&nbsp;:</term>
 
559
<listitem><simpara> data passed to the callback functions of all entries
 
560
</simpara></listitem></varlistentry>
 
561
</variablelist></refsect2>
 
562
<refsect2>
 
563
<title><anchor id="gtk-item-factory-create-items-ac" role="function" condition="deprecated:2.4:"/>gtk_item_factory_create_items_ac ()</title>
 
564
<indexterm role="deprecated"><primary>gtk_item_factory_create_items_ac</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_item_factory_create_items_ac    (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
565
                                                         <link linkend="guint">guint</link> n_entries,
 
566
                                                         <link linkend="GtkItemFactoryEntry">GtkItemFactoryEntry</link> *entries,
 
567
                                                         <link linkend="gpointer">gpointer</link> callback_data,
 
568
                                                         <link linkend="guint">guint</link> callback_type);</programlisting>
 
569
<warning><para><literal>gtk_item_factory_create_items_ac</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
570
<para>
 
571
Creates the menu items from the <parameter>entries</parameter>.</para>
 
572
<para>
 
573
 
 
574
</para><variablelist role="params">
 
575
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
576
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>
 
577
</simpara></listitem></varlistentry>
 
578
<varlistentry><term><parameter>n_entries</parameter>&nbsp;:</term>
 
579
<listitem><simpara> the length of <parameter>entries</parameter>
 
580
</simpara></listitem></varlistentry>
 
581
<varlistentry><term><parameter>entries</parameter>&nbsp;:</term>
 
582
<listitem><simpara> an array of <link linkend="GtkItemFactoryEntry"><type>GtkItemFactoryEntry</type></link><!-- -->s 
 
583
</simpara></listitem></varlistentry>
 
584
<varlistentry><term><parameter>callback_data</parameter>&nbsp;:</term>
 
585
<listitem><simpara> data passed to the callback functions of all entries
 
586
</simpara></listitem></varlistentry>
 
587
<varlistentry><term><parameter>callback_type</parameter>&nbsp;:</term>
 
588
<listitem><simpara> 1 if the callback functions in <parameter>entries</parameter> are of type
 
589
   <link linkend="GtkItemFactoryCallback1"><type>GtkItemFactoryCallback1</type></link>, 2 if they are of type <link linkend="GtkItemFactoryCallback2"><type>GtkItemFactoryCallback2</type></link> 
 
590
</simpara></listitem></varlistentry>
 
591
</variablelist></refsect2>
 
592
<refsect2>
 
593
<title><anchor id="gtk-item-factory-delete-item" role="function" condition="deprecated:2.4:"/>gtk_item_factory_delete_item ()</title>
 
594
<indexterm role="deprecated"><primary>gtk_item_factory_delete_item</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_item_factory_delete_item        (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
595
                                                         const <link linkend="gchar">gchar</link> *path);</programlisting>
 
596
<warning><para><literal>gtk_item_factory_delete_item</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
597
<para>
 
598
Deletes the menu item which was created for <parameter>path</parameter> by the given
 
599
item factory.</para>
 
600
<para>
 
601
 
 
602
</para><variablelist role="params">
 
603
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
604
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>
 
605
</simpara></listitem></varlistentry>
 
606
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
607
<listitem><simpara> a path
 
608
</simpara></listitem></varlistentry>
 
609
</variablelist></refsect2>
 
610
<refsect2>
 
611
<title><anchor id="gtk-item-factory-delete-entry" role="function" condition="deprecated:2.4:"/>gtk_item_factory_delete_entry ()</title>
 
612
<indexterm role="deprecated"><primary>gtk_item_factory_delete_entry</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_item_factory_delete_entry       (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
613
                                                         <link linkend="GtkItemFactoryEntry">GtkItemFactoryEntry</link> *entry);</programlisting>
 
614
<warning><para><literal>gtk_item_factory_delete_entry</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
615
<para>
 
616
Deletes the menu item which was created from <parameter>entry</parameter> by the given
 
617
item factory.</para>
 
618
<para>
 
619
 
 
620
</para><variablelist role="params">
 
621
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
622
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>
 
623
</simpara></listitem></varlistentry>
 
624
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
625
<listitem><simpara> a <link linkend="GtkItemFactoryEntry"><type>GtkItemFactoryEntry</type></link>
 
626
</simpara></listitem></varlistentry>
 
627
</variablelist></refsect2>
 
628
<refsect2>
 
629
<title><anchor id="gtk-item-factory-delete-entries" role="function" condition="deprecated:2.4:"/>gtk_item_factory_delete_entries ()</title>
 
630
<indexterm role="deprecated"><primary>gtk_item_factory_delete_entries</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_item_factory_delete_entries     (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
631
                                                         <link linkend="guint">guint</link> n_entries,
 
632
                                                         <link linkend="GtkItemFactoryEntry">GtkItemFactoryEntry</link> *entries);</programlisting>
 
633
<warning><para><literal>gtk_item_factory_delete_entries</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
634
<para>
 
635
Deletes the menu items which were created from the <parameter>entries</parameter> by the given
 
636
item factory.</para>
 
637
<para>
 
638
 
 
639
</para><variablelist role="params">
 
640
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
641
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>
 
642
</simpara></listitem></varlistentry>
 
643
<varlistentry><term><parameter>n_entries</parameter>&nbsp;:</term>
 
644
<listitem><simpara> the length of <parameter>entries</parameter>
 
645
</simpara></listitem></varlistentry>
 
646
<varlistentry><term><parameter>entries</parameter>&nbsp;:</term>
 
647
<listitem><simpara> an array of <link linkend="GtkItemFactoryEntry"><type>GtkItemFactoryEntry</type></link><!-- -->s 
 
648
</simpara></listitem></varlistentry>
 
649
</variablelist></refsect2>
 
650
<refsect2>
 
651
<title><anchor id="gtk-item-factory-popup" role="function" condition="deprecated:2.4:"/>gtk_item_factory_popup ()</title>
 
652
<indexterm role="deprecated"><primary>gtk_item_factory_popup</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_item_factory_popup              (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
653
                                                         <link linkend="guint">guint</link> x,
 
654
                                                         <link linkend="guint">guint</link> y,
 
655
                                                         <link linkend="guint">guint</link> mouse_button,
 
656
                                                         <link linkend="guint32">guint32</link> time_);</programlisting>
 
657
<warning><para><literal>gtk_item_factory_popup</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
658
<para>
 
659
Pops up the menu constructed from the item factory at (<parameter>x</parameter>, <parameter>y</parameter>).
 
660
</para>
 
661
<para>
 
662
The <parameter>mouse_button</parameter> parameter should be the mouse button pressed to initiate
 
663
the menu popup. If the menu popup was initiated by something other than
 
664
a mouse button press, such as a mouse button release or a keypress,
 
665
<parameter>mouse_button</parameter> should be 0.
 
666
</para>
 
667
<para>
 
668
The <parameter>time_</parameter> parameter should be the time stamp of the event that
 
669
initiated the popup. If such an event is not available, use
 
670
<link linkend="gtk-get-current-event-time"><function>gtk_get_current_event_time()</function></link> instead.
 
671
</para>
 
672
<para>
 
673
The operation of the <parameter>mouse_button</parameter> and the <parameter>time_</parameter> parameter is the same
 
674
as the <parameter>button</parameter> and <parameter>activation_time</parameter> parameters for <link linkend="gtk-menu-popup"><function>gtk_menu_popup()</function></link>.</para>
 
675
<para>
 
676
 
 
677
</para><variablelist role="params">
 
678
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
679
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link> of type <link linkend="GTK-TYPE-MENU:CAPS"><type>GTK_TYPE_MENU</type></link> (see <link linkend="gtk-item-factory-new"><function>gtk_item_factory_new()</function></link>)
 
680
</simpara></listitem></varlistentry>
 
681
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
 
682
<listitem><simpara> the x position 
 
683
</simpara></listitem></varlistentry>
 
684
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
 
685
<listitem><simpara> the y position
 
686
</simpara></listitem></varlistentry>
 
687
<varlistentry><term><parameter>mouse_button</parameter>&nbsp;:</term>
 
688
<listitem><simpara> the mouse button which was pressed to initiate the popup
 
689
</simpara></listitem></varlistentry>
 
690
<varlistentry><term><parameter>time_</parameter>&nbsp;:</term>
 
691
<listitem><simpara> the time at which the activation event occurred
 
692
</simpara></listitem></varlistentry>
 
693
</variablelist></refsect2>
 
694
<refsect2>
 
695
<title><anchor id="gtk-item-factory-popup-with-data" role="function" condition="deprecated:2.4:"/>gtk_item_factory_popup_with_data ()</title>
 
696
<indexterm role="deprecated"><primary>gtk_item_factory_popup_with_data</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_item_factory_popup_with_data    (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
697
                                                         <link linkend="gpointer">gpointer</link> popup_data,
 
698
                                                         <link linkend="GtkDestroyNotify">GtkDestroyNotify</link> destroy,
 
699
                                                         <link linkend="guint">guint</link> x,
 
700
                                                         <link linkend="guint">guint</link> y,
 
701
                                                         <link linkend="guint">guint</link> mouse_button,
 
702
                                                         <link linkend="guint32">guint32</link> time_);</programlisting>
 
703
<warning><para><literal>gtk_item_factory_popup_with_data</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
704
<para>
 
705
Pops up the menu constructed from the item factory at (<parameter>x</parameter>, <parameter>y</parameter>). Callbacks
 
706
can access the <parameter>popup_data</parameter> while the menu is posted via 
 
707
<link linkend="gtk-item-factory-popup-data"><function>gtk_item_factory_popup_data()</function></link> and <link linkend="gtk-item-factory-popup-data-from-widget"><function>gtk_item_factory_popup_data_from_widget()</function></link>.
 
708
</para>
 
709
<para>
 
710
The <parameter>mouse_button</parameter> parameter should be the mouse button pressed to initiate
 
711
the menu popup. If the menu popup was initiated by something other than
 
712
a mouse button press, such as a mouse button release or a keypress,
 
713
<parameter>mouse_button</parameter> should be 0.
 
714
</para>
 
715
<para>
 
716
The <parameter>time_</parameter> parameter should be the time stamp of the event that
 
717
initiated the popup. If such an event is not available, use
 
718
<link linkend="gtk-get-current-event-time"><function>gtk_get_current_event_time()</function></link> instead.
 
719
</para>
 
720
<para>
 
721
The operation of the <parameter>mouse_button</parameter> and the <parameter>time_</parameter> parameters is the same
 
722
as the <parameter>button</parameter> and <parameter>activation_time</parameter> parameters for <link linkend="gtk-menu-popup"><function>gtk_menu_popup()</function></link>.</para>
 
723
<para>
 
724
 
 
725
</para><variablelist role="params">
 
726
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
727
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link> of type <link linkend="GTK-TYPE-MENU:CAPS"><type>GTK_TYPE_MENU</type></link> (see <link linkend="gtk-item-factory-new"><function>gtk_item_factory_new()</function></link>)
 
728
</simpara></listitem></varlistentry>
 
729
<varlistentry><term><parameter>popup_data</parameter>&nbsp;:</term>
 
730
<listitem><simpara> data available for callbacks while the menu is posted
 
731
</simpara></listitem></varlistentry>
 
732
<varlistentry><term><parameter>destroy</parameter>&nbsp;:</term>
 
733
<listitem><simpara> a <link linkend="GtkDestroyNotify"><type>GtkDestroyNotify</type></link> function to be called on <parameter>popup_data</parameter> when
 
734
 the menu is unposted
 
735
</simpara></listitem></varlistentry>
 
736
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
 
737
<listitem><simpara> the x position 
 
738
</simpara></listitem></varlistentry>
 
739
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
 
740
<listitem><simpara> the y position
 
741
</simpara></listitem></varlistentry>
 
742
<varlistentry><term><parameter>mouse_button</parameter>&nbsp;:</term>
 
743
<listitem><simpara> the mouse button which was pressed to initiate the popup
 
744
</simpara></listitem></varlistentry>
 
745
<varlistentry><term><parameter>time_</parameter>&nbsp;:</term>
 
746
<listitem><simpara> the time at which the activation event occurred
 
747
</simpara></listitem></varlistentry>
 
748
</variablelist></refsect2>
 
749
<refsect2>
 
750
<title><anchor id="gtk-item-factory-popup-data" role="function" condition="deprecated:2.4:"/>gtk_item_factory_popup_data ()</title>
 
751
<indexterm role="deprecated"><primary>gtk_item_factory_popup_data</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            gtk_item_factory_popup_data         (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory);</programlisting>
 
752
<warning><para><literal>gtk_item_factory_popup_data</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
753
<para>
 
754
Obtains the <parameter>popup_data</parameter> which was passed to 
 
755
<link linkend="gtk-item-factory-popup-with-data"><function>gtk_item_factory_popup_with_data()</function></link>. This data is available until the menu
 
756
is popped down again.</para>
 
757
<para>
 
758
 
 
759
</para><variablelist role="params">
 
760
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
761
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>
 
762
</simpara></listitem></varlistentry>
 
763
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <parameter>popup_data</parameter> associated with <parameter>ifactory</parameter>
 
764
</simpara></listitem></varlistentry>
 
765
</variablelist></refsect2>
 
766
<refsect2>
 
767
<title><anchor id="gtk-item-factory-popup-data-from-widget" role="function" condition="deprecated:2.4:"/>gtk_item_factory_popup_data_from_widget ()</title>
 
768
<indexterm role="deprecated"><primary>gtk_item_factory_popup_data_from_widget</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            gtk_item_factory_popup_data_from_widget
 
769
                                                        (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>
 
770
<warning><para><literal>gtk_item_factory_popup_data_from_widget</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
771
<para>
 
772
Obtains the <parameter>popup_data</parameter> which was passed to 
 
773
<link linkend="gtk-item-factory-popup-with-data"><function>gtk_item_factory_popup_with_data()</function></link>. This data is available until the menu
 
774
is popped down again.</para>
 
775
<para>
 
776
 
 
777
</para><variablelist role="params">
 
778
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
 
779
<listitem><simpara> a widget
 
780
</simpara></listitem></varlistentry>
 
781
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <parameter>popup_data</parameter> associated with the item factory from
 
782
  which <parameter>widget</parameter> was created, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>widget</parameter> wasn't created
 
783
  by an item factory
 
784
</simpara></listitem></varlistentry>
 
785
</variablelist></refsect2>
 
786
<refsect2>
 
787
<title><anchor id="gtk-item-factory-from-path" role="function" condition="deprecated:2.4:"/>gtk_item_factory_from_path ()</title>
 
788
<indexterm role="deprecated"><primary>gtk_item_factory_from_path</primary></indexterm><programlisting><link linkend="GtkItemFactory">GtkItemFactory</link>*     gtk_item_factory_from_path          (const <link linkend="gchar">gchar</link> *path);</programlisting>
 
789
<warning><para><literal>gtk_item_factory_from_path</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
790
<para>
 
791
Finds an item factory which has been constructed using the 
 
792
<literal>"&lt;name&gt;"</literal> prefix of <parameter>path</parameter> as the <parameter>path</parameter> argument 
 
793
for <link linkend="gtk-item-factory-new"><function>gtk_item_factory_new()</function></link>.</para>
 
794
<para>
 
795
 
 
796
</para><variablelist role="params">
 
797
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
798
<listitem><simpara> a string starting with a factory path of the form 
 
799
  <literal>"&lt;name&gt;"</literal>
 
800
</simpara></listitem></varlistentry>
 
801
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link> created for the given factory path, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> 
 
802
</simpara></listitem></varlistentry>
 
803
</variablelist></refsect2>
 
804
<refsect2>
 
805
<title><anchor id="gtk-item-factory-create-menu-entries" role="function" condition="deprecated:2.4:"/>gtk_item_factory_create_menu_entries ()</title>
 
806
<indexterm role="deprecated"><primary>gtk_item_factory_create_menu_entries</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_item_factory_create_menu_entries
 
807
                                                        (<link linkend="guint">guint</link> n_entries,
 
808
                                                         <link linkend="GtkMenuEntry">GtkMenuEntry</link> *entries);</programlisting>
 
809
<warning><para><literal>gtk_item_factory_create_menu_entries</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
810
<para>
 
811
Creates the menu items from the <parameter>entries</parameter>.</para>
 
812
<para>
 
813
 
 
814
</para><variablelist role="params">
 
815
<varlistentry><term><parameter>n_entries</parameter>&nbsp;:</term>
 
816
<listitem><simpara> the length of <parameter>entries</parameter>
 
817
</simpara></listitem></varlistentry>
 
818
<varlistentry><term><parameter>entries</parameter>&nbsp;:</term>
 
819
<listitem><simpara> an array of <link linkend="GtkMenuEntry"><type>GtkMenuEntry</type></link><!-- -->s 
 
820
</simpara></listitem></varlistentry>
 
821
</variablelist></refsect2>
 
822
<refsect2>
 
823
<title><anchor id="gtk-item-factories-path-delete" role="function" condition="deprecated:2.4:"/>gtk_item_factories_path_delete ()</title>
 
824
<indexterm role="deprecated"><primary>gtk_item_factories_path_delete</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_item_factories_path_delete      (const <link linkend="gchar">gchar</link> *ifactory_path,
 
825
                                                         const <link linkend="gchar">gchar</link> *path);</programlisting>
 
826
<warning><para><literal>gtk_item_factories_path_delete</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
827
<para>
 
828
Deletes all widgets constructed from the specified path.</para>
 
829
<para>
 
830
 
 
831
</para><variablelist role="params">
 
832
<varlistentry><term><parameter>ifactory_path</parameter>&nbsp;:</term>
 
833
<listitem><simpara> a factory path to prepend to <parameter>path</parameter>. May be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>path</parameter>
 
834
  starts with a factory path
 
835
</simpara></listitem></varlistentry>
 
836
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
 
837
<listitem><simpara> a path 
 
838
</simpara></listitem></varlistentry>
 
839
</variablelist></refsect2>
 
840
<refsect2>
 
841
<title><anchor id="gtk-item-factory-set-translate-func" role="function" condition="deprecated:2.4:"/>gtk_item_factory_set_translate_func ()</title>
 
842
<indexterm role="deprecated"><primary>gtk_item_factory_set_translate_func</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_item_factory_set_translate_func (<link linkend="GtkItemFactory">GtkItemFactory</link> *ifactory,
 
843
                                                         <link linkend="GtkTranslateFunc">GtkTranslateFunc</link> func,
 
844
                                                         <link linkend="gpointer">gpointer</link> data,
 
845
                                                         <link linkend="GtkDestroyNotify">GtkDestroyNotify</link> notify);</programlisting>
 
846
<warning><para><literal>gtk_item_factory_set_translate_func</literal> has been deprecated since version 2.4 and should not be used in newly-written code. </para></warning>
 
847
<para>
 
848
Sets a function to be used for translating the path elements before they
 
849
are displayed.</para>
 
850
<para>
 
851
 
 
852
</para><variablelist role="params">
 
853
<varlistentry><term><parameter>ifactory</parameter>&nbsp;:</term>
 
854
<listitem><simpara> a <link linkend="GtkItemFactory"><type>GtkItemFactory</type></link>
 
855
</simpara></listitem></varlistentry>
 
856
<varlistentry><term><parameter>func</parameter>&nbsp;:</term>
 
857
<listitem><simpara> the <link linkend="GtkTranslateFunc"><type>GtkTranslateFunc</type></link> function to be used to translate path elements 
 
858
</simpara></listitem></varlistentry>
 
859
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
860
<listitem><simpara> data to pass to <parameter>func</parameter> and <parameter>notify</parameter>
 
861
</simpara></listitem></varlistentry>
 
862
<varlistentry><term><parameter>notify</parameter>&nbsp;:</term>
 
863
<listitem><simpara> a <link linkend="GtkDestroyNotify"><type>GtkDestroyNotify</type></link> function to be called when <parameter>ifactory</parameter> is 
 
864
  destroyed and when the translation function is changed again
 
865
</simpara></listitem></varlistentry>
 
866
</variablelist></refsect2>
 
867
 
 
868
</refsect1>
 
869
 
 
870
 
 
871
 
 
872
 
 
873
</refentry>