Commit 05ce8747 authored by Soeren Sandmann's avatar Soeren Sandmann Committed by Søren Sandmann Pedersen
Browse files

Move documentation inline from template files.

Tue Jul 29 13:55:44 2003  Soeren Sandmann  <sandmann@daimi.au.dk>

	* gtk/gtktoolbar.c (gtk_toolbar_set_style,
	gtk_toolbar_prepend_element, gtk_toolbar_append_element,
	gtk_toolbar_insert_space, gtk_toolbar_prepend_space,
	gtk_toolbar_append_space, gtk_toolbar_insert_item,
	gtk_toolbar_prepend_item, gtk_toolbar_append_item,
	gtk_toolbar_set_tooltips, gtk_toolbar_set_orientation,
	gtk_toolbar_new, gtk_toolbar_prepend_item):

	Move documentation inline from template files.

	* gtk/gtktoolbar.c (gtk_toolbar_insert_element,
	gtk_toolbar_insert_widget, gtk_toolbar_prepend_widget,
	gtk_toolbar_append_widget, gtk_toolbar_remove_space,
	gtk_toolbar_insert_stock, gtk_toolbar_unset_icon_size,
	gtk_toolbar_get_icon_size, gtk_toolbar_set_icon_size,
	gtk_toolbar_get_tooltips, gtk_toolbar_unset_style,
	gtk_toolbar_get_style, gtk_toolbar_get_orientation)

	Copy documentation from stable that was added after the EggToolbar
	branched.

	* gtk/gtktoolbar.h: deprecate gtk_toolbar_unset_icon_size()
