summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtktearoffmenuitem.sgml
blob: 2f2560bb0dac6dd4f4f406f6f3f917887180bf02 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<!-- ##### 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 ##### -->


<!-- ##### 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>

@Returns: a new #GtkTearoffMenuItem.