summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-gtktearoffmenuitem.xml
blob: b2e3cb32d71ef9204bc9e177bf860db312c9b75a (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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-gtktearoffmenuitem">
  <refnamediv>
    <refname>gtk.TearoffMenuItem</refname>
    <refpurpose>a menu item used to tear off and reattach its
menu.</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.TearoffMenuItem</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkmenuitem">gtk.MenuItem</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link
linkend="constructor-gtktearoffmenuitem">gtk.TearoffMenuItem</link></methodname>
	<methodparam></methodparam>  </constructorsynopsis>
    </classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkwidget">gtk.Widget</link>
      +-- <link linkend="class-gtkcontainer">gtk.Container</link>
        +-- <link linkend="class-gtkbin">gtk.Bin</link>
          +-- <link linkend="class-gtkitem">gtk.Item</link>
            +-- <link linkend="class-gtkmenuitem">gtk.MenuItem</link>
              +-- <link linkend="class-gtktearoffmenuitem">gtk.TearoffMenuItem</link>
</synopsis>

  </refsect1>
  
  <refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-gtktearoffmenuitem"><classname>gtk.TearoffMenuItem</classname></link>
			implements 
			<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
		</para>
	</refsect1>

  <refsect1 id="properties-gtktearoffmenuitem">
    <title>gtk.TearoffMenuItem Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
    <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>

  </refsect1>

  <refsect1 id="style-properties-gtktearoffmenuitem">
    <title>gtk.TearoffMenuItem Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
    <para><link linkend="style-properties-gtkmenuitem">gtk.MenuItem Style Properties</link></para>

  </refsect1>

  <refsect1 id="signal-prototypes-gtktearoffmenuitem">
    <title>gtk.TearoffMenuItem Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkitem">gtk.Item Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkmenuitem">gtk.MenuItem Signal Prototypes</link></para>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>A <link
linkend="class-gtktearoffmenuitem"><classname>gtk.TearoffMenuItem</classname></link> 
is a special <link
linkend="class-gtkmenuitem"><classname>gtk.MenuItem</classname></link> which
is used to tear off and reattach its menu. When its menu is shown normally,
the <link
linkend="class-gtktearoffmenuitem"><classname>gtk.TearoffMenuItem</classname></link> 
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 <link
linkend="class-gtktearoffmenuitem"><classname>gtk.TearoffMenuItem</classname></link> 
is drawn as a dotted line which has a left pointing arrow graphic indicating
that the tearoff menu can be reattached. Activating it will remove the
tearoff menu window.</para>

  </refsect1>

  <refsect1 id="constructor-gtktearoffmenuitem">
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.TearoffMenuItem</methodname>
	<methodparam></methodparam>  </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a new <link
linkend="class-gtktearoffmenuitem"><classname>gtk.TearoffMenuItem</classname></link> 
widget</simpara></listitem>
      </varlistentry>
    </variablelist>

    <para>Creates a new <link
linkend="class-gtktearoffmenuitem"><classname>gtk.TearoffMenuItem</classname></link> 
widget.</para>

  </refsect1>

</refentry>