parent ac209d13
Tue Jul 29 13:55:44 2003 Soeren Sandmann <sandmann@daimi.au.dk>
* gtk/gtktoolbar.c (gtk_toolbar_set_style,
gtk_toolbar_prepend_element, gtk_toolbar_append_element,
gtk_toolbar_insert_space, gtk_toolbar_prepend_space,
gtk_toolbar_append_space, gtk_toolbar_insert_item,
gtk_toolbar_prepend_item, gtk_toolbar_append_item,
gtk_toolbar_set_tooltips, gtk_toolbar_set_orientation,
gtk_toolbar_new, gtk_toolbar_prepend_item):
Move documentation inline from template files.
* gtk/gtktoolbar.c (gtk_toolbar_insert_element,
gtk_toolbar_insert_widget, gtk_toolbar_prepend_widget,
gtk_toolbar_append_widget, gtk_toolbar_remove_space,
gtk_toolbar_insert_stock, gtk_toolbar_unset_icon_size,
gtk_toolbar_get_icon_size, gtk_toolbar_set_icon_size,
gtk_toolbar_get_tooltips, gtk_toolbar_unset_style,
gtk_toolbar_get_style, gtk_toolbar_get_orientation)
Copy documentation from stable that was added after the EggToolbar
branched.
* gtk/gtktoolbar.h: deprecate gtk_toolbar_unset_icon_size()
Mon Jul 28 18:21:34 2003 Soeren Sandmann <sandmann@daimi.au.dk>
* gtk+/docs/: Commit autogenerated changes, so patches will make
......
Tue Jul 29 13:55:44 2003 Soeren Sandmann <sandmann@daimi.au.dk>
* gtk/gtktoolbar.c (gtk_toolbar_set_style,
gtk_toolbar_prepend_element, gtk_toolbar_append_element,
gtk_toolbar_insert_space, gtk_toolbar_prepend_space,
gtk_toolbar_append_space, gtk_toolbar_insert_item,
gtk_toolbar_prepend_item, gtk_toolbar_append_item,
gtk_toolbar_set_tooltips, gtk_toolbar_set_orientation,
gtk_toolbar_new, gtk_toolbar_prepend_item):
Move documentation inline from template files.
* gtk/gtktoolbar.c (gtk_toolbar_insert_element,
gtk_toolbar_insert_widget, gtk_toolbar_prepend_widget,
gtk_toolbar_append_widget, gtk_toolbar_remove_space,
gtk_toolbar_insert_stock, gtk_toolbar_unset_icon_size,
gtk_toolbar_get_icon_size, gtk_toolbar_set_icon_size,
gtk_toolbar_get_tooltips, gtk_toolbar_unset_style,
gtk_toolbar_get_style, gtk_toolbar_get_orientation)
Copy documentation from stable that was added after the EggToolbar
branched.
* gtk/gtktoolbar.h: deprecate gtk_toolbar_unset_icon_size()
Mon Jul 28 18:21:34 2003 Soeren Sandmann <sandmann@daimi.au.dk>
* gtk+/docs/: Commit autogenerated changes, so patches will make
......
Tue Jul 29 13:55:44 2003 Soeren Sandmann <sandmann@daimi.au.dk>
* gtk/gtktoolbar.c (gtk_toolbar_set_style,
gtk_toolbar_prepend_element, gtk_toolbar_append_element,
gtk_toolbar_insert_space, gtk_toolbar_prepend_space,
gtk_toolbar_append_space, gtk_toolbar_insert_item,
gtk_toolbar_prepend_item, gtk_toolbar_append_item,
gtk_toolbar_set_tooltips, gtk_toolbar_set_orientation,
gtk_toolbar_new, gtk_toolbar_prepend_item):
Move documentation inline from template files.
* gtk/gtktoolbar.c (gtk_toolbar_insert_element,
gtk_toolbar_insert_widget, gtk_toolbar_prepend_widget,
gtk_toolbar_append_widget, gtk_toolbar_remove_space,
gtk_toolbar_insert_stock, gtk_toolbar_unset_icon_size,
gtk_toolbar_get_icon_size, gtk_toolbar_set_icon_size,
gtk_toolbar_get_tooltips, gtk_toolbar_unset_style,
gtk_toolbar_get_style, gtk_toolbar_get_orientation)
Copy documentation from stable that was added after the EggToolbar
branched.
* gtk/gtktoolbar.h: deprecate gtk_toolbar_unset_icon_size()
Mon Jul 28 18:21:34 2003 Soeren Sandmann <sandmann@daimi.au.dk>
* gtk+/docs/: Commit autogenerated changes, so patches will make
......
Tue Jul 29 13:55:44 2003 Soeren Sandmann <sandmann@daimi.au.dk>
* gtk/gtktoolbar.c (gtk_toolbar_set_style,
gtk_toolbar_prepend_element, gtk_toolbar_append_element,
gtk_toolbar_insert_space, gtk_toolbar_prepend_space,
gtk_toolbar_append_space, gtk_toolbar_insert_item,
gtk_toolbar_prepend_item, gtk_toolbar_append_item,
gtk_toolbar_set_tooltips, gtk_toolbar_set_orientation,
gtk_toolbar_new, gtk_toolbar_prepend_item):
Move documentation inline from template files.
* gtk/gtktoolbar.c (gtk_toolbar_insert_element,
gtk_toolbar_insert_widget, gtk_toolbar_prepend_widget,
gtk_toolbar_append_widget, gtk_toolbar_remove_space,
gtk_toolbar_insert_stock, gtk_toolbar_unset_icon_size,
gtk_toolbar_get_icon_size, gtk_toolbar_set_icon_size,
gtk_toolbar_get_tooltips, gtk_toolbar_unset_style,
gtk_toolbar_get_style, gtk_toolbar_get_orientation)
Copy documentation from stable that was added after the EggToolbar
branched.
* gtk/gtktoolbar.h: deprecate gtk_toolbar_unset_icon_size()
Mon Jul 28 18:21:34 2003 Soeren Sandmann <sandmann@daimi.au.dk>
* gtk+/docs/: Commit autogenerated changes, so patches will make
......
Tue Jul 29 13:55:44 2003 Soeren Sandmann <sandmann@daimi.au.dk>
* gtk/gtktoolbar.c (gtk_toolbar_set_style,
gtk_toolbar_prepend_element, gtk_toolbar_append_element,
gtk_toolbar_insert_space, gtk_toolbar_prepend_space,
gtk_toolbar_append_space, gtk_toolbar_insert_item,
gtk_toolbar_prepend_item, gtk_toolbar_append_item,
gtk_toolbar_set_tooltips, gtk_toolbar_set_orientation,
gtk_toolbar_new, gtk_toolbar_prepend_item):
Move documentation inline from template files.
* gtk/gtktoolbar.c (gtk_toolbar_insert_element,
gtk_toolbar_insert_widget, gtk_toolbar_prepend_widget,
gtk_toolbar_append_widget, gtk_toolbar_remove_space,
gtk_toolbar_insert_stock, gtk_toolbar_unset_icon_size,
gtk_toolbar_get_icon_size, gtk_toolbar_set_icon_size,
gtk_toolbar_get_tooltips, gtk_toolbar_unset_style,
gtk_toolbar_get_style, gtk_toolbar_get_orientation)
Copy documentation from stable that was added after the EggToolbar
branched.
* gtk/gtktoolbar.h: deprecate gtk_toolbar_unset_icon_size()
Mon Jul 28 18:21:34 2003 Soeren Sandmann <sandmann@daimi.au.dk>
* gtk+/docs/: Commit autogenerated changes, so patches will make
......
Tue Jul 29 14:21:48 2003 Soeren Sandmann <sandmann@daimi.au.dk>
* gtk/tmpl/gtktoolbar.sgml: Move documentation inline
2003-07-29 Sven Neumann <sven@gimp.org>
* gdk/tmpl/pixmaps.sgml: Resurrected documentation that got lost
......
......@@ -73,7 +73,7 @@ to a #GtkToolbar.
<!-- ##### FUNCTION gtk_toolbar_new ##### -->
<para>
Creates a new toolbar.
</para>
@Returns: the newly-created toolbar.
......@@ -140,20 +140,20 @@ Creates a new toolbar.
<!-- ##### FUNCTION gtk_toolbar_set_orientation ##### -->
<para>
Sets whether a toolbar should appear horizontally or vertically.
</para>
@toolbar: a #GtkToolbar.
@orientation: a new #GtkOrientation.
@toolbar:
@orientation:
<!-- ##### 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.
@toolbar:
@enable:
<!-- ##### FUNCTION gtk_toolbar_unset_icon_size ##### -->
......@@ -220,119 +220,113 @@ Sets if the tooltips of a toolbar should be active or not.
<!-- ##### 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.
@toolbar:
@text:
@tooltip_text:
@tooltip_private_text:
@icon:
@callback:
@user_data:
@Returns:
<!-- ##### 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.
@toolbar:
@text:
@tooltip_text:
@tooltip_private_text:
@icon:
@callback:
@user_data:
@Returns:
<!-- ##### 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.
@toolbar:
@text:
@tooltip_text:
@tooltip_private_text:
@icon:
@callback:
@user_data:
@position:
@Returns:
<!-- ##### FUNCTION gtk_toolbar_append_space ##### -->
<para>
Adds a new space to the end of the toolbar.
</para>
@toolbar: a #GtkToolbar.
@toolbar:
<!-- ##### FUNCTION gtk_toolbar_prepend_space ##### -->
<para>
Adds a new space to the beginning of the toolbar.
</para>
@toolbar: a #GtkToolbar.
@toolbar:
<!-- ##### 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.
@toolbar:
@position:
<!-- ##### 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.
@toolbar:
@type:
@widget:
@text:
@tooltip_text:
@tooltip_private_text:
@icon:
@callback:
@user_data:
@Returns:
<!-- ##### 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>
I
</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.
@toolbar:
@type:
@widget:
@text:
@tooltip_text:
@tooltip_private_text:
@icon:
@callback:
@user_data:
@Returns:
<!-- ##### FUNCTION gtk_toolbar_insert_element ##### -->
......@@ -389,11 +383,11 @@ be %NULL.
<!-- ##### 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.
@toolbar:
@style:
<!-- ##### FUNCTION gtk_toolbar_insert_stock ##### -->
......@@ -457,7 +451,7 @@ Alters the view of @toolbar to display either icons only, text only, or both.
<!-- ##### 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.
......@@ -469,21 +463,15 @@ Should be used if you wish to perform an action when the orientation of a toolba
</para>
@toolbar: the object which received the signal.
@:
@:
@:
@Returns:
@:
@:
@Returns:
<!-- ##### 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.
@toolbar:
@style:
<!-- ##### ARG GtkToolbar:orientation ##### -->
<para>
......
......@@ -2145,6 +2145,13 @@ gtk_toolbar_remove_tool_item (GtkToolbar *toolbar,
gtk_widget_queue_resize (GTK_WIDGET (toolbar));
}
/**
* gtk_toolbar_new:
*
* Creates a new toolbar.
* Return Value: the newly-created toolbar.
**/
GtkWidget *
gtk_toolbar_new (void)
{
......@@ -2187,6 +2194,13 @@ gtk_toolbar_get_item_index (GtkToolbar *toolbar,
return g_list_index (priv->items, item);
}
/**
* gtk_toolbar_set_orientation:
* @toolbar: a #GtkToolbar.
* @orientation: a new #GtkOrientation.
*
* Sets whether a toolbar should appear horizontally or vertically.
**/
void
gtk_toolbar_set_orientation (GtkToolbar *toolbar,
GtkOrientation orientation)
......@@ -2196,6 +2210,15 @@ gtk_toolbar_set_orientation (GtkToolbar *toolbar,
g_signal_emit (toolbar, toolbar_signals[ORIENTATION_CHANGED], 0, orientation);
}
/**
* gtk_toolbar_get_orientation:
* @toolbar: a #GtkToolbar
*
* Retrieves the current orientation of the toolbar. See
* gtk_toolbar_set_orientation().
*
* Return value: the orientation
**/
GtkOrientation
gtk_toolbar_get_orientation (GtkToolbar *toolbar)
{
......@@ -2204,6 +2227,13 @@ gtk_toolbar_get_orientation (GtkToolbar *toolbar)
return toolbar->orientation;
}
/**
* gtk_toolbar_set_style:
* @toolbar: a #GtkToolbar.
* @style: the new style for @toolbar.
*
* Alters the view of @toolbar to display either icons only, text only, or both.
**/
void
gtk_toolbar_set_style (GtkToolbar *toolbar,
GtkToolbarStyle style)
......@@ -2216,6 +2246,15 @@ gtk_toolbar_set_style (GtkToolbar *toolbar,
}
/**
* gtk_toolbar_get_style:
* @toolbar: a #GtkToolbar
*
* Retrieves whether the toolbar has text, icons, or both . See
* gtk_toolbar_set_style().
* Return value: the current style of @toolbar
**/
GtkToolbarStyle
gtk_toolbar_get_style (GtkToolbar *toolbar)
{
......@@ -2224,6 +2263,13 @@ gtk_toolbar_get_style (GtkToolbar *toolbar)
return toolbar->style;
}
/**
* gtk_toolbar_unset_style:
* @toolbar: a #GtkToolbar
*
* Unsets a toolbar style set with gtk_toolbar_set_style(), so that
* user preferences will be used to determine the toolbar style.
**/
void
gtk_toolbar_unset_style (GtkToolbar *toolbar)
{
......@@ -2249,6 +2295,13 @@ gtk_toolbar_unset_style (GtkToolbar *toolbar)
}
}
/**
* gtk_toolbar_set_tooltips:
* @toolbar: a #GtkToolbar.
* @enable: set to %FALSE to disable the tooltips, or %TRUE to enable them.
*
* Sets if the tooltips of a toolbar should be active or not.
**/
void
gtk_toolbar_set_tooltips (GtkToolbar *toolbar,
gboolean enable)
......@@ -2261,6 +2314,15 @@ gtk_toolbar_set_tooltips (GtkToolbar *toolbar,
gtk_tooltips_disable (toolbar->tooltips);
}
/**
* gtk_toolbar_get_tooltips:
* @toolbar: a #GtkToolbar
*
* Retrieves whether tooltips are enabled. See
* gtk_toolbar_set_tooltips().
*
* Return value: %TRUE if tooltips are enabled
**/
gboolean
gtk_toolbar_get_tooltips (GtkToolbar *toolbar)
{
......@@ -2303,6 +2365,16 @@ gtk_toolbar_get_nth_item (GtkToolbar *toolbar,
return g_list_nth_data (priv->items, n);
}
/**
* gtk_toolbar_set_icon_size:
* @toolbar: A #GtkToolbar
* @icon_size: The #GtkIconSize that stock icons in the toolbar shall have.
*
* This function sets the size of stock icons in the toolbar. You
* can call it both before you add the icons and after they've been
* added. The size you set will override user preferences for the default
* icon size.
**/
void
gtk_toolbar_set_icon_size (GtkToolbar *toolbar,
GtkIconSize icon_size)
......@@ -2321,6 +2393,14 @@ gtk_toolbar_set_icon_size (GtkToolbar *toolbar,
gtk_widget_queue_resize (GTK_WIDGET (toolbar));
}
/**
* gtk_toolbar_get_icon_size:
* @toolbar: a #GtkToolbar
*
* Retrieves the icon size fo the toolbar. See gtk_toolbar_set_icon_size().
*
* Return value: the current icon size for the icons on the toolbar.
**/
GtkIconSize
gtk_toolbar_get_icon_size (GtkToolbar *toolbar)
{
......@@ -2337,6 +2417,13 @@ gtk_toolbar_get_relief_style (GtkToolbar *toolbar)
return get_button_relief (toolbar);
}
/**
* gtk_toolbar_unset_icon_size:
* @toolbar: a #GtkToolbar
*
* Unsets toolbar icon size set with gtk_toolbar_set_icon_size(), so that
* user preferences will be used to determine the icon size.
**/
void
gtk_toolbar_unset_icon_size (GtkToolbar *toolbar)
{
......@@ -2419,6 +2506,21 @@ gtk_toolbar_get_drop_index (GtkToolbar *toolbar,
return drop_index;
}
/**
* gtk_toolbar_append_item:
* @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.
*
* Inserts a new item into the toolbar. You must specify the position
* in the toolbar where it will be inserted.
*
* Return value: the new toolbar item as a #GtkWidget.
**/
GtkWidget *
gtk_toolbar_append_item (GtkToolbar *toolbar,
const char *text,
......@@ -2435,6 +2537,20 @@ gtk_toolbar_append_item (GtkToolbar *toolbar,
toolbar->num_children);
}
/**
* gtk_toolbar_prepend_item:
* @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.
*
* Adds a new button to the beginning (top or left edges) of the given toolbar.
*
* Return value: the new toolbar item as a #GtkWidget.
**/
GtkWidget *
gtk_toolbar_prepend_item (GtkToolbar *toolbar,
const char *text,
......@@ -2451,6 +2567,22 @@ gtk_toolbar_prepend_item (GtkToolbar *toolbar,
0);
}
/**
* gtk_toolbar_insert_item:
* @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.
*
* Inserts a new item into the toolbar. You must specify the position in the
* toolbar where it will be inserted.
*
* Return value: the new toolbar item as a #GtkWidget.
**/
GtkWidget *