diff options
Diffstat (limited to 'docs/reference/pygtk-gtktoolitemgroup.xml')
| -rw-r--r-- | docs/reference/pygtk-gtktoolitemgroup.xml | 521 |
1 files changed, 521 insertions, 0 deletions
diff --git a/docs/reference/pygtk-gtktoolitemgroup.xml b/docs/reference/pygtk-gtktoolitemgroup.xml new file mode 100644 index 00000000..84e2a841 --- /dev/null +++ b/docs/reference/pygtk-gtktoolitemgroup.xml @@ -0,0 +1,521 @@ +<?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-gtktoolitemgroup"> + <refnamediv> + <refname>gtk.ToolItemGroup</refname> + <refpurpose></refpurpose> + </refnamediv> + + <refsect1> + <title>Synopsis</title> + + <classsynopsis language="python"> + <ooclass><classname>gtk.ToolItemGroup</classname></ooclass> + <ooclass><classname><link linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass> + <constructorsynopsis language="python"> + <methodname><link linkend="constructor-gtktoolitemgroup">gtk.ToolItemGroup</link></methodname> + <methodparam><parameter role="keyword">label</parameter></methodparam> + </constructorsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--set-label">set_label</link></methodname> + <methodparam><parameter role="keyword">label</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--set-label-widget">set_label_widget</link></methodname> + <methodparam><parameter role="keyword">label_widget</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--set-collapsed">set_collapsed</link></methodname> + <methodparam><parameter role="keyword">collapsed</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--set-ellipsize">set_ellipsize</link></methodname> + <methodparam><parameter role="keyword">ellipsize</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--set-header-relief">set_header_relief</link></methodname> + <methodparam><parameter role="keyword">style</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--get-label">get_label</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--get-label-widget">get_label_widget</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--get-collapsed">get_collapsed</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--get-ellipsize">get_ellipsize</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--get-header-relief">get_header_relief</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--insert">insert</link></methodname> + <methodparam><parameter role="keyword">item</parameter></methodparam> + <methodparam><parameter role="keyword">position</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--set-item-position">set_item_position</link></methodname> + <methodparam><parameter role="keyword">item</parameter></methodparam> + <methodparam><parameter role="keyword">position</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--get-item-position">get_item_position</link></methodname> + <methodparam><parameter role="keyword">item</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--get-n-items">get_n_items</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--get-nth-item">get_nth_item</link></methodname> + <methodparam><parameter role="keyword">index</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitemgroup--get-drop-item">get_drop_item</link></methodname> + <methodparam><parameter role="keyword">x</parameter></methodparam> + <methodparam><parameter role="keyword">y</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + + </refsect1> + + <refsect1> + <title>Ancestry</title> + +<synopsis>+-- <link linkend="class-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-gtktoolitemgroup">gtk.ToolItemGroup</link> +</synopsis> + + </refsect1> + + <refsect1> + <title>Constructor</title> + + <programlisting> + <constructorsynopsis language="python"> + <methodname><link linkend="constructor-gtktoolitemgroup">gtk.ToolItemGroup</link></methodname> + <methodparam><parameter role="keyword">label</parameter></methodparam> + </constructorsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">label</parameter> :</term> + <listitem><simpara>the label of the new group</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a new <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link>.</simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This constructor is available in PyGTK 2.20 and above.</para> + </note> + + <para>Creates a new tool item group with label <parameter>label</parameter>.</para> + + + </refsect1> + + <refsect1> + <title>Methods</title> + + <refsect2 id="method-gtktoolitemgroup--set-label"> + <title>gtk.ToolItemGroup.set_label</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>set_label</methodname> + <methodparam><parameter role="keyword">label</parameter></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">label</parameter> :</term> + <listitem><simpara>the new human-readable label of of the group</simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>The <methodname>set_label</methodname>() method sets the label of the tool item group. The label is displayed in the header +of the group.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--set-label-widget"> + <title>gtk.ToolItemGroup.set_label_widget</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>set_label_widget</methodname> + <methodparam><parameter role="keyword">label_widget</parameter></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">label_widget</parameter> :</term> + <listitem><simpara>the widget to be displayed in place of the usual label</simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>The <methodname>set_label_widget</methodname>() method sets the label of the tool item group. +The label widget is displayed in the header of the group, in place +of the usual label.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--set-collapsed"> + <title>gtk.ToolItemGroup.set_collapsed</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>set_collapsed</methodname> + <methodparam><parameter role="keyword">collapsed</parameter></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">collapsed</parameter> :</term> + <listitem><simpara>whether the <parameter>group</parameter> should be collapsed or expanded</simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>Sets whether the <parameter>group</parameter> should be collapsed or expanded.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--set-ellipsize"> + <title>gtk.ToolItemGroup.set_ellipsize</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>set_ellipsize</methodname> + <methodparam><parameter role="keyword">ellipsize</parameter></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">ellipsize</parameter> :</term> + <listitem><simpara>the <literal>PangoEllipsizeMode</literal> labels in <parameter>group</parameter> should use</simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>The <methodname>set_ellipsize</methodname>() method sets the ellipsization mode which should be used by labels in <parameter>group</parameter>.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--set-header-relief"> + <title>gtk.ToolItemGroup.set_header_relief</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>set_header_relief</methodname> + <methodparam><parameter role="keyword">style</parameter></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">style</parameter> :</term> + <listitem><simpara>the <literal>GtkReliefStyle</literal></simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>Set the button relief of the group header. +See <link linkend="method-gtkbutton--set-relief"><methodname>gtk.Button.set_relief</methodname></link> for details.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--get-label"> + <title>gtk.ToolItemGroup.get_label</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>get_label</methodname> + <methodparam></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the label of <parameter>group</parameter>. The label is an internal string of <parameter>group</parameter> and must not be modified. Note that <literal>NULL</literal> is returned if a custom label has been set with <link linkend="method-gtktoolitemgroup--set-label-widget"><methodname>gtk.ToolItemGroup.set_label_widget</methodname></link></simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>Gets the label of <parameter>group</parameter>.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--get-label-widget"> + <title>gtk.ToolItemGroup.get_label_widget</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>get_label_widget</methodname> + <methodparam></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the label widget of <parameter>group</parameter></simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>Gets the label widget of <parameter>group</parameter>. +See <link linkend="method-gtktoolitemgroup--set-label-widget"><methodname>gtk.ToolItemGroup.set_label_widget</methodname></link>.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--get-collapsed"> + <title>gtk.ToolItemGroup.get_collapsed</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>get_collapsed</methodname> + <methodparam></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>TRUE</literal> if <parameter>group</parameter> is collapsed, <literal>FALSE</literal> if it is expanded</simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>Gets whether <parameter>group</parameter> is collapsed or expanded.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--get-ellipsize"> + <title>gtk.ToolItemGroup.get_ellipsize</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>get_ellipsize</methodname> + <methodparam></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the <literal>PangoEllipsizeMode</literal> of <parameter>group</parameter></simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>Gets the ellipsization mode of <parameter>group</parameter>.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--get-header-relief"> + <title>gtk.ToolItemGroup.get_header_relief</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>get_header_relief</methodname> + <methodparam></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the <literal>GtkReliefStyle</literal></simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>Gets the relief mode of the header button of <parameter>group</parameter>.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--insert"> + <title>gtk.ToolItemGroup.insert</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>insert</methodname> + <methodparam><parameter role="keyword">item</parameter></methodparam> + <methodparam><parameter role="keyword">position</parameter></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">item</parameter> :</term> + <listitem><simpara>the <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> to insert into <parameter>group</parameter></simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">position</parameter> :</term> + <listitem><simpara>the position of <parameter>item</parameter> in <parameter>group</parameter>, starting with 0. The position -1 means end of list.</simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>Inserts <parameter>item</parameter> at <parameter>position</parameter> in the list of children of <parameter>group</parameter>.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--set-item-position"> + <title>gtk.ToolItemGroup.set_item_position</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>set_item_position</methodname> + <methodparam><parameter role="keyword">item</parameter></methodparam> + <methodparam><parameter role="keyword">position</parameter></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">item</parameter> :</term> + <listitem><simpara>the <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> to move to a new position, should be a child of <parameter>group</parameter>.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">position</parameter> :</term> + <listitem><simpara>the new position of <parameter>item</parameter> in <parameter>group</parameter>, starting with 0. The position -1 means end of list.</simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>The <methodname>set_item_position</methodname>() method sets the position of <parameter>item</parameter> in the list of children of <parameter>group</parameter>.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--get-item-position"> + <title>gtk.ToolItemGroup.get_item_position</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>get_item_position</methodname> + <methodparam><parameter role="keyword">item</parameter></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">item</parameter> :</term> + <listitem><simpara>a <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link></simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the index of <parameter>item</parameter> in <parameter>group</parameter> or -1 if <parameter>item</parameter> is no child of <parameter>group</parameter></simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>Gets the position of <parameter>item</parameter> in <parameter>group</parameter> as index.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--get-n-items"> + <title>gtk.ToolItemGroup.get_n_items</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>get_n_items</methodname> + <methodparam></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the number of tool items in <parameter>group</parameter></simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>Gets the number of tool items in <parameter>group</parameter>.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--get-nth-item"> + <title>gtk.ToolItemGroup.get_nth_item</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>get_nth_item</methodname> + <methodparam><parameter role="keyword">index</parameter></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">index</parameter> :</term> + <listitem><simpara>the index</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> at index</simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>Gets the tool item at <parameter>index</parameter> in group.</para> + </refsect2> + + <refsect2 id="method-gtktoolitemgroup--get-drop-item"> + <title>gtk.ToolItemGroup.get_drop_item</title> + + <programlisting> + <methodsynopsis language="python"> + <methodname>get_drop_item</methodname> + <methodparam><parameter role="keyword">x</parameter></methodparam> + <methodparam><parameter role="keyword">y</parameter></methodparam> + </methodsynopsis> + </programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">x</parameter> :</term> + <listitem><simpara>the x position</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">y</parameter> :</term> + <listitem><simpara>the y position</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> at position (x, y)</simpara></listitem> + </varlistentry> + </variablelist> + <note> + <para>This method is available in PyGTK 2.20 and above.</para> + </note> + + <para>Gets the tool item at position (x, y).</para> + </refsect2> + + </refsect1> + +</refentry> |