← 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/gtktoolitem.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/gtktoolitem.xml
 
1
<refentry id="GtkToolItem">
 
2
<refmeta>
 
3
<refentrytitle role="top_of_page">GtkToolItem</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>GTK Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>GtkToolItem</refname>
 
10
<refpurpose>The base class of widgets that can be added to GtkToolbar</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="GtkToolItem-struct">GtkToolItem</link>;
 
23
<link linkend="GtkToolItem">GtkToolItem</link>*        <link linkend="gtk-tool-item-new">gtk_tool_item_new</link>                   (void);
 
24
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-homogeneous">gtk_tool_item_set_homogeneous</link>       (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
 
25
                                                         <link linkend="gboolean">gboolean</link> homogeneous);
 
26
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-tool-item-get-homogeneous">gtk_tool_item_get_homogeneous</link>       (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
 
27
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-expand">gtk_tool_item_set_expand</link>            (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
 
28
                                                         <link linkend="gboolean">gboolean</link> expand);
 
29
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-tool-item-get-expand">gtk_tool_item_get_expand</link>            (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
 
30
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-tooltip">gtk_tool_item_set_tooltip</link>           (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
 
31
                                                         <link linkend="GtkTooltips">GtkTooltips</link> *tooltips,
 
32
                                                         const <link linkend="gchar">gchar</link> *tip_text,
 
33
                                                         const <link linkend="gchar">gchar</link> *tip_private);
 
34
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-use-drag-window">gtk_tool_item_set_use_drag_window</link>   (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem,
 
35
                                                         <link linkend="gboolean">gboolean</link> use_drag_window);
 
36
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-tool-item-get-use-drag-window">gtk_tool_item_get_use_drag_window</link>   (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem);
 
37
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-visible-horizontal">gtk_tool_item_set_visible_horizontal</link>
 
38
                                                        (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem,
 
39
                                                         <link linkend="gboolean">gboolean</link> visible_horizontal);
 
40
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-tool-item-get-visible-horizontal">gtk_tool_item_get_visible_horizontal</link>
 
41
                                                        (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem);
 
42
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-visible-vertical">gtk_tool_item_set_visible_vertical</link>  (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem,
 
43
                                                         <link linkend="gboolean">gboolean</link> visible_vertical);
 
44
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-tool-item-get-visible-vertical">gtk_tool_item_get_visible_vertical</link>  (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem);
 
45
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-is-important">gtk_tool_item_set_is_important</link>      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
 
46
                                                         <link linkend="gboolean">gboolean</link> is_important);
 
47
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-tool-item-get-is-important">gtk_tool_item_get_is_important</link>      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
 
