Commit 98e773d9 authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkSeparatorToolItem

parent 19448b97
......@@ -13,6 +13,7 @@ gtkrecentchooserwidget.sgml
gtkscalebutton.sgml
gtkseparator.sgml
gtkseparatormenuitem.sgml
gtkseparatortoolitem.sgml
gtkstyle.sgml
gtktesting.sgml
gtktextiter.sgml
......
<!-- ##### SECTION Title ##### -->
GtkSeparatorToolItem
<!-- ##### SECTION Short_Description ##### -->
A toolbar item that separates groups of other toolbar items
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GtkSeparatorItem is a #GtkToolItem that separates groups of other
#GtkToolItems. Depending on the theme, a #GtkSeparatorToolItem will
often look like a vertical line on horizontally docked toolbars.
</para>
<para>
If the property "expand" is #TRUE and the property "draw" is #FALSE, a
#GtkSeparatorToolItem will act as a "spring" that forces other items
to the ends of the toolbar.
</para>
<para>
Use gtk_separator_tool_item_new() to create a new #GtkSeparatorToolItem.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkToolbar</term>
<listitem><para>The toolbar widget</para></listitem>
</varlistentry>
<varlistentry>
<term>#GtkRadioToolButton</term>
<listitem><para>A toolbar item containing a radio
button</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkSeparatorToolItem ##### -->
<para>
The #GtkSeparatorToolItem struct contains only private data and
should only be accessed through the functions described below.
</para>
<!-- ##### ARG GtkSeparatorToolItem:draw ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_separator_tool_item_new ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION gtk_separator_tool_item_set_draw ##### -->
<para>
</para>
@item:
@draw:
<!-- ##### FUNCTION gtk_separator_tool_item_get_draw ##### -->
<para>
</para>
@item:
@Returns:
......@@ -27,6 +27,26 @@
#include "gtkprivate.h"
#include "gtkalias.h"
/**
* SECTION:gtkseparatortoolitem
* @Short_description: A toolbar item that separates groups of other
* toolbar items
* @Title: GtkSeparatorToolItem
* @See_also: #GtkToolbar, #GtkRadioToolButton
*
* A #GtkSeparatorItem is a #GtkToolItem that separates groups of other
* #GtkToolItems. Depending on the theme, a #GtkSeparatorToolItem will
* often look like a vertical line on horizontally docked toolbars.
*
* If the #GtkToolbar child property "expand" is %TRUE and the property
* #GtkSeparatorToolItem:draw is %FALSE, a #GtkSeparatorToolItem will act as
* a "spring" that forces other items to the ends of the toolbar.
*
* Use gtk_separator_tool_item_new() to create a new #GtkSeparatorToolItem.
*/
#define MENU_ID "gtk-separator-tool-item-menu-id"
enum {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment