]> Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtktearoffmenuitem.sgml
2f2560bb0dac6dd4f4f406f6f3f917887180bf02
[~andy/gtk] / docs / reference / gtk / tmpl / gtktearoffmenuitem.sgml
1 <!-- ##### SECTION Title ##### -->
2 GtkTearoffMenuItem
3
4 <!-- ##### SECTION Short_Description ##### -->
5 A menu item used to tear off and reattach its menu
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para>
9 A #GtkTearoffMenuItem is a special #GtkMenuItem which is used to
10 tear off and reattach its menu.
11 </para>
12
13 <para>
14 When its menu is shown normally, the #GtkTearoffMenuItem is drawn as a 
15 dotted line indicating that the menu can be torn off.  Activating it 
16 causes its menu to be torn off and displayed in its own window 
17 as a tearoff menu.
18 </para>
19
20 <para>
21 When its menu is shown as a tearoff menu, the #GtkTearoffMenuItem is drawn
22 as a dotted line which has a left pointing arrow graphic indicating that
23 the tearoff menu can be reattached.  Activating it will erase the tearoff 
24 menu window.
25 </para>
26
27 <!-- ##### SECTION See_Also ##### -->
28 <para>
29 <variablelist>
30
31 <varlistentry>
32 <term>#GtkMenu</term>
33 <listitem><para>for further discussion of menus in GTK.</para></listitem>
34 </varlistentry>
35
36 </variablelist>
37 </para>
38
39 <!-- ##### SECTION Stability_Level ##### -->
40
41
42 <!-- ##### STRUCT GtkTearoffMenuItem ##### -->
43 <para>
44 The #GtkTearoffMenuItem-struct struct contains private data only, and
45 should be accessed using the functions below.
46 </para>
47
48
49 <!-- ##### FUNCTION gtk_tearoff_menu_item_new ##### -->
50 <para>
51 Creates a new #GtkTearoffMenuItem.
52 </para>
53
54 @Returns: a new #GtkTearoffMenuItem.
55
56