48
<link linkend="GtkIconSize">GtkIconSize</link>         <link linkend="gtk-tool-item-get-icon-size">gtk_tool_item_get_icon_size</link>         (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
 
49
<link linkend="GtkOrientation">GtkOrientation</link>      <link linkend="gtk-tool-item-get-orientation">gtk_tool_item_get_orientation</link>       (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
 
50
<link linkend="GtkToolbarStyle">GtkToolbarStyle</link>     <link linkend="gtk-tool-item-get-toolbar-style">gtk_tool_item_get_toolbar_style</link>     (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
 
51
<link linkend="GtkReliefStyle">GtkReliefStyle</link>      <link linkend="gtk-tool-item-get-relief-style">gtk_tool_item_get_relief_style</link>      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
 
52
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-tool-item-retrieve-proxy-menu-item">gtk_tool_item_retrieve_proxy_menu_item</link>
 
53
                                                        (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
 
54
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gtk-tool-item-get-proxy-menu-item">gtk_tool_item_get_proxy_menu_item</link>   (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
 
55
                                                         const <link linkend="gchar">gchar</link> *menu_item_id);
 
56
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-proxy-menu-item">gtk_tool_item_set_proxy_menu_item</link>   (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
 
57
                                                         const <link linkend="gchar">gchar</link> *menu_item_id,
 
58
                                                         <link linkend="GtkWidget">GtkWidget</link> *menu_item);
 
59
<link linkend="void">void</link>                <link linkend="gtk-tool-item-rebuild-menu">gtk_tool_item_rebuild_menu</link>          (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
 
60
 
 
61
 
 
62
</synopsis>
 
63
</refsynopsisdiv>
 
64
 
 
65
<refsect1 role="object_hierarchy">
 
66
<title role="object_hierarchy.title">Object Hierarchy</title>
 
67
<synopsis>
 
68
 
 
69
  <link linkend="GObject">GObject</link>
 
70
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
71
         +----<link linkend="GtkObject">GtkObject</link>
 
72
               +----<link linkend="GtkWidget">GtkWidget</link>
 
73
                     +----<link linkend="GtkContainer">GtkContainer</link>
 
74
                           +----<link linkend="GtkBin">GtkBin</link>
 
75
                                 +----GtkToolItem
 
76
                                       +----<link linkend="GtkToolButton">GtkToolButton</link>
 
77
                                       +----<link linkend="GtkSeparatorToolItem">GtkSeparatorToolItem</link>
 
78
</synopsis>
 
79
 
 
80
</refsect1>
 
81
 
 
82
 
 
83
 
 
84
<refsect1 role="impl_interfaces">
 
85
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
86
<para>
 
87
GtkToolItem implements
 
88
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
 
89
 
 
90
</refsect1>
 
91
 
 
92
 
 
93
<refsect1 role="properties">
 
94
<title role="properties.title">Properties</title>
 
95
<synopsis>
 
96
 
 
97
  &quot;<link linkend="GtkToolItem--is-important">is-important</link>&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write
 
98
  &quot;<link linkend="GtkToolItem--visible-horizontal">visible-horizontal</link>&quot;       <link linkend="gboolean">gboolean</link>              : Read / Write
 
99
  &quot;<link linkend="GtkToolItem--visible-vertical">visible-vertical</link>&quot;         <link linkend="gboolean">gboolean</link>              : Read / Write
 
100
</synopsis>
 
101
</refsect1>
 
102
 
 
103
<refsect1 role="signal_proto">
 
104
<title role="signal_proto.title">Signals</title>
 
105
<synopsis>
 
106
 
 
107
  &quot;<link linkend="GtkToolItem-create-menu-proxy">create-menu-proxy</link>&quot;                              : Run Last
 
108
  &quot;<link linkend="GtkToolItem-set-tooltip">set-tooltip</link>&quot;                                    : Run Last
 
109
  &quot;<link linkend="GtkToolItem-toolbar-reconfigured">toolbar-reconfigured</link>&quot;                           : Run Last
 
110
</synopsis>
 
111
</refsect1>
 
112
 
 
113
 
 
114
<refsect1 role="desc">
 
115
<title role="desc.title">Description</title>
 
116
<para>
 
117
<link linkend="GtkToolItem"><type>GtkToolItem</type></link><!-- -->s are widgets that can appear on a toolbar. To
 
118
create a toolbar item that contain something else than a button, use
 
119
<link linkend="gtk-tool-item-new"><function>gtk_tool_item_new()</function></link>. Use <link linkend="gtk-container-add"><function>gtk_container_add()</function></link> to add a child
 
120
widget to the tool item.
 
121
</para>
 
122
<para>
 
123
For toolbar items that contain buttons, see the <link linkend="GtkToolButton"><type>GtkToolButton</type></link>,
 
124
<link linkend="GtkToggleToolButton"><type>GtkToggleToolButton</type></link> and <link linkend="GtkRadioToolButton"><type>GtkRadioToolButton</type></link> classes.
 
125
</para>
 
126
See the <link linkend="GtkToolbar"><type>GtkToolbar</type></link> class for a description of the toolbar widget.
 
127
<para>
 
128
</para>
 
129
</refsect1>
 
130
 
 
131
<refsect1 role="details">
 
132
<title role="details.title">Details</title>
 
133
<refsect2>
 
134
<title><anchor id="GtkToolItem-struct" role="struct"/>GtkToolItem</title>
 
135
<indexterm><primary>GtkToolItem</primary></indexterm><programlisting>typedef struct _GtkToolItem GtkToolItem;</programlisting>
 
136
<para>
 
137
The GtkToolItem struct contains only private data. It should only be
 
138
accessed through the functions described below.
 
139
</para></refsect2>
 
140
<refsect2>
 
141
<title><anchor id="gtk-tool-item-new" role="function" condition="since:2.4"/>gtk_tool_item_new ()</title>
 
142
<indexterm role="2.4"><primary>gtk_tool_item_new</primary></indexterm><programlisting><link linkend="GtkToolItem">GtkToolItem</link>*        gtk_tool_item_new                   (void);</programlisting>
 
143
<para>
 
144
Creates a new <link linkend="GtkToolItem"><type>GtkToolItem</type></link></para>
 
145
<para>
 
146
 
 
147
</para><variablelist role="params">
 
148
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new <link linkend="GtkToolItem"><type>GtkToolItem</type></link>
 
149
 
 
150
</simpara></listitem></varlistentry>
 
151
</variablelist><para role="since">Since  2.4
 
152
</para></refsect2>
 
153
<refsect2>
 
154
<title><anchor id="gtk-tool-item-set-homogeneous" role="function" condition="since:2.4"/>gtk_tool_item_set_homogeneous ()</title>
 
155
<indexterm role="2.4"><primary>gtk_tool_item_set_homogeneous</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_homogeneous       (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
 
156
                                                         <link linkend="gboolean">gboolean</link> homogeneous);</programlisting>
 
157
<para>
 
158
Sets whether <parameter>tool_item</parameter> is to be allocated the same size as other
 
159
homogeneous items. The effect is that all homogeneous items will have
 
160
the same width as the widest of the items.</para>
 
161
<para>
 
162
 
 
163
</para><variablelist role="params">
 
164
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
165
<listitem><simpara> a <link linkend="GtkToolItem--"><type>GtkToolItem:</type></link> 
 
166
</simpara></listitem></varlistentry>
 
167
<varlistentry><term><parameter>homogeneous</parameter>&nbsp;:</term>
 
168
<listitem><simpara> whether <parameter>tool_item</parameter> is the same size as other homogeneous items
 
169
</simpara></listitem></varlistentry>
 
170
</variablelist><para role="since">Since  2.4
 
171
</para></refsect2>
 
172
<refsect2>
 
173
<title><anchor id="gtk-tool-item-get-homogeneous" role="function" condition="since:2.4"/>gtk_tool_item_get_homogeneous ()</title>
 
174
<indexterm role="2.4"><primary>gtk_tool_item_get_homogeneous</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_tool_item_get_homogeneous       (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
 
175
<para>
 
176
Returns whether <parameter>tool_item</parameter> is the same size as other homogeneous
 
177
items. See <link linkend="gtk-tool-item-set-homogeneous"><function>gtk_tool_item_set_homogeneous()</function></link>.</para>
 
178
<para>
 
179
 
 
180
</para><variablelist role="params">
 
181
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
182
<listitem><simpara> a <link linkend="GtkToolItem--"><type>GtkToolItem:</type></link> 
 
183
</simpara></listitem></varlistentry>
 
184
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the item is the same size as other homogeneous
 
185
item.s
 
186
 
 
187
</simpara></listitem></varlistentry>
 
188
</variablelist><para role="since">Since  2.4
 
189
</para></refsect2>
 
190
<refsect2>
 
191
<title><anchor id="gtk-tool-item-set-expand" role="function" condition="since:2.4"/>gtk_tool_item_set_expand ()</title>
 
192
<indexterm role="2.4"><primary>gtk_tool_item_set_expand</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_expand            (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
 
193
                                                         <link linkend="gboolean">gboolean</link> expand);</programlisting>
 
194
<para>
 
195
Sets whether <parameter>tool_item</parameter> is allocated extra space when there
 
196
is more room on the toolbar then needed for the items. The
 
197
effect is that the item gets bigger when the toolbar gets bigger
 
198
and smaller when the toolbar gets smaller.</para>
 
199
<para>
 
200
 
 
201
</para><variablelist role="params">
 
202
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
203
<listitem><simpara> a <link linkend="GtkToolItem--"><type>GtkToolItem:</type></link> 
 
204
</simpara></listitem></varlistentry>
 
205
<varlistentry><term><parameter>expand</parameter>&nbsp;:</term>
 
206
<listitem><simpara> Whether <parameter>tool_item</parameter> is allocated extra space
 
207
</simpara></listitem></varlistentry>
 
208
</variablelist><para role="since">Since  2.4
 
209
</para></refsect2>
 
210
<refsect2>
 
211
<title><anchor id="gtk-tool-item-get-expand" role="function" condition="since:2.4"/>gtk_tool_item_get_expand ()</title>
 
212
<indexterm role="2.4"><primary>gtk_tool_item_get_expand</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_tool_item_get_expand            (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
 
213
<para>
 
214
Returns whether <parameter>tool_item</parameter> is allocated extra space.
 
215
See <link linkend="gtk-tool-item-set-expand"><function>gtk_tool_item_set_expand()</function></link>.</para>
 
216
<para>
 
217
 
 
218
</para><variablelist role="params">
 
219
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
220
<listitem><simpara> a <link linkend="GtkToolItem--"><type>GtkToolItem:</type></link> 
 
221
</simpara></listitem></varlistentry>
 
222
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>tool_item</parameter> is allocated extra space.
 
223
 
 
224
</simpara></listitem></varlistentry>
 
225
</variablelist><para role="since">Since  2.4
 
226
</para></refsect2>
 
227
<refsect2>
 
228
<title><anchor id="gtk-tool-item-set-tooltip" role="function" condition="since:2.4"/>gtk_tool_item_set_tooltip ()</title>
 
229
<indexterm role="2.4"><primary>gtk_tool_item_set_tooltip</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_tooltip           (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
 
230
                                                         <link linkend="GtkTooltips">GtkTooltips</link> *tooltips,
 
231
                                                         const <link linkend="gchar">gchar</link> *tip_text,
 
232
                                                         const <link linkend="gchar">gchar</link> *tip_private);</programlisting>
 
233
<para>
 
234
Sets the <link linkend="GtkTooltips"><type>GtkTooltips</type></link> object to be used for <parameter>tool_item</parameter>, the
 
235
text to be displayed as tooltip on the item and the private text
 
236
to be used. See <link linkend="gtk-tooltips-set-tip"><function>gtk_tooltips_set_tip()</function></link>.</para>
 
237
<para>
 
238
 
 
239
</para><variablelist role="params">
 
240
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
241
<listitem><simpara> a <link linkend="GtkToolItem--"><type>GtkToolItem:</type></link> 
 
242
</simpara></listitem></varlistentry>
 
243
<varlistentry><term><parameter>tooltips</parameter>&nbsp;:</term>
 
244
<listitem><simpara> The <link linkend="GtkTooltips"><type>GtkTooltips</type></link> object to be used
 
245
</simpara></listitem></varlistentry>
 
246
<varlistentry><term><parameter>tip_text</parameter>&nbsp;:</term>
 
247
<listitem><simpara> text to be used as tooltip text for <parameter>tool_item</parameter>
 
248
</simpara></listitem></varlistentry>
 
249
<varlistentry><term><parameter>tip_private</parameter>&nbsp;:</term>
 
250
<listitem><simpara> text to be used as private tooltip text
 
251
</simpara></listitem></varlistentry>
 
252
</variablelist><para role="since">Since  2.4
 
253
</para></refsect2>
 
254
<refsect2>
 
255
<title><anchor id="gtk-tool-item-set-use-drag-window" role="function" condition="since:2.4"/>gtk_tool_item_set_use_drag_window ()</title>
 
256
<indexterm role="2.4"><primary>gtk_tool_item_set_use_drag_window</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_use_drag_window   (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem,
 
257
                                                         <link linkend="gboolean">gboolean</link> use_drag_window);</programlisting>
 
258
<para>
 
259
Sets whether <parameter>toolitem</parameter> has a drag window. When <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> the
 
260
toolitem can be used as a drag source through <link linkend="gtk-drag-source-set"><function>gtk_drag_source_set()</function></link>.
 
261
When <parameter>toolitem</parameter> has a drag window it will intercept all events,
 
262
even those that would otherwise be sent to a child of <parameter>toolitem</parameter>.</para>
 
263
<para>
 
264
 
 
265
</para><variablelist role="params">
 
266
<varlistentry><term><parameter>toolitem</parameter>&nbsp;:</term>
 
267
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
 
268
</simpara></listitem></varlistentry>
 
269
<varlistentry><term><parameter>use_drag_window</parameter>&nbsp;:</term>
 
270
<listitem><simpara> Whether <parameter>toolitem</parameter> has a drag window.
 
271
</simpara></listitem></varlistentry>
 
272
</variablelist><para role="since">Since  2.4
 
273
</para></refsect2>
 
274
<refsect2>
 
275
<title><anchor id="gtk-tool-item-get-use-drag-window" role="function" condition="since:2.4"/>gtk_tool_item_get_use_drag_window ()</title>
 
276
<indexterm role="2.4"><primary>gtk_tool_item_get_use_drag_window</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_tool_item_get_use_drag_window   (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem);</programlisting>
 
277
<para>
 
278
Returns whether <parameter>toolitem</parameter> has a drag window. See
 
279
<link linkend="gtk-tool-item-set-use-drag-window"><function>gtk_tool_item_set_use_drag_window()</function></link>.</para>
 
280
<para>
 
281
 
 
282
</para><variablelist role="params">
 
283
<varlistentry><term><parameter>toolitem</parameter>&nbsp;:</term>
 
284
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
 
285
</simpara></listitem></varlistentry>
 
286
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>toolitem</parameter> uses a drag window.
 
287
 
 
288
</simpara></listitem></varlistentry>
 
289
</variablelist><para role="since">Since  2.4
 
290
</para></refsect2>
 
291
<refsect2>
 
292
<title><anchor id="gtk-tool-item-set-visible-horizontal" role="function" condition="since:2.4"/>gtk_tool_item_set_visible_horizontal ()</title>
 
293
<indexterm role="2.4"><primary>gtk_tool_item_set_visible_horizontal</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_visible_horizontal
 
294
                                                        (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem,
 
295
                                                         <link linkend="gboolean">gboolean</link> visible_horizontal);</programlisting>
 
296
<para>
 
297
Sets whether <parameter>toolitem</parameter> is visible when the toolbar is docked horizontally.</para>
 
298
<para>
 
299
 
 
300
</para><variablelist role="params">
 
301
<varlistentry><term><parameter>toolitem</parameter>&nbsp;:</term>
 
302
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link>
 
303
</simpara></listitem></varlistentry>
 
304
<varlistentry><term><parameter>visible_horizontal</parameter>&nbsp;:</term>
 
305
<listitem><simpara> Whether <parameter>toolitem</parameter> is visible when in horizontal mode
 
306
</simpara></listitem></varlistentry>
 
307
</variablelist><para role="since">Since  2.4
 
308
</para></refsect2>
 
309
<refsect2>
 
310
<title><anchor id="gtk-tool-item-get-visible-horizontal" role="function" condition="since:2.4"/>gtk_tool_item_get_visible_horizontal ()</title>
 
311
<indexterm role="2.4"><primary>gtk_tool_item_get_visible_horizontal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_tool_item_get_visible_horizontal
 
312
                                                        (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem);</programlisting>
 
313
<para>
 
314
Returns whether the <parameter>toolitem</parameter> is visible on toolbars that are
 
315
docked horizontally.</para>
 
316
<para>
 
317
 
 
318
</para><variablelist role="params">
 
319
<varlistentry><term><parameter>toolitem</parameter>&nbsp;:</term>
 
320
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
 
321
</simpara></listitem></varlistentry>
 
322
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>toolitem</parameter> is visible on toolbars that are
 
323
docked horizontally.
 
324
 
 
325
</simpara></listitem></varlistentry>
 
326
</variablelist><para role="since">Since  2.4
 
327
</para></refsect2>
 
328
<refsect2>
 
329
<title><anchor id="gtk-tool-item-set-visible-vertical" role="function" condition="since:2.4"/>gtk_tool_item_set_visible_vertical ()</title>
 
330
<indexterm role="2.4"><primary>gtk_tool_item_set_visible_vertical</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_visible_vertical  (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem,
 
331
                                                         <link linkend="gboolean">gboolean</link> visible_vertical);</programlisting>
 
332
<para>
 
333
Sets whether <parameter>toolitem</parameter> is visible when the toolbar is docked
 
334
vertically. Some tool items, such as text entries, are too wide to be
 
335
useful on a vertically docked toolbar. If <parameter>visible_vertical</parameter> is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>
 
336
<parameter>toolitem</parameter> will not appear on toolbars that are docked vertically.</para>
 
337
<para>
 
338
 
 
339
</para><variablelist role="params">
 
340
<varlistentry><term><parameter>toolitem</parameter>&nbsp;:</term>
 
341
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
 
342
</simpara></listitem></varlistentry>
 
343
<varlistentry><term><parameter>visible_vertical</parameter>&nbsp;:</term>
 
344
<listitem><simpara> whether <parameter>toolitem</parameter> is visible when the toolbar
 
345
is in vertical mode
 
346
</simpara></listitem></varlistentry>
 
347
</variablelist><para role="since">Since  2.4
 
348
</para></refsect2>
 
349
<refsect2>
 
350
<title><anchor id="gtk-tool-item-get-visible-vertical" role="function" condition="since:2.4"/>gtk_tool_item_get_visible_vertical ()</title>
 
351
<indexterm role="2.4"><primary>gtk_tool_item_get_visible_vertical</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_tool_item_get_visible_vertical  (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem);</programlisting>
 
352
<para>
 
353
Returns whether <parameter>toolitem</parameter> is visible when the toolbar is docked vertically.
 
354
See <link linkend="gtk-tool-item-set-visible-vertical"><function>gtk_tool_item_set_visible_vertical()</function></link>.</para>
 
355
<para>
 
356
 
 
357
</para><variablelist role="params">
 
358
<varlistentry><term><parameter>toolitem</parameter>&nbsp;:</term>
 
359
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
 
360
</simpara></listitem></varlistentry>
 
361
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Whether <parameter>toolitem</parameter> is visible when the toolbar is docked vertically
 
362
 
 
363
</simpara></listitem></varlistentry>
 
364
</variablelist><para role="since">Since  2.4
 
365
</para></refsect2>
 
366
<refsect2>
 
367
<title><anchor id="gtk-tool-item-set-is-important" role="function" condition="since:2.4"/>gtk_tool_item_set_is_important ()</title>
 
368
<indexterm role="2.4"><primary>gtk_tool_item_set_is_important</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_is_important      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
 
369
                                                         <link linkend="gboolean">gboolean</link> is_important);</programlisting>
 
370
<para>
 
371
Sets whether <parameter>tool_item</parameter> should be considered important. The <link linkend="GtkToolButton"><type>GtkToolButton</type></link>
 
372
class uses this property to determine whether to show or hide its label
 
373
when the toolbar style is <link linkend="GTK-TOOLBAR-BOTH-HORIZ:CAPS"><literal>GTK_TOOLBAR_BOTH_HORIZ</literal></link>. The result is that
 
374
only tool buttons with the "is_important" property set have labels, an
 
375
effect known as "priority text"</para>
 
376
<para>
 
377
 
 
378
</para><variablelist role="params">
 
379
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
380
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link>
 
381
</simpara></listitem></varlistentry>
 
382
<varlistentry><term><parameter>is_important</parameter>&nbsp;:</term>
 
383
<listitem><simpara> whether the tool item should be considered important
 
384
</simpara></listitem></varlistentry>
 
385
</variablelist><para role="since">Since  2.4
 
386
</para></refsect2>
 
387
<refsect2>
 
388
<title><anchor id="gtk-tool-item-get-is-important" role="function" condition="since:2.4"/>gtk_tool_item_get_is_important ()</title>
 
389
<indexterm role="2.4"><primary>gtk_tool_item_get_is_important</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_tool_item_get_is_important      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
 
390
<para>
 
391
Returns whether <parameter>tool_item</parameter> is considered important. See
 
392
<link linkend="gtk-tool-item-set-is-important"><function>gtk_tool_item_set_is_important()</function></link></para>
 
393
<para>
 
394
 
 
395
</para><variablelist role="params">
 
396
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
397
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link>
 
398
</simpara></listitem></varlistentry>
 
399
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>tool_item</parameter> is considered important.
 
400
 
 
401
</simpara></listitem></varlistentry>
 
402
</variablelist><para role="since">Since  2.4
 
403
</para></refsect2>
 
404
<refsect2>
 
405
<title><anchor id="gtk-tool-item-get-icon-size" role="function" condition="since:2.4"/>gtk_tool_item_get_icon_size ()</title>
 
406
<indexterm role="2.4"><primary>gtk_tool_item_get_icon_size</primary></indexterm><programlisting><link linkend="GtkIconSize">GtkIconSize</link>         gtk_tool_item_get_icon_size         (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
 
407
<para>
 
408
Returns the icon size used for <parameter>tool_item</parameter>. Custom subclasses of
 
409
<link linkend="GtkToolItem"><type>GtkToolItem</type></link> should call this function to find out what size icons
 
410
they should use.</para>
 
411
<para>
 
412
 
 
413
</para><variablelist role="params">
 
414
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
415
<listitem><simpara> a <link linkend="GtkToolItem--"><type>GtkToolItem:</type></link>
 
416
</simpara></listitem></varlistentry>
 
417
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GtkIconSize"><type>GtkIconSize</type></link> indicating the icon size used for <parameter>tool_item</parameter>
 
418
 
 
419
</simpara></listitem></varlistentry>
 
420
</variablelist><para role="since">Since  2.4
 
421
</para></refsect2>
 
422
<refsect2>
 
423
<title><anchor id="gtk-tool-item-get-orientation" role="function" condition="since:2.4"/>gtk_tool_item_get_orientation ()</title>
 
424
<indexterm role="2.4"><primary>gtk_tool_item_get_orientation</primary></indexterm><programlisting><link linkend="GtkOrientation">GtkOrientation</link>      gtk_tool_item_get_orientation       (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
 
425
<para>
 
426
Returns the orientation used for <parameter>tool_item</parameter>. Custom subclasses of
 
427
<link linkend="GtkToolItem"><type>GtkToolItem</type></link> should call this function to find out what size icons
 
428
they should use.</para>
 
429
<para>
 
430
 
 
431
</para><variablelist role="params">
 
432
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
433
<listitem><simpara> a <link linkend="GtkToolItem--"><type>GtkToolItem:</type></link> 
 
434
</simpara></listitem></varlistentry>
 
435
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GtkOrientation"><type>GtkOrientation</type></link> indicating the orientation
 
436
used for <parameter>tool_item</parameter>
 
437
 
 
438
</simpara></listitem></varlistentry>
 
439
</variablelist><para role="since">Since  2.4
 
440
</para></refsect2>
 
441
<refsect2>
 
442
<title><anchor id="gtk-tool-item-get-toolbar-style" role="function" condition="since:2.4"/>gtk_tool_item_get_toolbar_style ()</title>
 
443
<indexterm role="2.4"><primary>gtk_tool_item_get_toolbar_style</primary></indexterm><programlisting><link linkend="GtkToolbarStyle">GtkToolbarStyle</link>     gtk_tool_item_get_toolbar_style     (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
 
444
<para>
 
445
Returns the toolbar style used for <parameter>tool_item</parameter>. Custom subclasses of
 
446
<link linkend="GtkToolItem"><type>GtkToolItem</type></link> should call this function in the handler of the
 
447
GtkToolItem::toolbar_reconfigured signal to find out in what style
 
448
the toolbar is displayed and change themselves accordingly 
 
449
</para>
 
450
<para>
 
451
Possibilities are:
 
452
<itemizedlist>
 
453
<listitem> GTK_TOOLBAR_BOTH, meaning the tool item should show
 
454
both an icon and a label, stacked vertically </listitem>
 
455
<listitem> GTK_TOOLBAR_ICONS, meaning the toolbar shows
 
456
only icons </listitem>
 
457
<listitem> GTK_TOOLBAR_TEXT, meaning the tool item should only
 
458
show text</listitem>
 
459
<listitem> GTK_TOOLBAR_BOTH_HORIZ, meaning the tool item should show
 
460
both an icon and a label, arranged horizontally (however, note the 
 
461
<link linkend="GtkToolButton-has-text-horizontally"><type>GtkToolButton::has_text_horizontally</type></link> that makes tool buttons not
 
462
show labels when the toolbar style is GTK_TOOLBAR_BOTH_HORIZ.
 
463
</listitem>
 
464
</itemizedlist></para>
 
465
<para>
 
466
 
 
467
</para><variablelist role="params">
 
468
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
469
<listitem><simpara> a <link linkend="GtkToolItem--"><type>GtkToolItem:</type></link> 
 
470
</simpara></listitem></varlistentry>
 
471
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GtkToolbarStyle"><type>GtkToolbarStyle</type></link> indicating the toolbar style used
 
472
for <parameter>tool_item</parameter>.
 
473
 
 
474
</simpara></listitem></varlistentry>
 
475
</variablelist><para role="since">Since  2.4
 
476
</para></refsect2>
 
477
<refsect2>
 
478
<title><anchor id="gtk-tool-item-get-relief-style" role="function" condition="since:2.4"/>gtk_tool_item_get_relief_style ()</title>
 
479
<indexterm role="2.4"><primary>gtk_tool_item_get_relief_style</primary></indexterm><programlisting><link linkend="GtkReliefStyle">GtkReliefStyle</link>      gtk_tool_item_get_relief_style      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
 
480
<para>
 
481
Returns the relief style of <parameter>tool_item</parameter>. See <link linkend="gtk-button-set-relief-style"><function>gtk_button_set_relief_style()</function></link>.
 
482
Custom subclasses of <link linkend="GtkToolItem"><type>GtkToolItem</type></link> should call this function in the handler
 
483
of the <link linkend="GtkToolItem-toolbar-reconfigured"><type>GtkToolItem::toolbar_reconfigured</type></link> signal to find out the
 
484
relief style of buttons.</para>
 
485
<para>
 
486
 
 
487
</para><variablelist role="params">
 
488
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
489
<listitem><simpara> a <link linkend="GtkToolItem--"><type>GtkToolItem:</type></link> 
 
490
</simpara></listitem></varlistentry>
 
491
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="GtkReliefStyle"><type>GtkReliefStyle</type></link> indicating the relief style used
 
492
for <parameter>tool_item</parameter>.
 
493
 
 
494
</simpara></listitem></varlistentry>
 
495
</variablelist><para role="since">Since  2.4
 
496
</para></refsect2>
 
497
<refsect2>
 
498
<title><anchor id="gtk-tool-item-retrieve-proxy-menu-item" role="function" condition="since:2.4"/>gtk_tool_item_retrieve_proxy_menu_item ()</title>
 
499
<indexterm role="2.4"><primary>gtk_tool_item_retrieve_proxy_menu_item</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_tool_item_retrieve_proxy_menu_item
 
500
                                                        (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
 
501
<para>
 
502
Returns the <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> that was last set by
 
503
<link linkend="gtk-tool-item-set-proxy-menu-item"><function>gtk_tool_item_set_proxy_menu_item()</function></link>, ie. the <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link>
 
504
that is going to appear in the overflow menu.</para>
 
505
<para>
 
506
 
 
507
</para><variablelist role="params">
 
508
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
509
<listitem><simpara> a <link linkend="GtkToolItem--"><type>GtkToolItem:</type></link> 
 
510
</simpara></listitem></varlistentry>
 
511
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> that is going to appear in the
 
512
overflow menu for <parameter>tool_item</parameter>.
 
513
 
 
514
</simpara></listitem></varlistentry>
 
515
</variablelist><para role="since">Since  2.4
 
516
</para></refsect2>
 
517
<refsect2>
 
518
<title><anchor id="gtk-tool-item-get-proxy-menu-item" role="function" condition="since:2.4"/>gtk_tool_item_get_proxy_menu_item ()</title>
 
519
<indexterm role="2.4"><primary>gtk_tool_item_get_proxy_menu_item</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gtk_tool_item_get_proxy_menu_item   (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
 
520
                                                         const <link linkend="gchar">gchar</link> *menu_item_id);</programlisting>
 
521
<para>
 
522
If <parameter>menu_item_id</parameter> matches the string passed to
 
523
<link linkend="gtk-tool-item-set-proxy-menu-item"><function>gtk_tool_item_set_proxy_menu_item()</function></link> return the corresponding <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link>.
 
524
</para>
 
525
<para>
 
526
Custom subclasses of <link linkend="GtkToolItem"><type>GtkToolItem</type></link> should use this function to update
 
527
their menu item when the <link linkend="GtkToolItem"><type>GtkToolItem</type></link> changes. That the
 
528
<parameter>menu_item_id</parameter><!-- -->s must match ensures that a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> will not
 
529
inadvertently change a menu item that they did not create.</para>
 
530
<para>
 
531
 
 
532
</para><variablelist role="params">
 
533
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
534
<listitem><simpara> a <link linkend="GtkToolItem--"><type>GtkToolItem:</type></link> 
 
535
</simpara></listitem></varlistentry>
 
536
<varlistentry><term><parameter>menu_item_id</parameter>&nbsp;:</term>
 
537
<listitem><simpara> a string used to identify the menu item
 
538
</simpara></listitem></varlistentry>
 
539
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> passed to
 
540
<link linkend="gtk-tool-item-set-proxy-menu-item"><function>gtk_tool_item_set_proxy_menu_item()</function></link>, if the <parameter>menu_item_id</parameter><!-- -->s match.
 
541
 
 
542
</simpara></listitem></varlistentry>
 
543
</variablelist><para role="since">Since  2.4
 
544
</para></refsect2>
 
545
<refsect2>
 
546
<title><anchor id="gtk-tool-item-set-proxy-menu-item" role="function" condition="since:2.4"/>gtk_tool_item_set_proxy_menu_item ()</title>
 
547
<indexterm role="2.4"><primary>gtk_tool_item_set_proxy_menu_item</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_proxy_menu_item   (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
 
548
                                                         const <link linkend="gchar">gchar</link> *menu_item_id,
 
549
                                                         <link linkend="GtkWidget">GtkWidget</link> *menu_item);</programlisting>
 
550
<para>
 
551
Sets the <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> used in the toolbar overflow menu. The
 
552
<parameter>menu_item_id</parameter> is used to identify the caller of this function and
 
553
should also be used with <link linkend="gtk-tool-item-get-proxy-menu-item"><function>gtk_tool_item_get_proxy_menu_item()</function></link>.</para>
 
554
<para>
 
555
 
 
556
</para><variablelist role="params">
 
557
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
558
<listitem><simpara> a <link linkend="GtkToolItem--"><type>GtkToolItem:</type></link>
 
559
</simpara></listitem></varlistentry>
 
560
<varlistentry><term><parameter>menu_item_id</parameter>&nbsp;:</term>
 
561
<listitem><simpara> a string used to identify <parameter>menu_item</parameter>
 
562
</simpara></listitem></varlistentry>
 
563
<varlistentry><term><parameter>menu_item</parameter>&nbsp;:</term>
 
564
<listitem><simpara> a <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> to be used in the overflow menu
 
565
</simpara></listitem></varlistentry>
 
566
</variablelist><para role="since">Since  2.4
 
567
</para></refsect2>
 
568
<refsect2>
 
569
<title><anchor id="gtk-tool-item-rebuild-menu" role="function" condition="since:2.6"/>gtk_tool_item_rebuild_menu ()</title>
 
570
<indexterm role="2.6"><primary>gtk_tool_item_rebuild_menu</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_rebuild_menu          (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
 
571
<para>
 
572
Calling this function signals to the toolbar that the
 
573
overflow menu item for <parameter>tool_item</parameter> has changed. If the
 
574
overflow menu is visible when this function it called,
 
575
the menu will be rebuilt.
 
576
</para>
 
577
<para>
 
578
The function must be called when the tool item
 
579
changes what it will do in response to the "create_menu_proxy"
 
580
signal.</para>
 
581
<para>
 
582
 
 
583
</para><variablelist role="params">
 
584
<varlistentry><term><parameter>tool_item</parameter>&nbsp;:</term>
 
585
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link>
 
586
</simpara></listitem></varlistentry>
 
587
</variablelist><para role="since">Since  2.6
 
588
</para></refsect2>
 
589
 
 
590
</refsect1>
 
591
<refsect1 role="property_details">
 
592
<title role="property_details.title">Property Details</title>
 
593
<refsect2><title><anchor id="GtkToolItem--is-important"/>The &quot;<literal>is-important</literal>&quot; property</title>
 
594
<indexterm><primary>GtkToolItem:is-important</primary></indexterm><programlisting>  &quot;is-important&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
595
<para>Whether the toolbar item is considered important. When TRUE, toolbar buttons show text in GTK_TOOLBAR_BOTH_HORIZ mode.</para><para>Default value: FALSE</para>
 
596
</refsect2>
 
597
<refsect2><title><anchor id="GtkToolItem--visible-horizontal"/>The &quot;<literal>visible-horizontal</literal>&quot; property</title>
 
598
<indexterm><primary>GtkToolItem:visible-horizontal</primary></indexterm><programlisting>  &quot;visible-horizontal&quot;       <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
599
<para>Whether the toolbar item is visible when the toolbar is in a horizontal orientation.</para><para>Default value: TRUE</para>
 
600
</refsect2>
 
601
<refsect2><title><anchor id="GtkToolItem--visible-vertical"/>The &quot;<literal>visible-vertical</literal>&quot; property</title>
 
602
<indexterm><primary>GtkToolItem:visible-vertical</primary></indexterm><programlisting>  &quot;visible-vertical&quot;         <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
603
<para>Whether the toolbar item is visible when the toolbar is in a vertical orientation.</para><para>Default value: TRUE</para>
 
604
</refsect2>
 
605
 
 
606
</refsect1>
 
607
 
 
608
<refsect1 role="signals">
 
609
<title role="signals.title">Signal Details</title>
 
610
<refsect2><title><anchor id="GtkToolItem-create-menu-proxy"/>The &quot;create-menu-proxy&quot; signal</title>
 
611
<indexterm><primary>GtkToolItem::create-menu-proxy</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            user_function                      (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem,
 
612
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last</programlisting>
 
613
<para>
 
614
This signal is emitted when the toolbar needs information from <parameter>tool_item</parameter>
 
615
about whether the item should appear in the toolbar overflow menu. In
 
616
response the tool item should either
 
617
<itemizedlist>
 
618
<listitem> call <link linkend="gtk-tool-item-set-proxy-menu-item"><function>gtk_tool_item_set_proxy_menu_item()</function></link> with a <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
619
pointer and return <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to indicate that the item should not appear
 
620
in the overflow menu
 
621
</listitem>
 
622
<listitem> call <link linkend="gtk-tool-item-set-proxy-menu-item"><function>gtk_tool_item_set_proxy_menu_item()</function></link> with a new menu
 
623
item and return <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, or 
 
624
</listitem>
 
625
<listitem> return <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> to indicate that the signal was not
 
626
handled by the item. This means that
 
627
the item will not appear in the overflow menu unless a later handler
 
628
installs a menu item.
 
629
</listitem>
 
630
</itemizedlist>
 
631
</para>
 
632
<para>
 
633
The toolbar may cache the result of this signal. When the tool item changes
 
634
how it will respond to this signal it must call <link linkend="gtk-tool-item-rebuild-menu"><function>gtk_tool_item_rebuild_menu()</function></link>
 
635
to invalidate the cache and ensure that the toolbar rebuilds its overflow
 
636
menu.</para>
 
637
<para>
 
638
 
 
639
</para><variablelist role="params">
 
640
<varlistentry><term><parameter>toolitem</parameter>&nbsp;:</term>
 
641
<listitem><simpara> the object the signal was emitted on
 
642
</simpara></listitem></varlistentry>
 
643
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
644
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
645
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the signal was handled, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if not
 
646
</simpara></listitem></varlistentry>
 
647
</variablelist></refsect2><refsect2><title><anchor id="GtkToolItem-set-tooltip"/>The &quot;set-tooltip&quot; signal</title>
 
648
<indexterm><primary>GtkToolItem::set-tooltip</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            user_function                      (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem,
 
649
                                                        <link linkend="GtkTooltips">GtkTooltips</link> *tooltips,
 
650
                                                        <link linkend="gchar">gchar</link>       *tip_text,
 
651
                                                        <link linkend="gchar">gchar</link>       *tip_private,
 
652
                                                        <link linkend="gpointer">gpointer</link>     user_data)        : Run Last</programlisting>
 
653
<para>
 
654
This signal is emitted when the toolitem's tooltip changes.
 
655
Application developers can use <link linkend="gtk-tool-item-set-tooltip"><function>gtk_tool_item_set_tooltip()</function></link> to
 
656
set the item's tooltip.</para>
 
657
<para>
 
658
 
 
659
</para><variablelist role="params">
 
660
<varlistentry><term><parameter>toolitem</parameter>&nbsp;:</term>
 
661
<listitem><simpara> the object the signal was emitted on
 
662
</simpara></listitem></varlistentry>
 
663
<varlistentry><term><parameter>tooltips</parameter>&nbsp;:</term>
 
664
<listitem><simpara> the <link linkend="GtkTooltips"><type>GtkTooltips</type></link>
 
665
</simpara></listitem></varlistentry>
 
666
<varlistentry><term><parameter>tip_text</parameter>&nbsp;:</term>
 
667
<listitem><simpara> the tooltip text
 
668
</simpara></listitem></varlistentry>
 
669
<varlistentry><term><parameter>tip_private</parameter>&nbsp;:</term>
 
670
<listitem><simpara> the tooltip private text
 
671
</simpara></listitem></varlistentry>
 
672
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
673
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
674
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the signal was handled, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if not
 
675
</simpara></listitem></varlistentry>
 
676
</variablelist></refsect2><refsect2><title><anchor id="GtkToolItem-toolbar-reconfigured"/>The &quot;toolbar-reconfigured&quot; signal</title>
 
677
<indexterm><primary>GtkToolItem::toolbar-reconfigured</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkToolItem">GtkToolItem</link> *toolitem,
 
678
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last</programlisting>
 
679
<para>
 
680
This signal is emitted when some property of the toolbar that the
 
681
item is a child of changes. For custom subclasses of <link linkend="GtkToolItem"><type>GtkToolItem</type></link>,
 
682
the default handler of this signal use the functions
 
683
<itemizedlist>
 
684
<listitem><link linkend="gtk-toolbar-get-orientation"><function>gtk_toolbar_get_orientation()</function></link></listitem>
 
685
<listitem><link linkend="gtk-toolbar-get-style"><function>gtk_toolbar_get_style()</function></link></listitem>
 
686
<listitem><link linkend="gtk-toolbar-get-icon-size"><function>gtk_toolbar_get_icon_size()</function></link></listitem>
 
687
<listitem><link linkend="gtk-toolbar-get-relief-style"><function>gtk_toolbar_get_relief_style()</function></link></listitem>
 
688
</itemizedlist>
 
689
to find out what the toolbar should look like and change
 
690
themselves accordingly.</para>
 
691
<para>
 
692
 
 
693
</para><variablelist role="params">
 
694
<varlistentry><term><parameter>toolitem</parameter>&nbsp;:</term>
 
695
<listitem><simpara> the object the signal was emitted on
 
696
</simpara></listitem></varlistentry>
 
697
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
698
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
699
</variablelist></refsect2>
 
700
</refsect1>
 
701
 
 
702
 
 
703
<refsect1>
 
704
<title>See Also</title>
 
705
<para>
 
706
 
 
707
<varlistentry>
 
708
  <term><link linkend="GtkToolbar"><type>GtkToolbar</type></link></term>
 
709
  <listitem><para>The toolbar widget</para></listitem>
 
710
</varlistentry>
 
711
 
 
712
<varlistentry>
 
713
  <term><link linkend="GtkToolButton"><type>GtkToolButton</type></link></term>
 
714
  <listitem><para>A subclass of <link linkend="GtkToolItem"><type>GtkToolItem</type></link> that displays buttons on
 
715
      the toolbar</para></listitem>
 
716
</varlistentry>
 
717
 
 
718
<varlistentry>
 
719
  <term><link linkend="GtkSeparatorToolItem"><type>GtkSeparatorToolItem</type></link></term>
 
720
  <listitem><para>A subclass of <link linkend="GtkToolItem"><type>GtkToolItem</type></link> that separates groups of
 
721
      items on a toolbar</para></listitem>
 
722
</varlistentry>
 
723
 
 
724
</para>
 
725
</refsect1>
 
726
 
 
727
</refentry>