path: root/docs/reference/pygtk-gtkitemfactory.xml

<?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-gtkitemfactory">
  <refnamediv>
    <refname>gtk.ItemFactory</refname>
    <refpurpose>creates menus, menubars and option menus from a data
description.</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.ItemFactory</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkobject">gtk.Object</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link
linkend="constructor-gtkitemfactory">gtk.ItemFactory</link></methodname>
	<methodparam><parameter
		       role="keyword">container_type</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">path</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">accel_group</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkitemfactory--construct">construct</link></methodname>
	<methodparam><parameter
		       role="keyword">container_type</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">path</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">accel_group</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkitemfactory--get-item">get_item</link></methodname>
	<methodparam><parameter
		       role="keyword">path</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkitemfactory--get-widget">get_widget</link></methodname>
	<methodparam><parameter
		       role="keyword">path</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkitemfactory--get-widget-by-action">get_widget_by_action</link></methodname>
	<methodparam><parameter
		       role="keyword">action</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkitemfactory--get-item-by-action">get_item_by_action</link></methodname>
	<methodparam><parameter
		       role="keyword">action</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkitemfactory--create-items">create_items</link></methodname>
	<methodparam><parameter
		       role="keyword">entries</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">callback_data</parameter><initializer>None</initializer></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkitemfactory--delete-item">delete_item</link></methodname>
	<methodparam><parameter
		       role="keyword">path</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkitemfactory--popup">popup</link></methodname>
	<methodparam><parameter role="keyword">x</parameter></methodparam>
	<methodparam><parameter role="keyword">y</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">mouse_button</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">time</parameter><initializer>GDK_CURRENT_TIME</initializer></methodparam>
      </methodsynopsis>
    </classsynopsis>

<programlisting>
<emphasis role="bold">Functions</emphasis>

<methodsynopsis language="python">
    <methodname><link linkend="function-gtk--item-factory-from-widget">gtk.item_factory_from_widget</link></methodname>
    <methodparam><parameter role="keyword">widget</parameter></methodparam>
  </methodsynopsis><methodsynopsis language="python">
    <methodname><link linkend="function-gtk--item-factory-path-from-widget">gtk.item_factory_path_from_widget</link></methodname>
    <methodparam><parameter role="keyword">widget</parameter></methodparam>
  </methodsynopsis></programlisting>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkitemfactory">gtk.ItemFactory</link>
</synopsis>

  </refsect1>

  <refsect1 id="properties-gtkitemfactory">
    <title>gtk.ItemFactory Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkitemfactory">
    <title>gtk.ItemFactory 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>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <warning>
      <para><link
linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>
is deprecated in PyGTK 2.4 and above. The <link
linkend="class-gtkuimanager"><classname>gtk.UIManager</classname></link>
should be used instead.</para>
    </warning>

    <para>The <link
linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>
provides a convenient way to create and manage menus, menubars and option
menus from a data description. The data description is a tuple or list
containing a list of entry tuples that each describe an individual menu,
menuitem, etc. Each entry tuple may contain the following entry fields
though only the path must be specified; the other fields are
optional:</para>

    <itemizedlist>
      <listitem>
	<simpara>A path that defines the logical position of the menu or
menuitem in the menu hierarchy. a path is similar to a file path in that it
starts with a slash (/) character and all components are joined by a slash
(/) character. The last component may have an underscore that indicates that
the following character is to be used as the accelerator mnemonic.</simpara>
      </listitem>
      <listitem>
	<simpara>An accelerator that defines a key sequence that will
activate the menuitem. The key sequence is a set of zero or more modifiers
followed by a single key. The modifier keys are:</simpara>

	<variablelist>
	  <varlistentry>
	    <term>"&lt;alt&gt;"</term>
	    <listitem>
	      <simpara><keycap>Alt-L</keycap>or
<keycap>Alt-R</keycap></simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>"&lt;ctl&gt;"</term>
	    <term>"&lt;ctrl&gt;"</term>
	    <term>"&lt;control&gt;"</term>
	    <listitem>
	      <simpara><keycap>Ctrl-L</keycap>or
<keycap>Ctrl-R</keycap></simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>"&lt;shift&gt;"</term>
	    <term>"&lt;shft&gt;"</term>
	    <listitem>
	      <simpara><keycap>Shift-L</keycap>or
<keycap>Shift-R</keycap></simpara>
	    </listitem>
	  </varlistentry>
	</variablelist>

      </listitem>
      <listitem>
	<simpara>A callback function or method that will be invoked when the
menu item is activated or the accelerator key sequence is pressed. The
callback function is defined as either:</simpara>

	<programlisting>
    def callback(callback_data, callback_action, widget)
    def callback(callback_action, widget)
</programlisting>

	<simpara>where <parameter>callback_action</parameter> is the
