GtkToolbar
<!-- ##### SECTION Short_Description ##### -->
-create bars of buttons and other widgets.
+Create bars of buttons and other widgets
<!-- ##### SECTION Long_Description ##### -->
<para>
A toolbar is created with a call to gtk_toolbar_new().
</para>
<para>
-Buttons with text and/or images are added with gtk_toolbar_append_item(), gtk_toolbar_prepend_item(), and gtk_toolbar_insert_item().
+A toolbar can contain instances of a subclass of #GtkToolItem. To add
+a #GtkToolItem to the a toolbar, use gtk_toolbar_insert(). To remove
+an item from the toolbar use gtk_container_remove(). To add a button
+to the toolbar, add an instance of #GtkToolButton.
</para>
<para>
-Any of #GtkToggleButton, #GtkRadioButton, or an arbitrary widget can be added to the toolbar with gtk_toolbar_append_element(), gtk_toolbar_prepend_element(), and gtk_toolbar_insert_element().
+Toolbar items can be visually grouped by adding instances of
+#GtkSeparatorToolItem to the toolbar. If a #GtkSeparatorToolItem has
+the "expand" property set to #TRUE and the "draw" property set to
+#FALSE the effect is to force all following items to the end of the
+toolbar.
</para>
<para>
-Widgets can be visibly grouped by adding gaps between widgets using gtk_toolbar_append_space(), gtk_toolbar_prepend_space(), and gtk_toolbar_insert_space().
+Creating a context menu for the toolbar can be done by connecting to
+the #GtkToolbar::popup-context-menu signal.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
+
<varlistentry>
-<term>#GtkToolTips</term>
-<listitem><para>Change the properties of a #GtkToolbar's #GtkTooltips.</para></listitem>
-</varlistentry>
-<varlistentry>
-<term>#GtkTipsQuery</term>
-<listitem><para>Make use of the private tips of toolbar elements.</para></listitem>
+<term>#GtkToolItem</term>
+<listitem><para>Base class of widgets that can be added to a toolbar.</para></listitem>
</varlistentry>
+
</variablelist>
</para>
-<!-- ##### STRUCT GtkToolbar ##### -->
-<para>
-<structfield>num_children</structfield> is an integer specifying how many toolbar items the #GtkToolbar contains. <structfield>children</structfield> is a #GList of the child widgets of the toolbar.
-</para>
-<para>
-<structfield>orientation</structfield>
-</para>
+<!-- ##### SECTION Stability_Level ##### -->
-<!-- ##### ENUM GtkToolbarChildType ##### -->
-<para>
-#GtkToolbarChildType is used to set the type of new elements that are added
-to a #GtkToolbar.
-</para>
+<!-- ##### SECTION Image ##### -->
-@GTK_TOOLBAR_CHILD_SPACE: a space in the style of the toolbar's #GtkToolbarSpaceStyle.
-@GTK_TOOLBAR_CHILD_BUTTON: a #GtkButton.
-@GTK_TOOLBAR_CHILD_TOGGLEBUTTON: a #GtkToggleButton.
-@GTK_TOOLBAR_CHILD_RADIOBUTTON: a #GtkRadioButton.
-@GTK_TOOLBAR_CHILD_WIDGET: a standard #GtkWidget.
-<!-- ##### ENUM GtkToolbarSpaceStyle ##### -->
-<para>
-
-</para>
-
-@GTK_TOOLBAR_SPACE_EMPTY:
-@GTK_TOOLBAR_SPACE_LINE:
-
-<!-- ##### STRUCT GtkToolbarChild ##### -->
+<!-- ##### STRUCT GtkToolbar ##### -->
<para>
-
+The #GtkToolbar struct only contains private data and should only be
+accessed through the function described below.
</para>
-@type:
-@widget:
-@icon:
-@label:
-<!-- ##### FUNCTION gtk_toolbar_new ##### -->
+<!-- ##### SIGNAL GtkToolbar::focus-home-or-end ##### -->
<para>
</para>
-@Returns: the newly-created toolbar.
-
+@toolbar: the object which received the signal.
+@arg1:
+@Returns:
-<!-- ##### FUNCTION gtk_toolbar_insert ##### -->
+<!-- ##### SIGNAL GtkToolbar::orientation-changed ##### -->
<para>
</para>
-@toolbar:
-@item:
-@pos:
-
+@toolbar: the object which received the signal.
+@orientation: the new #GtkOrientation of the toolbar.
-<!-- ##### FUNCTION gtk_toolbar_get_item_index ##### -->
+<!-- ##### SIGNAL GtkToolbar::popup-context-menu ##### -->
<para>
</para>
-@toolbar:
-@item:
+@toolbar: the object which received the signal.
+@Returns:
+@Returns:
@Returns:
-
-
-<!-- ##### FUNCTION gtk_toolbar_get_n_items ##### -->
-<para>
-
-</para>
-
-@toolbar:
@Returns:
-
-<!-- ##### FUNCTION gtk_toolbar_get_nth_item ##### -->
+<!-- ##### SIGNAL GtkToolbar::style-changed ##### -->
<para>
</para>
@toolbar:
-@n:
-@Returns:
-
+@style:
-<!-- ##### FUNCTION gtk_toolbar_get_drop_index ##### -->
+<!-- ##### ARG GtkToolbar:icon-size ##### -->
<para>
</para>
-@toolbar:
-@x:
-@y:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_toolbar_set_show_arrow ##### -->
+<!-- ##### ARG GtkToolbar:icon-size-set ##### -->
<para>
</para>
-@toolbar:
-@show_arrow:
-
-
-<!-- ##### FUNCTION gtk_toolbar_set_orientation ##### -->
+<!-- ##### ARG GtkToolbar:show-arrow ##### -->
<para>
</para>
-@toolbar:
-@orientation:
-
-
-<!-- ##### FUNCTION gtk_toolbar_set_tooltips ##### -->
+<!-- ##### ARG GtkToolbar:toolbar-style ##### -->
<para>
</para>
-@toolbar:
-@enable:
-
-
-<!-- ##### FUNCTION gtk_toolbar_unset_icon_size ##### -->
+<!-- ##### ARG GtkToolbar:expand ##### -->
<para>
</para>
-@toolbar:
-
-
-<!-- ##### FUNCTION gtk_toolbar_get_show_arrow ##### -->
+<!-- ##### ARG GtkToolbar:homogeneous ##### -->
<para>
</para>
-@toolbar:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_toolbar_get_orientation ##### -->
+<!-- ##### ARG GtkToolbar:button-relief ##### -->
<para>
</para>
-@toolbar:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_toolbar_get_style ##### -->
+<!-- ##### ARG GtkToolbar:internal-padding ##### -->
<para>
</para>
-@toolbar:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_toolbar_get_icon_size ##### -->
+<!-- ##### ARG GtkToolbar:max-child-expand ##### -->
<para>
</para>
-@toolbar:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_toolbar_get_tooltips ##### -->
+<!-- ##### ARG GtkToolbar:shadow-type ##### -->
<para>
</para>
-@toolbar:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_toolbar_get_relief_style ##### -->
+<!-- ##### ARG GtkToolbar:space-size ##### -->
<para>
</para>
-@toolbar:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_toolbar_append_item ##### -->
+<!-- ##### ARG GtkToolbar:space-style ##### -->
<para>
</para>
-@toolbar:
-@text:
-@tooltip_text:
-@tooltip_private_text:
-@icon:
-@callback:
-@user_data:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_toolbar_prepend_item ##### -->
+<!-- ##### ENUM GtkToolbarChildType ##### -->
<para>
-
+#GtkToolbarChildType is used to set the type of new elements that are added
+to a #GtkToolbar.
</para>
-@toolbar:
-@text:
-@tooltip_text:
-@tooltip_private_text:
-@icon:
-@callback:
-@user_data:
-@Returns:
-
+@GTK_TOOLBAR_CHILD_SPACE: a space in the style of the toolbar's #GtkToolbarSpaceStyle.
+@GTK_TOOLBAR_CHILD_BUTTON: a #GtkButton.
+@GTK_TOOLBAR_CHILD_TOGGLEBUTTON: a #GtkToggleButton.
+@GTK_TOOLBAR_CHILD_RADIOBUTTON: a #GtkRadioButton.
+@GTK_TOOLBAR_CHILD_WIDGET: a standard #GtkWidget.
-<!-- ##### FUNCTION gtk_toolbar_insert_item ##### -->
+<!-- ##### ENUM GtkToolbarSpaceStyle ##### -->
<para>
</para>
-@toolbar:
-@text:
-@tooltip_text:
-@tooltip_private_text:
-@icon:
-@callback:
-@user_data:
-@position:
-@Returns:
-
+@GTK_TOOLBAR_SPACE_EMPTY:
+@GTK_TOOLBAR_SPACE_LINE:
-<!-- ##### FUNCTION gtk_toolbar_append_space ##### -->
+<!-- ##### STRUCT GtkToolbarChild ##### -->
<para>
</para>
-@toolbar:
-
+@type:
+@widget:
+@icon:
+@label:
-<!-- ##### FUNCTION gtk_toolbar_prepend_space ##### -->
+<!-- ##### FUNCTION gtk_toolbar_new ##### -->
<para>
</para>
-@toolbar:
+@void:
+@Returns: the newly-created toolbar.
-<!-- ##### FUNCTION gtk_toolbar_insert_space ##### -->
+<!-- ##### FUNCTION gtk_toolbar_insert ##### -->
<para>
</para>
@toolbar:
-@position:
-
+@item:
+@pos:
-<!-- ##### FUNCTION gtk_toolbar_append_element ##### -->
-<para>
-</para>
+<!-- ##### FUNCTION gtk_toolbar_get_item_index ##### -->
<para>
</para>
@toolbar:
-@type:
-@widget:
-@text:
-@tooltip_text:
-@tooltip_private_text:
-@icon:
-@callback:
-@user_data:
+@item:
@Returns:
-<!-- ##### FUNCTION gtk_toolbar_prepend_element ##### -->
+<!-- ##### FUNCTION gtk_toolbar_get_n_items ##### -->
<para>
-</para>
-:<para>
-I
</para>
@toolbar:
-@type:
-@widget:
-@text:
-@tooltip_text:
-@tooltip_private_text:
-@icon:
-@callback:
-@user_data:
@Returns:
-<!-- ##### FUNCTION gtk_toolbar_insert_element ##### -->
+<!-- ##### FUNCTION gtk_toolbar_get_nth_item ##### -->
<para>
</para>
@toolbar:
-@type:
-@widget:
-@text:
-@tooltip_text:
-@tooltip_private_text:
-@icon:
-@callback:
-@user_data:
-@position:
+@n:
@Returns:
-<!-- ##### FUNCTION gtk_toolbar_append_widget ##### -->
+<!-- ##### FUNCTION gtk_toolbar_get_drop_index ##### -->
<para>
</para>
@toolbar:
-@widget:
-@tooltip_text:
-@tooltip_private_text:
+@x:
+@y:
+@Returns:
-<!-- ##### FUNCTION gtk_toolbar_prepend_widget ##### -->
+<!-- ##### FUNCTION gtk_toolbar_set_drop_highlight_item ##### -->
<para>
</para>
@toolbar:
-@widget:
-@tooltip_text:
-@tooltip_private_text:
+@tool_item:
+@index_:
-<!-- ##### FUNCTION gtk_toolbar_insert_widget ##### -->
+<!-- ##### FUNCTION gtk_toolbar_set_show_arrow ##### -->
<para>
</para>
@toolbar:
-@widget:
-@tooltip_text:
-@tooltip_private_text:
-@position:
+@show_arrow:
-<!-- ##### FUNCTION gtk_toolbar_set_style ##### -->
+<!-- ##### FUNCTION gtk_toolbar_unset_icon_size ##### -->
<para>
</para>
@toolbar:
-@style:
-<!-- ##### FUNCTION gtk_toolbar_insert_stock ##### -->
+<!-- ##### FUNCTION gtk_toolbar_get_show_arrow ##### -->
<para>
</para>
@toolbar:
-@stock_id:
-@tooltip_text:
-@tooltip_private_text:
-@callback:
-@user_data:
-@position:
@Returns:
-<!-- ##### FUNCTION gtk_toolbar_set_icon_size ##### -->
+<!-- ##### FUNCTION gtk_toolbar_get_style ##### -->
<para>
</para>
@toolbar:
-@icon_size:
+@Returns:
-<!-- ##### FUNCTION gtk_toolbar_remove_space ##### -->
+<!-- ##### FUNCTION gtk_toolbar_get_icon_size ##### -->
<para>
</para>
@toolbar:
-@position:
+@Returns:
-<!-- ##### FUNCTION gtk_toolbar_unset_style ##### -->
+<!-- ##### FUNCTION gtk_toolbar_get_relief_style ##### -->
<para>
</para>
@toolbar:
-
-
-<!-- ##### SIGNAL GtkToolbar::focus-home-or-end ##### -->
-<para>
-
-</para>
-
-@toolbar: the object which received the signal.
-@arg1:
-@Returns:
-
-<!-- ##### SIGNAL GtkToolbar::move-focus ##### -->
-<para>
-
-</para>
-
-@toolbar: the object which received the signal.
-@arg1:
@Returns:
-<!-- ##### SIGNAL GtkToolbar::orientation-changed ##### -->
-<para>
-
-</para>
-
-@toolbar: the object which received the signal.
-@orientation: the new #GtkOrientation of the toolbar.
-
-<!-- ##### SIGNAL GtkToolbar::popup-context-menu ##### -->
-<para>
-
-</para>
-@toolbar: the object which received the signal.
-@Returns:
-@:
-@:
-@Returns:
-@:
-@Returns:
-@Returns:
-
-<!-- ##### SIGNAL GtkToolbar::style-changed ##### -->
+<!-- ##### FUNCTION gtk_toolbar_set_style ##### -->
<para>
</para>
@toolbar:
@style:
-<!-- ##### ARG GtkToolbar:orientation ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkToolbar:show-arrow ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkToolbar:toolbar-style ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkToolbar:expand ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkToolbar:homogeneous ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkToolbar:pack-end ##### -->
-<para>
-
-</para>
-<!-- ##### ARG GtkToolbar:button-relief ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkToolbar:internal-padding ##### -->
+<!-- ##### FUNCTION gtk_toolbar_set_icon_size ##### -->
<para>
</para>
-<!-- ##### ARG GtkToolbar:shadow-type ##### -->
-<para>
+@toolbar:
+@icon_size:
-</para>
-<!-- ##### ARG GtkToolbar:space-size ##### -->
+<!-- ##### FUNCTION gtk_toolbar_unset_style ##### -->
<para>
</para>
-<!-- ##### ARG GtkToolbar:space-style ##### -->
-<para>
+@toolbar:
-</para>
projects / ~andy / gtk / blobdiff