Commit fbb57d30 authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkToggleToolButton

parent fd48df53
......@@ -103,6 +103,7 @@ gtktexttag.sgml
gtktexttagtable.sgml
gtktextview.sgml
gtktoggleaction.sgml
gtktoggletoolbutton.sgml
gtktoolbar.sgml
gtktoolitem.sgml
gtktooltip.sgml
......
<!-- ##### SECTION Title ##### -->
GtkToggleToolButton
<!-- ##### SECTION Short_Description ##### -->
A GtkToolItem containing a toggle button
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GtkToggleToolButton is a #GtkToolItem that contains a toggle
button.
</para>
<para>
Use gtk_toggle_tool_button_new() to create a new
#GtkToggleToolButton. Use gtk_toggle_tool_button_new_from_stock() to
create a new #GtkToggleToolButton containing a stock item.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkToolbar</term>
<listitem><para>The toolbar widget</para></listitem>
<term>#GtkToolButton</term>
<listitem>
<para>
The parent class of #GtkToggleToolButton. The properties
"label_widget", "label", "icon_widget", and "stock_id" on
#GtkToolButton determine the label and icon used on
#GtkToggleToolButton<!-- -->s.
</para>
</listitem>
<term>#GtkSeparatorToolItem</term>
<listitem>
<para>A subclass of #GtkToolItem that separates groups of
items on a toolbar.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkToggleToolButton ##### -->
<para>
The #GtkToggleToolButton struct contains only private data and
should only be accessed through the functions described below.
</para>
<!-- ##### SIGNAL GtkToggleToolButton::toggled ##### -->
<para>
</para>
@toggletoolbutton: the object which received the signal.
<!-- ##### ARG GtkToggleToolButton:active ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_toggle_tool_button_new ##### -->
<para>
</para>
@void:
@Returns:
<!-- ##### FUNCTION gtk_toggle_tool_button_new_from_stock ##### -->
<para>
</para>
@stock_id:
@Returns:
<!-- ##### FUNCTION gtk_toggle_tool_button_set_active ##### -->
<para>
</para>
@button:
@is_active:
<!-- ##### FUNCTION gtk_toggle_tool_button_get_active ##### -->
<para>
</para>
@button:
@Returns:
......@@ -32,6 +32,21 @@
#include "gtkprivate.h"
/**
* SECTION:gtktoggletoolbutton
* @Short_description: A GtkToolItem containing a toggle button
* @Title: GtkToggleToolButton
* @See_also: #GtkToolbar, #GtkToolButton, #GtkSeparatorToolItem
*
* A #GtkToggleToolButton is a #GtkToolItem that contains a toggle
* button.
*
* Use gtk_toggle_tool_button_new() to create a new
* #GtkToggleToolButton. Use gtk_toggle_tool_button_new_from_stock() to
* create a new #GtkToggleToolButton containing a stock item.
*/
#define MENU_ID "gtk-toggle-tool-button-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