forked from AuroraMiddleware/gtk
9e3f0c6f5f
Wed Jul 2 18:15:21 2003 Owen Taylor <otaylor@redhat.com>
* gtk/Makefile.am gtk/gtk-docs.sgml gtk/gtksections.txt
gtk/tmpl/gtkicontheme.sgml: Document named icon system.
* gtk/tmpl/gtkrc.sgml: Mention specifying named icons
as @"icon-name".
* gtk/tmpl/gtkimage.sgml: Add a cross-reference to stock
icons.
459 lines
10 KiB
Plaintext
459 lines
10 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
GtkToolbar
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
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().
|
|
</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().
|
|
</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().
|
|
</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>
|
|
</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>
|
|
|
|
|
|
<!-- ##### ENUM GtkToolbarChildType ##### -->
|
|
<para>
|
|
#GtkToolbarChildType is used to set the type of new elements that are added
|
|
to a #GtkToolbar.
|
|
</para>
|
|
|
|
@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 ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@type:
|
|
@widget:
|
|
@icon:
|
|
@label:
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_new ##### -->
|
|
<para>
|
|
Creates a new toolbar.
|
|
</para>
|
|
|
|
@Returns: the newly-created toolbar.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_append_item ##### -->
|
|
<para>
|
|
Adds a new button to the end (right or bottom edges) of the given toolbar.
|
|
</para>
|
|
|
|
@toolbar: a #GtkToolbar.
|
|
@text: give your toolbar button a label.
|
|
@tooltip_text: a string that appears when the user holds the mouse over this item.
|
|
@tooltip_private_text: use with #GtkTipsQuery.
|
|
@icon: a #GtkWidget that should be used as the button's icon.
|
|
@callback: the function to be executed when the button is pressed.
|
|
@user_data: a pointer to any data you wish to be passed to the callback.
|
|
@Returns: the new toolbar item as a #GtkWidget.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_prepend_item ##### -->
|
|
<para>
|
|
Adds a new button to the beginning (top or left edges) of the given toolbar.
|
|
</para>
|
|
|
|
@toolbar: a #GtkToolbar.
|
|
@text: give your toolbar button a label.
|
|
@tooltip_text: a string that appears when the user holds the mouse over this item.
|
|
@tooltip_private_text: use with #GtkTipsQuery.
|
|
@icon: a #GtkWidget that should be used as the button's icon.
|
|
@callback: the function to be executed when the button is pressed.
|
|
@user_data: a pointer to any data you wish to be passed to the callback.
|
|
@Returns: the new toolbar item as a #GtkWidget.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_insert_item ##### -->
|
|
<para>
|
|
Inserts a new item into the toolbar. You must specify the position in the toolbar where it will be inserted.
|
|
</para>
|
|
|
|
@toolbar: a #GtkToolbar.
|
|
@text: give your toolbar button a label.
|
|
@tooltip_text: a string that appears when the user holds the mouse over this item.
|
|
@tooltip_private_text: use with #GtkTipsQuery.
|
|
@icon: a #GtkWidget that should be used as the button's icon.
|
|
@callback: the function to be executed when the button is pressed.
|
|
@user_data: a pointer to any data you wish to be passed to the callback.
|
|
@position: the number of widgets to insert this item after.
|
|
@Returns: the new toolbar item as a #GtkWidget.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_append_space ##### -->
|
|
<para>
|
|
Adds a new space to the end of the toolbar.
|
|
</para>
|
|
|
|
@toolbar: a #GtkToolbar.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_prepend_space ##### -->
|
|
<para>
|
|
Adds a new space to the beginning of the toolbar.
|
|
</para>
|
|
|
|
@toolbar: a #GtkToolbar.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_insert_space ##### -->
|
|
<para>
|
|
Inserts a new space in the toolbar at the specified position.
|
|
</para>
|
|
|
|
@toolbar: a #GtkToolbar
|
|
@position: the number of widgets after which a space should be inserted.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_append_element ##### -->
|
|
<para>
|
|
Adds a new element to the end of a toolbar.
|
|
</para>
|
|
<para>
|
|
If @type == %GTK_TOOLBAR_CHILD_WIDGET, @widget is used as the new element.
|
|
If @type == %GTK_TOOLBAR_CHILD_RADIOBUTTON, @widget is used to determine
|
|
the radio group for the new element. In all other cases, @widget must
|
|
be %NULL.
|
|
</para>
|
|
|
|
@toolbar: a #GtkToolbar.
|
|
@type: a value of type #GtkToolbarChildType that determines what @widget will be.
|
|
@widget: a #GtkWidget, or %NULL.
|
|
@text: the element's label.
|
|
@tooltip_text: the element's tooltip.
|
|
@tooltip_private_text: used for context-sensitive help about this toolbar element.
|
|
@icon: a #GtkWidget that provides pictorial representation of the element's function.
|
|
@callback: the function to be executed when the button is pressed.
|
|
@user_data: any data you wish to pass to the callback.
|
|
@Returns: the new toolbar element as a #GtkWidget.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_prepend_element ##### -->
|
|
<para>
|
|
Adds a new element to the beginning of a toolbar.
|
|
</para>
|
|
<para>
|
|
If @type == %GTK_TOOLBAR_CHILD_WIDGET, @widget is used as the new element.
|
|
If @type == %GTK_TOOLBAR_CHILD_RADIOBUTTON, @widget is used to determine
|
|
the radio group for the new element. In all other cases, @widget must
|
|
be %NULL.
|
|
</para>
|
|
|
|
@toolbar: a #GtkToolbar.
|
|
@type: a value of type #GtkToolbarChildType that determines what @widget will be.
|
|
@widget: a #GtkWidget, or %NULL
|
|
@text: the element's label.
|
|
@tooltip_text: the element's tooltip.
|
|
@tooltip_private_text: used for context-sensitive help about this toolbar element.
|
|
@icon: a #GtkWidget that provides pictorial representation of the element's function.
|
|
@callback: the function to be executed when the button is pressed.
|
|
@user_data: any data you wish to pass to the callback.
|
|
@Returns: the new toolbar element as a #GtkWidget.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_insert_element ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@toolbar:
|
|
@type:
|
|
@widget:
|
|
@text:
|
|
@tooltip_text:
|
|
@tooltip_private_text:
|
|
@icon:
|
|
@callback:
|
|
@user_data:
|
|
@position:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_append_widget ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@toolbar:
|
|
@widget:
|
|
@tooltip_text:
|
|
@tooltip_private_text:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_prepend_widget ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@toolbar:
|
|
@widget:
|
|
@tooltip_text:
|
|
@tooltip_private_text:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_insert_widget ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@toolbar:
|
|
@widget:
|
|
@tooltip_text:
|
|
@tooltip_private_text:
|
|
@position:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_set_orientation ##### -->
|
|
<para>
|
|
Sets whether a toolbar should appear horizontally or vertically.
|
|
</para>
|
|
|
|
@toolbar: a #GtkToolbar.
|
|
@orientation: a new #GtkOrientation.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_set_style ##### -->
|
|
<para>
|
|
Alters the view of @toolbar to display either icons only, text only, or both.
|
|
</para>
|
|
|
|
@toolbar: a #GtkToolbar.
|
|
@style: the new style for @toolbar.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_set_tooltips ##### -->
|
|
<para>
|
|
Sets if the tooltips of a toolbar should be active or not.
|
|
</para>
|
|
|
|
@toolbar: a #GtkToolbar.
|
|
@enable: set to %FALSE to disable the tooltips, or %TRUE to enable them.
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_insert_stock ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@toolbar:
|
|
@stock_id:
|
|
@tooltip_text:
|
|
@tooltip_private_text:
|
|
@callback:
|
|
@user_data:
|
|
@position:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_set_icon_size ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@toolbar:
|
|
@icon_size:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_get_icon_size ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@toolbar:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_get_orientation ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@toolbar:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_get_style ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@toolbar:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_get_tooltips ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@toolbar:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_remove_space ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@toolbar:
|
|
@position:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_unset_icon_size ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@toolbar:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_toolbar_unset_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>
|
|
Should be used if you wish to perform an action when the orientation of a toolbar is changed.
|
|
</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.
|
|
|
|
<!-- ##### SIGNAL GtkToolbar::style-changed ##### -->
|
|
<para>
|
|
Should be used if you wish to perform an action when ever the style of a toolbar is adjusted. For example, this would be a useful signal to connect to if you want to display more items on the toolbar when it is in icon-only mode; each item takes less space on the bar.
|
|
</para>
|
|
|
|
@toolbar: the object which received the signal.
|
|
@style: the new #GtkToolbarStyle of @toolbar.
|
|
|
|
<!-- ##### 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 ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkToolbar:shadow-type ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkToolbar:space-size ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### ARG GtkToolbar:space-style ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|