callback action defined below, <parameter>callback_data</parameter> is the
data passed with the <link
linkend="method-gtkitemfactory--create-items"><methodname>create_items</methodname>()</link> 
method and <parameter>widget</parameter> is the menuitem widget. The second
definition must be used if no <parameter>callback_data</parameter> argument
is specified by the call to <link
linkend="method-gtkitemfactory--create-items"><methodname>create_items</methodname>()</link>.</simpara>
      </listitem>
      <listitem>
	<simpara>A callback action that is an arbitrary integer
value.</simpara>
      </listitem>
      <listitem>
	<simpara>An item type is a string describing the type of the
item:</simpara>

	<variablelist>
	  <varlistentry>
	    <term>"None"</term>
	    <term>""</term>
	    <term>"Item"</term>
	    <listitem>
	      <simpara>a simple menu item</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>"&lt;Title&gt;"</term>
	    <listitem>
	      <simpara>a title item</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>"&lt;ImageItem&gt;"</term>
	    <listitem>
	      <simpara>an image item</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>"&lt;StockItem&gt;"</term>
	    <listitem>
	      <simpara>an item holding a stock image</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>"&lt;CheckItem&gt;"</term>
	    <listitem>
	      <simpara>a check item</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>"&lt;ToggleItem&gt;"</term>
	    <listitem>
	      <simpara>a toggle item</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>"&lt;RadioItem&gt;"</term>
	    <listitem>
	      <simpara>a radio item</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>&lt;path&gt;</term>
	    <listitem>
	      <simpara>the path of a radio item group to add item
to</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>"&lt;Separator&gt;"</term>
	    <listitem>
	      <simpara>a separator</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>"&lt;Tearoff&gt;"</term>
	    <listitem>
	      <simpara>a tearoff separator</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>"&lt;Branch&gt;"</term>
	    <listitem>
	      <simpara>an item to hold sub items</simpara>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>"&lt;LastBranch&gt;"</term>
	    <listitem>
	      <simpara>a right justified item to hold sub items</simpara>
	    </listitem>
	  </varlistentry>
	</variablelist>

      </listitem>
      <listitem>
	<simpara>extra data that is either a <link
linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link> or a
stock ID</simpara>
      </listitem>
   </itemizedlist>

  </refsect1>

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

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.ItemFactory</methodname>
	<methodparam><parameter
		       role="keyword">container_type</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">path</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">accel_group</parameter><initializer>None</initializer></methodparam>
      </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><parameter
role="keyword">container_type</parameter>&nbsp;:</term>
	<listitem><simpara>the kind of menu to create; one of: <link
linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link>, <link
linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> or <link
linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>.</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter role="keyword">path</parameter>&nbsp;:</term>
	<listitem><simpara>the path of the new item factory, a string of the
form <literal>"&lt;name&gt;"</literal></simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><parameter
role="keyword">accel_group</parameter>&nbsp;:</term>
	<listitem><simpara>a <link
linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
to which the accelerators for the menu items will be added, or
<literal>None</literal> to create a new one</simpara></listitem>
      </varlistentry>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a new <link
linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link></simpara></listitem>
      </varlistentry>
    </variablelist>

    <para>Creates a new <link
linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>
object.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkitemfactory--construct">
      <title>gtk.ItemFactory.construct</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>construct</methodname>
	  <methodparam><parameter
			 role="keyword">container_type</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">path</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">accel_group</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">container_type</parameter>&nbsp;:</term>
	  <listitem><simpara>the kind of menu to create; one of: <link
linkend="class-gtkmenubar"><classname>gtk.MenuBar</classname></link>, <link
linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> or <link
linkend="class-gtkoptionmenu"><classname>gtk.OptionMenu</classname></link>.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">path</parameter>&nbsp;:</term>
	  <listitem><simpara>the path of the item factory, a string of the
form <literal>"&lt;name&gt;"</literal></simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">accel_group</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link>
to which the accelerators for the menu items will be added, or
<literal>None</literal> to create a new one</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>construct</methodname>() method initializes an
item factory.</para>

    </refsect2>

    <refsect2 id="method-gtkitemfactory--get-item">
      <title>gtk.ItemFactory.get_item</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_item</methodname>
	  <methodparam><parameter
			 role="keyword">path</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">path</parameter>&nbsp;:</term>
	  <listitem><simpara>the path to the menu item</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the menu item with the specified
<parameter>path</parameter>, or <literal>None</literal> if
<parameter>path</parameter> doesn't lead to a menu item</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_item</methodname>() method returns the menu
item that corresponds to <parameter>path</parameter>. If the widget
corresponding to <parameter>path</parameter> is a menu item that opens a
submenu, then the item is returned. If you are interested in the submenu,
use the <link
linkend="method-gtkitemfactory--get-widget"><methodname>get_widget</methodname>()</link> 
method instead.</para>

    </refsect2>

    <refsect2 id="method-gtkitemfactory--get-widget">
      <title>gtk.ItemFactory.get_widget</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_widget</methodname>
	  <methodparam><parameter
			 role="keyword">path</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">path</parameter>&nbsp;:</term>
	  <listitem><simpara>the path to the widget</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the widget associated with the specified
