Commit 518d0302 authored by Javier Jardón's avatar Javier Jardón

Move documentation to inline comments: GtkTearoffMenuItem

parent 4a7400db
......@@ -88,6 +88,7 @@ gtkseparatortoolitem.sgml
gtksettings.sgml
gtkstatusbar.sgml
gtkstyle.sgml
gtktearoffmenuitem.sgml
gtktesting.sgml
gtktextiter.sgml
gtktexttag.sgml
......
<!-- ##### SECTION Title ##### -->
GtkTearoffMenuItem
<!-- ##### SECTION Short_Description ##### -->
A menu item used to tear off and reattach its menu
<!-- ##### SECTION Long_Description ##### -->
<para>
A #GtkTearoffMenuItem is a special #GtkMenuItem which is used to
tear off and reattach its menu.
</para>
<para>
When its menu is shown normally, the #GtkTearoffMenuItem is drawn as a
dotted line indicating that the menu can be torn off. Activating it
causes its menu to be torn off and displayed in its own window
as a tearoff menu.
</para>
<para>
When its menu is shown as a tearoff menu, the #GtkTearoffMenuItem is drawn
as a dotted line which has a left pointing arrow graphic indicating that
the tearoff menu can be reattached. Activating it will erase the tearoff
menu window.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkMenu</term>
<listitem><para>for further discussion of menus in GTK.</para></listitem>
</varlistentry>
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkTearoffMenuItem ##### -->
<para>
The #GtkTearoffMenuItem-struct struct contains private data only, and
should be accessed using the functions below.
</para>
<!-- ##### FUNCTION gtk_tearoff_menu_item_new ##### -->
<para>
Creates a new #GtkTearoffMenuItem.
</para>
@void:
@Returns: a new #GtkTearoffMenuItem.
......@@ -31,6 +31,28 @@
#include "gtktearoffmenuitem.h"
#include "gtkintl.h"
/**
* SECTION:gtktearoffmenuitem
* @Short_description: A menu item used to tear off and reattach its menu
* @Title: GtkTearoffMenuItem
* @See_also: #GtkMenu
*
* A #GtkTearoffMenuItem is a special #GtkMenuItem which is used to
* tear off and reattach its menu.
*
* When its menu is shown normally, the #GtkTearoffMenuItem is drawn as a
* dotted line indicating that the menu can be torn off. Activating it
* causes its menu to be torn off and displayed in its own window
* as a tearoff menu.
*
* When its menu is shown as a tearoff menu, the #GtkTearoffMenuItem is drawn
* as a dotted line which has a left pointing arrow graphic indicating that
* the tearoff menu can be reattached. Activating it will erase the tearoff
* menu window.
*/
#define ARROW_SIZE 10
#define TEAR_LENGTH 5
#define BORDER_SPACING 3
......@@ -54,6 +76,13 @@ static void gtk_tearoff_menu_item_parent_set (GtkWidget *widget,
G_DEFINE_TYPE (GtkTearoffMenuItem, gtk_tearoff_menu_item, GTK_TYPE_MENU_ITEM)
/**
* gtk_tearoff_menu_item_new:
*
* Creates a new #GtkTearoffMenuItem.
*
* Returns: a new #GtkTearoffMenuItem.
*/
GtkWidget*
gtk_tearoff_menu_item_new (void)
{
......
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