xmlns:its="http://www.w3.org/2005/11/its"

      xmlns:xi="http://www.w3.org/2001/XInclude"

      type="guide" style="task"

      id="toolbar.py">

  <info>

    <title type="text">Toolbar (Python)</title>

    <link type="guide" xref="beginner.py#menu-combo-toolbar"/>

    <link type="seealso" xref="grid.py"/>

    <link type="next" xref="tooltip.py"/>

    <revision version="0.1" date="2012-06-05" status="draft"/>

    <credit type="author copyright">

      <name>Marta Maria Casetti</name>

      <email its:translate="no">mmcasetti@gmail.com</email>

      <years>2012</years>

    </credit>

    <desc>A bar of buttons and other widgets</desc>

  </info>

  <title>Toolbar</title>

  <media type="image" mime="image/png" src="media/toolbar.png"/>

  
An example of toolbar with buttons (from stock icons).

  <links type="section" />

  <section id="code">

    <title>Code used to generate this example</title>

    <xi:include href="samples/toolbar.py" parse="text"><xi:fallback/></xi:include>

  </section>

  <section id="methods">

    <title>Useful methods for a Toolbar widget</title>

    
In line 32 the signal "activate" from the action undo_action is connected to the callback function undo_callback() using action.connect(signal, callback function). See <link xref="signals-callbacks.py"/> for a more detailed explanation.

    <list>

      <item>
Use insert(tool_item, position) to insert the tool_item at position. If position is negative, the item is appended at the end of the toolbar.
</item>

      <item>
get_item_index(tool_item) retrieves the position of tool_item on the toolbar.
</item>

      <item>
get_n_items() returns the number of items on the toolbar; get_nth_item(position) returns the item in position position.
</item>

      <item>
If the toolbar does not have room for all the menu items, and set_show_arrow(True), the items that do not have room are shown through an overflow menu.
</item>

      <item>
set_icon_size(icon_size) sets the size of icons in the toolbar; icon_size can be one of Gtk.IconSize.INVALID, Gtk.IconSize.MENU, Gtk.IconSize.SMALL_TOOLBAR, Gtk.IconSize.LARGE_TOOLBAR, Gtk.IconSize.BUTTON, Gtk.IconSize.DND, Gtk.IconSize.DIALOG. This should be used only for special-purpose toolbars, normal application toolbars should respect user preferences for the size of icons. unset_icon_size() unsets the preferences set with set_icon_size(icon_size), so that user preferences are used to determine the icon size.
</item>

      <item>
set_style(style), where style is one of Gtk.ToolbarStyle.ICONS, Gtk.ToolbarStyle.TEXT, Gtk.ToolbarStyle.BOTH, Gtk.ToolbarStyle.BOTH_HORIZ, sets if the toolbar shows only icons, only text, or both (vertically stacked or alongside each other). To let user preferences determine the toolbar style, and unset a toolbar style so set, use unset_style().
</item>

    </list>

  </section>

  <section id="reference">

    <title>API References</title>

    
In this sample we used the following:

    <list>

      <item>
<link href="http://developer.gnome.org/gtk3/unstable/GtkToolbar.html">GtkToolbar</link>
</item>

      <item>
<link href="http://developer.gnome.org/gtk3/unstable/GtkToolButton.html">GtkToolButton</link>
</item>

      <item>
<link href="http://developer.gnome.org/gtk3/unstable/GtkToolItem.html">GtkToolItem</link>
</item>

      <item>
<link href="http://developer.gnome.org/gtk3/unstable/gtk3-Stock-Items.html">Stock Items</link>
</item>

      <item>
<link href="http://developer.gnome.org/gtk3/unstable/GtkActionable.html">GtkActionable</link>
</item>

      <item>
<link href="http://developer.gnome.org/gtk3/unstable/GtkWidget.html">GtkWidget</link>
</item>

      <item>
<link href="http://developer.gnome.org/gdk3/unstable/gdk3-Event-Structures.html#GdkEventWindowState">Event Structures</link>
</item>

    </list>

  </section>

</page>