<parameter>path</parameter>, or <literal>None</literal> if
<parameter>path</parameter> doesn't lead to a widget</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_widget</methodname>() method returns the
widget that corresponds to <parameter>path</parameter>. If the widget
corresponding to <parameter>path</parameter> is a menu item that opens a
submenu, then the submenu is returned. If you are interested in the menu
item, use <link
linkend="method-gtkitemfactory--get-item"><methodname>get_item</methodname>()</link> 
instead.</para>

    </refsect2>

    <refsect2 id="method-gtkitemfactory--get-widget-by-action">
      <title>gtk.ItemFactory.get_widget_by_action</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_widget_by_action</methodname>
	  <methodparam><parameter
			 role="keyword">action</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">action</parameter>&nbsp;:</term>
	  <listitem><simpara>a callback action value</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the widget that corresponds to the given
action, or <literal>None</literal> if no widget was
found</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_widget_by_action</methodname>() method
returns the widget that is associated with the specified
<parameter>action</parameter>. If there are multiple items with the same
<parameter>action</parameter>, the result is undefined.</para>

    </refsect2>

    <refsect2 id="method-gtkitemfactory--get-item-by-action">
      <title>gtk.ItemFactory.get_item_by_action</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_item_by_action</methodname>
	  <methodparam><parameter
			 role="keyword">action</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">action</parameter>&nbsp;:</term>
	  <listitem><simpara>a callback action value</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the menu item that corresponds to the specified
<parameter>action</parameter>, or <literal>None</literal> if no menu item
was found</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_item_by_action</methodname>() returns the
menu item that is associated with the specified
<parameter>action</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkitemfactory--create-items">
      <title>gtk.ItemFactory.create_items</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>create_items</methodname>
	  <methodparam><parameter
			 role="keyword">entries</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">callback_data</parameter><initializer>None</initializer></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">entries</parameter>&nbsp;:</term>
	  <listitem><simpara>a tuple or list of item factory
entries</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">callback_data</parameter>&nbsp;:</term>
	  <listitem><simpara>optional data passed to the callback functions
of all entries</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>create_items</methodname>() method creates the
menu items from the specified item factory <parameter>entries</parameter>.
If no <parameter>callback_data</parameter> is specified it will not be
passed to the callback functions i.e the callback functions will be passed
one less argument.</para>

    </refsect2>

    <refsect2 id="method-gtkitemfactory--delete-item">
      <title>gtk.ItemFactory.delete_item</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>delete_item</methodname>
	  <methodparam><parameter
			 role="keyword">path</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">path</parameter>&nbsp;:</term>
	  <listitem><simpara>a path</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>delete_item</methodname>() method deletes the
menu item that was created with the specified
<parameter>path</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkitemfactory--popup">
      <title>gtk.ItemFactory.popup</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>popup</methodname>
	  <methodparam><parameter role="keyword">x</parameter></methodparam>
	  <methodparam><parameter role="keyword">y</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">mouse_button</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">time</parameter><initializer>0L</initializer></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">x</parameter>&nbsp;:</term>
	  <listitem><simpara>the x position</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">y</parameter>&nbsp;:</term>
	  <listitem><simpara>the y position</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">mouse_button</parameter>&nbsp;:</term>
	  <listitem><simpara>the mouse button that was pressed to initiate
this action</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">time</parameter>&nbsp;:</term>
	  <listitem><simpara>an optional timestamp for this action; default
is 0L which means use the current time</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>popup</methodname>() method pops up the menu
constructed from the item factory at the specified location
(<parameter>x</parameter>, <parameter>y</parameter>). This method is
generally invoked in response to a "button_press_event" so the arguments are
retrieved from the event information.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Functions</title>

    <refsect2 id="function-gtk--item-factory-from-widget">
      <title>gtk.item_factory_from_widget</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.item_factory_from_widget</methodname>
	  <methodparam><parameter
			 role="keyword">widget</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
object</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the <link
	  linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>
	  that created <parameter>widget</parameter></simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <function>gtk.item_factory_from_widget</function>() function
returns the <link
linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>
object that created the <link
linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> specified
by <parameter>widget</parameter>.</para>

    </refsect2>

    <refsect2 id="function-gtk--item-factory-path-from-widget">
      <title>gtk.item_factory_path_from_widget</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.item_factory_path_from_widget</methodname>
	  <methodparam><parameter
			 role="keyword">widget</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
object</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the full path to the <link
linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>
that created <parameter>widget</parameter></simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <function>gtk.item_factory_path_from_widget</function>()
function returns the full path to the <link
linkend="class-gtkitemfactory"><classname>gtk.ItemFactory</classname></link>
that created the <link
linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> specified
by <parameter>widget</parameter>.</para>

    </refsect2>

  </refsect1>

</refentry>