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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
|
<?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-thunarx-python-menu-item">
<refnamediv>
<refname>Thunarx.MenuItem</refname>
<refpurpose>Thunarx.MenuItem Reference</refpurpose>
</refnamediv>
<!-- ******************************* -->
<!-- BEGIN OF NAUTILUS-PYTHON SYNOPSIS -->
<!-- ******************************* -->
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>Thunarx.MenuItem</classname></ooclass>
<ooclass><classname><link linkend="class-ginterface">GObject.GInterface</link></classname></ooclass>
<methodsynopsis language="python">
<methodname><link linkend="method-thunarx-python-menu-item--set-sensitive">set_sensitive</link></methodname>
<methodparam>Boolean</methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-thunarx-python-menu-item--get-sensitive">get_sensitive</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-thunarx-python-menu-item--set-menu">set_menu</link></methodname>
<methodparam>ThunarxMenu</methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-thunarx-python-menu-item--activate">activate</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<!-- ********************************* -->
<!-- BEGIN OF ANCESTRY -->
<!-- ********************************* -->
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-ginterface">GObject.GInterface</link>
+-- <link linkend="class-thunarx-python-menu-item">Thunarx.MenuItem</link>
</synopsis>
</refsect1>
<!-- ********************************** -->
<!-- BEGIN OF DESCRIPTION -->
<!-- ********************************** -->
<refsect1 id="description-menu-item">
<title>Description</title>
<para>
Each <link linkend="class-thunarx-python-menu-item"><classname>Thunarx.MenuItem</classname></link> object is an abstraction
of a real menu item.
</para>
</refsect1>
<!-- ****************************************** -->
<!-- BEGIN OF SIGNAL PROTOTYPES -->
<!-- ****************************************** -->
<refsect1>
<title>Signals</title>
<variablelist>
<varlistentry>
<term><link linkend="signal-thunarx-python-menu-item--activate">"activate"</link></term>
<listitem>
<methodsynopsis language="python"><methodname>callback</methodname>
</methodsynopsis>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<!-- ******************************** -->
<!-- BEGIN OF METHODS -->
<!-- ******************************** -->
<refsect1>
<title>Public Methods</title>
<refsect2 id="method-thunarx-python-menu-item--get-sensitive">
<title>Thunarx.MenuItem.get_sensitive</title>
<programlisting><methodsynopsis language="python">
<methodname>get_sensitive</methodname>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :Boolean</term>
<listitem><simpara>Returns whether the menu item is sensitive.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="method-thunarx-python-menu-item--set-sensitive">
<title>Thunarx.MenuItem.set_sensitive</title>
<programlisting><methodsynopsis language="python">
<methodname>set_sensitive</methodname>
<methodparam>Boolean</methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>Set whether the menu item is sensitive.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="method-thunarx-python-menu-item--set-menu">
<title>Thunarx.MenuItem.set_menu</title>
<programlisting><methodsynopsis language="python">
<methodname>set_menu</methodname>
<methodparam>ThunarxMenu</methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>Add a menu to the menu item (i.e. submenu)</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id="method-thunarx-python-menu-item--activate">
<title>Thunarx.MenuItem.activate</title>
<programlisting><methodsynopsis language="python">
<methodname>activate</methodname>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>Emits the ::activate signal on menu_item. This method should not be invoked by thunarx-python plugins, instead the file manager itself will use this method to emit ::activate whenever it notices a change on menu_item.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<!-- ******************************** -->
<!-- BEGIN OF SIGNAL DETAILS -->
<!-- ******************************** -->
<refsect1>
<title>Signal Details</title>
<refsect2 id="signal-thunarx-python-menu-item--activate">
<title>The "activate" Thunarx.MenuItem Signal</title>
<para>
Emitted whenever the system notices a change to menu_item.
</para><para>
Thunar plugins should use this signal to stay informed about changes to a menu_item for which they currently display information (i.e. in a Thunarx.PropertyPage), and update it's user interface whenever a change is noticed on menu_item.
</para>
</refsect2>
</refsect1>
</refentry>
|