<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" >
<head><meta content="text/html;charset=&quot;utf-8&quot;" http-equiv="Content-type"/><link href="faldoc.css" rel="stylesheet" type="text/css"/><title> - Class GtkToolItem</title></head><body class="faldoc"><ul class="navi_top"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="gtk.html">Up: The Falcon GTK Binding module</a></li>
<li class="prev"><a href="gtk_GtkToolButton.html">Previous: Class GtkToolButton</a></li>
<li class="next"><a href="gtk_GtkToolItemGroup.html">Next: Class GtkToolItemGroup</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">10.124</span>Class GtkToolItem</h1><p class="brief">The base class of widgets that can be added to GtkToolShell </p>
<pre class="prototype">Class GtkToolItem</pre>
<p>GtkToolItems are widgets that can appear on a toolbar. To create a toolbar item that contain something else than a button, use gtk_tool_item_new(). Use gtk_container_add() to add a child widget to the tool item. </p>
<p>For toolbar items that contain buttons, see the GtkToolButton, GtkToggleToolButton and GtkRadioToolButton classes. </p>
<p>See the GtkToolbar class for a description of the toolbar widget, and GtkToolShell for a description of the tool shell interface. </p>
<table class="members">
<tbody><tr class="member_type"><td class="member_type" colspan="2">Methods</td></tr>
<tr><td><a href="#get_ellipsize_mode">get_ellipsize_mode</a></td><td>Returns the ellipsize mode used for tool_item. </td></tr>
<tr><td><a href="#get_expand">get_expand</a></td><td>Returns whether tool_item is allocated extra space. </td></tr>
<tr><td><a href="#get_homogeneous">get_homogeneous</a></td><td>Returns whether tool_item is the same size as other homogeneous items. </td></tr>
<tr><td><a href="#get_icon_size">get_icon_size</a></td><td>Returns the icon size used for tool_item. </td></tr>
<tr><td><a href="#get_is_important">get_is_important</a></td><td>Returns whether tool_item is considered important. </td></tr>
<tr><td><a href="#get_orientation">get_orientation</a></td><td>Returns the orientation used for tool_item. </td></tr>
<tr><td><a href="#get_relief_style">get_relief_style</a></td><td>Returns the relief style of tool_item. </td></tr>
<tr><td><a href="#get_text_alignment">get_text_alignment</a></td><td>Returns the text alignment used for tool_item. </td></tr>
<tr><td><a href="#get_text_orientation">get_text_orientation</a></td><td>Returns the text orientation used for tool_item. </td></tr>
<tr><td><a href="#get_toolbar_style">get_toolbar_style</a></td><td>Returns the toolbar style used for tool_item. </td></tr>
<tr><td><a href="#get_use_drag_window">get_use_drag_window</a></td><td>Returns whether tool_item has a drag window. </td></tr>
<tr><td><a href="#get_visible_horizontal">get_visible_horizontal</a></td><td>Returns whether the tool_item is visible on toolbars that are docked horizontally. </td></tr>
<tr><td><a href="#get_visible_vertical">get_visible_vertical</a></td><td>Returns whether tool_item is visible when the toolbar is docked vertically. </td></tr>
<tr><td><a href="#rebuild_menu">rebuild_menu</a></td><td>Calling this function signals to the toolbar that the overflow menu item for tool_item has changed. </td></tr>
<tr><td><a href="#retrieve_proxy_menu_item">retrieve_proxy_menu_item</a></td><td>Returns the GtkMenuItem that was last set by gtk_tool_item_set_proxy_menu_item(), ie. the GtkMenuItem that is going to appear in the overflow menu. </td></tr>
<tr><td><a href="#set_expand">set_expand</a></td><td>Sets whether tool_item is allocated extra space when there is more room on the toolbar then needed for the items. </td></tr>
<tr><td><a href="#set_homogeneous">set_homogeneous</a></td><td>Sets whether tool_item is to be allocated the same size as other homogeneous items. </td></tr>
<tr><td><a href="#set_is_important">set_is_important</a></td><td>Sets whether tool_item should be considered important. </td></tr>
<tr><td><a href="#set_proxy_menu_item">set_proxy_menu_item</a></td><td>Sets the GtkMenuItem used in the toolbar overflow menu. </td></tr>
<tr><td><a href="#set_tooltip_markup">set_tooltip_markup</a></td><td>Sets the markup text to be displayed as tooltip on the item. </td></tr>
<tr><td><a href="#set_tooltip_text">set_tooltip_text</a></td><td>Sets the text to be displayed as tooltip on the item. </td></tr>
<tr><td><a href="#set_use_drag_window">set_use_drag_window</a></td><td>Sets whether tool_item has a drag window. </td></tr>
<tr><td><a href="#set_visible_horizontal">set_visible_horizontal</a></td><td>Sets whether tool_item is visible when the toolbar is docked horizontally. </td></tr>
<tr><td><a href="#set_visible_vertical">set_visible_vertical</a></td><td>Sets whether tool_item is visible when the toolbar is docked vertically. </td></tr>
<tr><td><a href="#toolbar_reconfigured">toolbar_reconfigured</a></td><td>Emits the signal "toolbar_reconfigured" on tool_item. </td></tr>
</tbody>
</table>
<h2>Methods</h2><h3><a name="get_ellipsize_mode">get_ellipsize_mode</a></h3><p class="brief">Returns the ellipsize mode used for tool_item. </p>
<pre class="prototype">GtkToolItem.get_ellipsize_mode()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">a PangoEllipsizeMode indicating how text in tool_item should be ellipsized. </td></tr>
</tbody>
</table>
<p>Custom subclasses of GtkToolItem should call this function to find out how text should be ellipsized. </p>
<h3><a name="get_expand">get_expand</a></h3><p class="brief">Returns whether tool_item is allocated extra space. </p>
<pre class="prototype">GtkToolItem.get_expand()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">TRUE if tool_item is allocated extra space. </td></tr>
</tbody>
</table>
<h3><a name="get_homogeneous">get_homogeneous</a></h3><p class="brief">Returns whether tool_item is the same size as other homogeneous items. </p>
<pre class="prototype">GtkToolItem.get_homogeneous()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">TRUE if the item is the same size as other homogeneous items. </td></tr>
</tbody>
</table>
<h3><a name="get_icon_size">get_icon_size</a></h3><p class="brief">Returns the icon size used for tool_item. </p>
<pre class="prototype">GtkToolItem.get_icon_size()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">a GtkIconSize indicating the icon size used for tool_item. </td></tr>
</tbody>
</table>
<p>Custom subclasses of GtkToolItem should call this function to find out what size icons they should use. </p>
<h3><a name="get_is_important">get_is_important</a></h3><p class="brief">Returns whether tool_item is considered important. </p>
<pre class="prototype">GtkToolItem.get_is_important()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">TRUE if tool_item is considered important. </td></tr>
</tbody>
</table>
<h3><a name="get_orientation">get_orientation</a></h3><p class="brief">Returns the orientation used for tool_item. </p>
<pre class="prototype">GtkToolItem.get_orientation()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">a GtkOrientation indicating the orientation used for tool_item </td></tr>
</tbody>
</table>
<p>Custom subclasses of GtkToolItem should call this function to find out what size icons they should use. </p>
<h3><a name="get_relief_style">get_relief_style</a></h3><p class="brief">Returns the relief style of tool_item. </p>
<pre class="prototype">GtkToolItem.get_relief_style()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">a GtkReliefStyle indicating the relief style used for tool_item. </td></tr>
</tbody>
</table>
<p>Custom subclasses of GtkToolItem should call this function in the handler of the "toolbar_reconfigured" signal to find out the relief style of buttons. </p>
<h3><a name="get_text_alignment">get_text_alignment</a></h3><p class="brief">Returns the text alignment used for tool_item. </p>
<pre class="prototype">GtkToolItem.get_text_alignment()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">a numeric value indicating the horizontal text alignment used for tool_item </td></tr>
</tbody>
</table>
<p>Custom subclasses of GtkToolItem should call this function to find out how text should be aligned. </p>
<h3><a name="get_text_orientation">get_text_orientation</a></h3><p class="brief">Returns the text orientation used for tool_item. </p>
<pre class="prototype">GtkToolItem.get_text_orientation()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">a GtkOrientation indicating the text orientation used for tool_item </td></tr>
</tbody>
</table>
<p>Custom subclasses of GtkToolItem should call this function to find out how text should be orientated. </p>
<h3><a name="get_toolbar_style">get_toolbar_style</a></h3><p class="brief">Returns the toolbar style used for tool_item. </p>
<pre class="prototype">GtkToolItem.get_toolbar_style()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">A GtkToolbarStyle indicating the toolbar style used for tool_item. </td></tr>
</tbody>
</table>
<p>Custom subclasses of GtkToolItem should call this function in the handler of the GtkToolItem::toolbar_reconfigured signal to find out in what style the toolbar is displayed and change themselves accordingly </p>
<p>Possibilities are: </p>
<p>- GTK_TOOLBAR_BOTH, meaning the tool item should show both an icon and a label, stacked vertically <ul><li>GTK_TOOLBAR_ICONS, meaning the toolbar shows only icons </li><li>GTK_TOOLBAR_TEXT, meaning the tool item should only show text </li><li>GTK_TOOLBAR_BOTH_HORIZ, meaning the tool item should show both an icon and a label, arranged horizontally (however, note the "has_text_horizontally" that makes tool buttons not show labels when the toolbar style is GTK_TOOLBAR_BOTH_HORIZ. </li></ul></p>
<h3><a name="get_use_drag_window">get_use_drag_window</a></h3><p class="brief">Returns whether tool_item has a drag window. </p>
<pre class="prototype">GtkToolItem.get_use_drag_window()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">TRUE if tool_item uses a drag window. </td></tr>
</tbody>
</table>
<h3><a name="get_visible_horizontal">get_visible_horizontal</a></h3><p class="brief">Returns whether the tool_item is visible on toolbars that are docked horizontally. </p>
<pre class="prototype">GtkToolItem.get_visible_horizontal()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">TRUE if tool_item is visible on toolbars that are docked horizontally. </td></tr>
</tbody>
</table>
<h3><a name="get_visible_vertical">get_visible_vertical</a></h3><p class="brief">Returns whether tool_item is visible when the toolbar is docked vertically. </p>
<pre class="prototype">GtkToolItem.get_visible_vertical()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">Whether tool_item is visible when the toolbar is docked vertically </td></tr>
</tbody>
</table>
<h3><a name="rebuild_menu">rebuild_menu</a></h3><p class="brief">Calling this function signals to the toolbar that the overflow menu item for tool_item has changed. </p>
<pre class="prototype">GtkToolItem.rebuild_menu()</pre>
<p>If the overflow menu is visible when this function it called, the menu will be rebuilt. </p>
<p>The function must be called when the tool item changes what it will do in response to the "create-menu-proxy" signal. </p>
<h3><a name="retrieve_proxy_menu_item">retrieve_proxy_menu_item</a></h3><p class="brief">Returns the GtkMenuItem that was last set by gtk_tool_item_set_proxy_menu_item(), ie. the GtkMenuItem that is going to appear in the overflow menu. </p>
<pre class="prototype">GtkToolItem.retrieve_proxy_menu_item()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">The GtkMenuItem that is going to appear in the overflow menu for tool_item. </td></tr>
</tbody>
</table>
<h3><a name="set_expand">set_expand</a></h3><p class="brief">Sets whether tool_item is allocated extra space when there is more room on the toolbar then needed for the items. </p>
<pre class="prototype">GtkToolItem.set_expand( expand )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">expand</td><td class="content"> Whether tool_item is allocated extra space </td></tr>
</tbody>
</table>
<p>The effect is that the item gets bigger when the toolbar gets bigger and smaller when the toolbar gets smaller. </p>
<h3><a name="set_homogeneous">set_homogeneous</a></h3><p class="brief">Sets whether tool_item is to be allocated the same size as other homogeneous items. </p>
<pre class="prototype">GtkToolItem.set_homogeneous()</pre>
<p>The effect is that all homogeneous items will have the same width as the widest of the items. </p>
<h3><a name="set_is_important">set_is_important</a></h3><p class="brief">Sets whether tool_item should be considered important. </p>
<pre class="prototype">GtkToolItem.set_is_important( is_important )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">is_important</td><td class="content"> whether the tool item should be considered important </td></tr>
</tbody>
</table>
<p>The GtkToolButton class uses this property to determine whether to show or hide its label when the toolbar style is GTK_TOOLBAR_BOTH_HORIZ. The result is that only tool buttons with the "is_important" property set have labels, an effect known as "priority text". </p>
<h3><a name="set_proxy_menu_item">set_proxy_menu_item</a></h3><p class="brief">Sets the GtkMenuItem used in the toolbar overflow menu. </p>
<pre class="prototype">GtkToolItem.set_proxy_menu_item( menu_item_id, menu_item )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">menu_item_id</td><td class="content"> a string used to identify menu_item </td></tr>
<tr class="param"><td class="name">menu_item</td><td class="content"> a GtkMenuItem to be used in the overflow menu </td></tr>
</tbody>
</table>
<p>The menu_item_id is used to identify the caller of this function and should also be used with gtk_tool_item_get_proxy_menu_item(). </p>
<h3><a name="set_tooltip_markup">set_tooltip_markup</a></h3><p class="brief">Sets the markup text to be displayed as tooltip on the item. </p>
<pre class="prototype">GtkToolItem.set_tooltip_markup( markup )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">markup</td><td class="content"> markup text to be used as tooltip for tool_item </td></tr>
</tbody>
</table>
<h3><a name="set_tooltip_text">set_tooltip_text</a></h3><p class="brief">Sets the text to be displayed as tooltip on the item. </p>
<pre class="prototype">GtkToolItem.set_tooltip_text( text )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">text</td><td class="content"> text to be used as tooltip for tool_item </td></tr>
</tbody>
</table>
<h3><a name="set_use_drag_window">set_use_drag_window</a></h3><p class="brief">Sets whether tool_item has a drag window. </p>
<pre class="prototype">GtkToolItem.set_use_drag_window( use_drag_window )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">use_drag_window</td><td class="content"> Whether tool_item has a drag window. </td></tr>
</tbody>
</table>
<p>When TRUE the toolitem can be used as a drag source through gtk_drag_source_set(). When tool_item has a drag window it will intercept all events, even those that would otherwise be sent to a child of tool_item. </p>
<h3><a name="set_visible_horizontal">set_visible_horizontal</a></h3><p class="brief">Sets whether tool_item is visible when the toolbar is docked horizontally. </p>
<pre class="prototype">GtkToolItem.set_visible_horizontal( visible_horizontal )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">visible_horizontal</td><td class="content"> Whether tool_item is visible when in horizontal mode </td></tr>
</tbody>
</table>
<h3><a name="set_visible_vertical">set_visible_vertical</a></h3><p class="brief">Sets whether tool_item is visible when the toolbar is docked vertically. </p>
<pre class="prototype">GtkToolItem.set_visible_vertical( visible_vertical )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">visible_vertical</td><td class="content"> whether tool_item is visible when the toolbar is in vertical mode </td></tr>
</tbody>
</table>
<p>Some tool items, such as text entries, are too wide to be useful on a vertically docked toolbar. If visible_vertical is FALSE tool_item will not appear on toolbars that are docked vertically. </p>
<h3><a name="toolbar_reconfigured">toolbar_reconfigured</a></h3><p class="brief">Emits the signal "toolbar_reconfigured" on tool_item. </p>
<pre class="prototype">GtkToolItem.toolbar_reconfigured()</pre>
<p>GtkToolbar and other GtkToolShell implementations use this function to notify children, when some aspect of their configuration changes. </p>
</div><ul class="navi_bottom"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="gtk.html">Up: The Falcon GTK Binding module</a></li>
<li class="prev"><a href="gtk_GtkToolButton.html">Previous: Class GtkToolButton</a></li>
<li class="next"><a href="gtk_GtkToolItemGroup.html">Next: Class GtkToolItemGroup</a></li>
<li class="clear"></li>
</ul><div class="signature">Made with <a href="faldoc 3.0">http://www.falconpl.org</a></div></body></html>
