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

Move documentation to inline comments: GtkMenuToolButton

parent c0b3bfd7
......@@ -69,6 +69,7 @@ gtkmain.sgml
gtkmenu.sgml
gtkmenubar.sgml
gtkmenushell.sgml
gtkmenutoolbutton.sgml
gtkmessagedialog.sgml
gtkmisc.sgml
gtknotebook.sgml
......
<!-- ##### SECTION Title ##### -->
GtkMenuToolButton
<!-- ##### SECTION Short_Description ##### -->
A GtkToolItem containing a button with an additional dropdown menu
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GtkMenuToolButton is a #GtkToolItem that contains a button and
a small additional button with an arrow. When clicked, the arrow
button pops up a dropdown menu.
</para>
<para>
Use gtk_menu_tool_button_new() to create a new
#GtkMenuToolButton. Use gtk_menu_tool_button_new_from_stock() to
create a new #GtkMenuToolButton containing a stock item.
</para>
<refsect2 id="GtkMenuToolButton-BUILDER-UI">
<title>GtkMenuToolButton as GtkBuildable</title>
<para>
The GtkMenuToolButton implementation of the GtkBuildable interface
supports adding a menu by specifying "menu" as the "type"
attribute of a &lt;child&gt; element.
</para>
<example>
<title>A UI definition fragment with menus</title>
<programlisting><![CDATA[
<object class="GtkMenuToolButton">
<child type="menu">
<object class="GtkMenu"/>
</child>
</object>
]]></programlisting>
</example>
</refsect2>
<!-- ##### 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 #GtkMenuToolButton. The properties
"label_widget", "label", "icon_widget", and "stock_id" on
#GtkToolButton determine the label and icon used on
#GtkMenuToolButton<!-- -->s.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkMenuToolButton ##### -->
<para>
The #GtkMenuToolButton struct contains only private data and
should only be accessed through the functions described below.
</para>
<!-- ##### SIGNAL GtkMenuToolButton::show-menu ##### -->
<para>
</para>
@menutoolbutton: the object which received the signal.
<!-- ##### ARG GtkMenuToolButton:menu ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_menu_tool_button_new ##### -->
<para>
</para>
@icon_widget:
@label:
@Returns:
<!-- ##### FUNCTION gtk_menu_tool_button_new_from_stock ##### -->
<para>
</para>
@stock_id:
@Returns:
<!-- ##### FUNCTION gtk_menu_tool_button_set_menu ##### -->
<para>
</para>
@button:
@menu:
<!-- ##### FUNCTION gtk_menu_tool_button_get_menu ##### -->
<para>
</para>
@button:
@Returns:
<!-- ##### FUNCTION gtk_menu_tool_button_set_arrow_tooltip_text ##### -->
<para>
</para>
@button:
@text:
<!-- ##### FUNCTION gtk_menu_tool_button_set_arrow_tooltip_markup ##### -->
<para>
</para>
@button:
@markup:
......@@ -36,6 +36,42 @@
#include "gtkintl.h"
/**
* SECTION:gtkmenutoolbutton
* @Short_description: A GtkToolItem containing a button with an additional dropdown menu
* @Title: GtkMenuToolButton
* @See_also: #GtkToolbar, #GtkToolButton
*
* A #GtkMenuToolButton is a #GtkToolItem that contains a button and
* a small additional button with an arrow. When clicked, the arrow
* button pops up a dropdown menu.
*
* Use gtk_menu_tool_button_new() to create a new
* #GtkMenuToolButton. Use gtk_menu_tool_button_new_from_stock() to
* create a new #GtkMenuToolButton containing a stock item.
*
* <refsect2 id="GtkMenuToolButton-BUILDER-UI">
* <title>GtkMenuToolButton as GtkBuildable</title>
* <para>
* The GtkMenuToolButton implementation of the GtkBuildable interface
* supports adding a menu by specifying "menu" as the "type"
* attribute of a &lt;child&gt; element.
*
* <example>
* <title>A UI definition fragment with menus</title>
* <programlisting><![CDATA[
* <object class="GtkMenuToolButton">
* <child type="menu">
* <object class="GtkMenu"/>
* </child>
* </object>
* ]]></programlisting>
* </example>
* </para>
* </refsect2>
*/
struct _GtkMenuToolButtonPrivate
{
GtkWidget *button;
......
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