Commit 7ee963c2 authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkRadioToolButton

parent b810bc88
......@@ -86,6 +86,7 @@ gtkprintoperation.sgml
gtkprogressbar.sgml
gtkradioaction.sgml
gtkradiobutton.sgml
gtkradiotoolbutton.sgml
gtkrange.sgml
gtkrecentaction.sgml
gtkrecentchooser.sgml
......
<!-- ##### SECTION Title ##### -->
GtkRadioToolButton
<!-- ##### SECTION Short_Description ##### -->
A toolbar item that contains a radio button
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GtkRadioToolButton is a #GtkToolItem that contains a radio button,
that is, a button that is part of a group of toggle buttons where only
one button can be active at a time.
</para>
<para>
Use gtk_radio_tool_button_new() to create a new
#GtkRadioToolButton. use gtk_radio_tool_button_new_from_widget() to
create a new #GtkRadioToolButton that is part of the same group as an
existing #GtkRadioToolButton. Use
gtk_radio_tool_button_new_from_stock() or
gtk_radio_tool_button_new_from_widget_with_stock() to create a new
#GtkRAdioToolButton containing a stock item.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkToolbar</term>
<listitem><para>The toolbar widget</para></listitem>
</varlistentry>
<varlistentry>
<term>#GtkToolButton</term>
<listitem><para>
An ancestor class of GtkRadioToolButton. The properties
"label_widget", "label", "icon_widget", and "stock_id" on
#GtkToolButton determine the label and icon used on a
#GtkRadioToolButton.
</para></listitem>
</varlistentry>
<varlistentry>
<term>#GtkSeparatorToolItem</term>
<listitem>
<para>A subclass of #GtkToolItem that separates groups of
items on a toolbar. It is usually a good idea to put a separator
before and after a group of #GtkRadioToolButtons on a #GtkToolbar.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkRadioToolButton ##### -->
<para>
The #GtkRadioToolButton contains only private data and should only
be accessed through the functions described below.
</para>
<!-- ##### ARG GtkRadioToolButton:group ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_radio_tool_button_new ##### -->
<para>
</para>
@group:
@Returns:
<!-- ##### FUNCTION gtk_radio_tool_button_new_from_stock ##### -->
<para>
</para>
@group:
@stock_id:
@Returns:
<!-- ##### FUNCTION gtk_radio_tool_button_new_from_widget ##### -->
<para>
</para>
@group:
@Returns:
<!-- ##### FUNCTION gtk_radio_tool_button_new_with_stock_from_widget ##### -->
<para>
</para>
@group:
@stock_id:
@Returns:
<!-- ##### FUNCTION gtk_radio_tool_button_get_group ##### -->
<para>
</para>
@button:
@Returns:
<!-- ##### FUNCTION gtk_radio_tool_button_set_group ##### -->
<para>
</para>
@button:
@group:
......@@ -27,6 +27,26 @@
#include "gtkprivate.h"
/**
* SECTION:gtkradiotoolbutton
* @Short_description: A toolbar item that contains a radio button
* @Title: GtkRadioToolButton
* @See_also: #GtkToolbar, #GtkToolButton
*
* A #GtkRadioToolButton is a #GtkToolItem that contains a radio button,
* that is, a button that is part of a group of toggle buttons where only
* one button can be active at a time.
*
* Use gtk_radio_tool_button_new() to create a new
* #GtkRadioToolButton. Use gtk_radio_tool_button_new_from_widget() to
* create a new #GtkRadioToolButton that is part of the same group as an
* existing #GtkRadioToolButton. Use
* gtk_radio_tool_button_new_from_stock() or
* gtk_radio_tool_button_new_with_stock_from_widget() create a new
* #GtkRadioToolButton containing a stock item.
*/
enum {
PROP_0,
PROP_GROUP
......
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