diff options
| author | Gian Mario Tagliaretti <gianmt@gnome.org> | 2009-07-05 11:04:30 +0200 |
|---|---|---|
| committer | Gian Mario Tagliaretti <gianmt@gnome.org> | 2009-07-05 11:04:30 +0200 |
| commit | 4566a076486f0e3b610e6597ecf3b2d10df0ac55 (patch) | |
| tree | d3a30110f6c6edc1b3dc5ff5705c2e3abefab6f3 /docs/reference/pygtk-gtkaction.xml | |
| parent | 3df3b3894626d63c951b833b0a94a16edbaf44f8 (diff) | |
| download | pygtk-4566a076486f0e3b610e6597ecf3b2d10df0ac55.tar.gz | |
Update docs for gtk.Action class
Reorder the index alphabetically and add API new in GTK+ 2.16
Diffstat (limited to 'docs/reference/pygtk-gtkaction.xml')
| -rw-r--r-- | docs/reference/pygtk-gtkaction.xml | 1338 |
1 files changed, 968 insertions, 370 deletions
diff --git a/docs/reference/pygtk-gtkaction.xml b/docs/reference/pygtk-gtkaction.xml index ef1b073f..479b807b 100644 --- a/docs/reference/pygtk-gtkaction.xml +++ b/docs/reference/pygtk-gtkaction.xml @@ -15,107 +15,187 @@ item (new in PyGTK 2.4)</refpurpose> <ooclass><classname>gtk.Action</classname></ooclass> <ooclass><classname><link linkend="class-gobject">gobject.GObject</link></classname></ooclass> <constructorsynopsis language="python"> - <methodname><link linkend="constructor-gtkaction">gtk.Action</link></methodname> - <methodparam><parameter role="keyword">name</parameter></methodparam> - <methodparam><parameter role="keyword">label</parameter></methodparam> - <methodparam><parameter role="keyword">tooltip</parameter></methodparam> - <methodparam><parameter role="keyword">stock_id</parameter></methodparam> + <methodname><link linkend="constructor-gtkaction">gtk.Action</link></methodname> + <methodparam><parameter role="keyword">name</parameter></methodparam> + <methodparam><parameter role="keyword">label</parameter></methodparam> + <methodparam><parameter role="keyword">tooltip</parameter></methodparam> + <methodparam><parameter role="keyword">stock_id</parameter></methodparam> </constructorsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--get-name">get_name</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkaction--activate">activate</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--is-sensitive">is_sensitive</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkaction--block-activate">block_activate</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--get-sensitive">get_sensitive</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkaction--block-activate-from">block_activate_from</link></methodname> + <methodparam><parameter role="keyword">proxy</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--is-visible">is_visible</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkaction--connect-accelerator">connect_accelerator</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--get-visible">get_visible</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkaction--connect-proxy">connect_proxy</link></methodname> + <methodparam><parameter role="keyword">proxy</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--activate">activate</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkaction--create-icon">create_icon</link></methodname> + <methodparam><parameter role="keyword">icon_size</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--create-icon">create_icon</link></methodname> - <methodparam><parameter role="keyword">icon_size</parameter></methodparam> + <methodname><link linkend="method-gtkaction--create-menu">create_menu</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--create-menu">create_menu</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkaction--create-menu-item">create_menu_item</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--create-menu-item">create_menu_item</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkaction--create-tool-item">create_tool_item</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--create-tool-item">create_tool_item</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkaction--disconnect-accelerator">disconnect_accelerator</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--connect-proxy">connect_proxy</link></methodname> - <methodparam><parameter role="keyword">proxy</parameter></methodparam> + <methodname><link linkend="method-gtkaction--disconnect-proxy">disconnect_proxy</link></methodname> + <methodparam><parameter role="keyword">proxy</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--disconnect-proxy">disconnect_proxy</link></methodname> - <methodparam><parameter role="keyword">proxy</parameter></methodparam> + <methodname><link linkend="method-gtkaction--get-accel-path">get_accel_path</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--get-proxies">get_proxies</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkaction--get-gicon">get_gicon</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--connect-accelerator">connect_accelerator</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkaction--get-icon-name">get_icon_name</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--disconnect-accelerator">disconnect_accelerator</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkaction--get-is-important">get_is_important</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--block-activate-from">block_activate_from</link></methodname> - <methodparam><parameter role="keyword">proxy</parameter></methodparam> + <methodname><link linkend="method-gtkaction--get-label">get_label</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--unblock-activate-from">unblock_activate_from</link></methodname> - <methodparam><parameter role="keyword">proxy</parameter></methodparam> + <methodname><link linkend="method-gtkaction--get-name">get_name</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--get-accel-path">get_accel_path</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkaction--get-proxies">get_proxies</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--set-accel-path">set_accel_path</link></methodname> - <methodparam><parameter role="keyword">accel_path</parameter></methodparam> + <methodname><link linkend="method-gtkaction--get-visible">get_visible</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--set-accel-group">set_accel_group</link></methodname> - <methodparam><parameter role="keyword">accel_group</parameter></methodparam> + <methodname><link linkend="method-gtkaction--get-short-label">get_short_label</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--set-sensitive">set_sensitive</link></methodname> - <methodparam><parameter role="keyword">sensitive</parameter></methodparam> + <methodname><link linkend="method-gtkaction--get-sensitive">get_sensitive</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--get-stock-id">get_stock_id</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--get-tooltip">get_tooltip</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--get-visible-horizontal">get_visible_horizontal</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--get-visible-vertical">get_visible_vertical</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--is-sensitive">is_sensitive</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--is-visible">is_visible</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--set-accel-group">set_accel_group</link></methodname> + <methodparam><parameter role="keyword">accel_group</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--set-accel-path">set_accel_path</link></methodname> + <methodparam><parameter role="keyword">accel_path</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--set-gicon">set_gicon</link></methodname> + <methodparam><parameter role="keyword">icon</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--set-icon-name">set_icon_name</link></methodname> + <methodparam><parameter role="keyword">icon_name</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--set-is-important">set_is_important</link></methodname> + <methodparam><parameter role="keyword">is_important</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--set-label">set_label</link></methodname> + <methodparam><parameter role="keyword">label</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--set-visible">set_visible</link></methodname> - <methodparam><parameter role="keyword">visible</parameter></methodparam> + <methodname><link linkend="method-gtkaction--set-menu-item-type">set_menu_item_type</link></methodname> + <methodparam><parameter role="keyword">visible</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--set-sensitive">set_sensitive</link></methodname> + <methodparam><parameter role="keyword">sensitive</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--set-short-label">set_short_label</link></methodname> + <methodparam><parameter role="keyword">short_label</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--set-stock-id">set_stock_id</link></methodname> + <methodparam><parameter role="keyword">stock_id</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--set-menu-item-type">set_menu_item_type</link></methodname> - <methodparam><parameter role="keyword">visible</parameter></methodparam> + <methodname><link linkend="method-gtkaction--set-tool-item-type">set_tool_item_type</link></methodname> + <methodparam><parameter role="keyword">visible</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkaction--set-tool-item-type">set_tool_item_type</link></methodname> - <methodparam><parameter role="keyword">visible</parameter></methodparam> + <methodname><link linkend="method-gtkaction--set-tooltip">set_tooltip</link></methodname> + <methodparam><parameter role="keyword">tooltip</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--set-visible-horizontal">set_visible_horizontal</link></methodname> + <methodparam><parameter role="keyword">visible_horizontal</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--set-visible-vertical">set_visible_vertical</link></methodname> + <methodparam><parameter role="keyword">visible_vertical</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--set-visible">set_visible</link></methodname> + <methodparam><parameter role="keyword">visible</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--unblock-activate">unblock_activate</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkaction--unblock-activate-from">unblock_activate_from</link></methodname> + <methodparam><parameter role="keyword">proxy</parameter></methodparam> </methodsynopsis> </classsynopsis> @@ -131,115 +211,125 @@ item (new in PyGTK 2.4)</refpurpose> </refsect1> <refsect1> - <title>Implemented Interfaces</title> - <para> - <link linkend="class-gtkaction"><classname>gtk.Action</classname></link> - implements - <link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link> - </para> - </refsect1> + <title>Implemented Interfaces</title> + <para> + <link linkend="class-gtkaction"><classname>gtk.Action</classname></link> + implements + <link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link> + </para> + </refsect1> <refsect1 id="properties-gtkaction"> <title>gtk.Action Properties</title> <blockquote role="properties"> <informaltable pgwide="1" frame="none"> - <tgroup cols="3"> - <colspec column="1" colwidth="1in"/> - <colspec column="2" colwidth="1in"/> - <colspec column="3" colwidth="4in"/> - <tbody> - - <row valign="top"> - <entry>"action-group"</entry> - <entry>Read-Write</entry> - - <entry>The <link -linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link> -this <link -linkend="class-gtkaction"><classname>gtk.Action</classname></link> is -associated with, or <literal>None</literal> (for internal use).</entry> - </row> - - <row valign="top"> - <entry>"hide-if-empty"</entry> - <entry>Read-Write</entry> - <entry>If <literal>True</literal>, empty menu proxies for this + <tgroup cols="3"> + <colspec column="1" colwidth="1in"/> + <colspec column="2" colwidth="1in"/> + <colspec column="3" colwidth="4in"/> + <tbody> + + <row valign="top"> + <entry>"action-group"</entry> + <entry>Read-Write</entry> + + <entry>The <link linkend="class-gtkactiongroup"><classname>gtk.ActionGroup</classname></link> + this <link linkend="class-gtkaction"><classname>gtk.Action</classname></link> is + associated with, or <literal>None</literal> (for internal use).</entry> + </row> + + <row valign="top"> + <entry>"hide-if-empty"</entry> + <entry>Read-Write</entry> + <entry>If <literal>True</literal>, empty menu proxies for this action are hidden.</entry> - </row> - - <row valign="top"> - <entry>"is-important"</entry> - <entry>Read-Write</entry> - <entry>If <literal>True</literal>, <link + </row> + + <row valign="top"> + <entry>"gicon"</entry> + <entry>Read-Write</entry> + <entry> + The <link linkend="class-gioicon"><classname>gio.Icon</classname></link> displayed in the + <link linkend="class-gtkaction"><classname>gtk.Action</classname></link>. + Note that the stock icon is preferred, if the "stock-id" property holds the id of an existing stock icon. + This is an appearance property and thus only applies if "use-action-appearance" is <literal>True</literal>. + This property is available in GTK+ 2.16 and above. + </entry> + </row> + + <row valign="top"> + <entry>"is-important"</entry> + <entry>Read-Write</entry> + <entry>If <literal>True</literal>, <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> proxies for this action show text in <literal>gtk.TOOLBAR_BOTH_HORIZ</literal> mode.</entry> - </row> + </row> - <row valign="top"> - <entry>"label"</entry> - <entry>Read-Write</entry> - <entry>The label used for menu items and buttons that activate + <row valign="top"> + <entry>"label"</entry> + <entry>Read-Write</entry> + <entry>The label used for menu items and buttons that activate this action.</entry> - </row> - - <row valign="top"> - <entry>"name"</entry> - <entry>Read-Write-Construct Only</entry> - <entry>A unique name for the action.</entry> - </row> - - <row valign="top"> - <entry>"sensitive"</entry> - <entry>Read-Write</entry> - <entry>If <literal>True</literal>, the action is + </row> + + <row valign="top"> + <entry>"name"</entry> + <entry>Read-Write-Construct Only</entry> + <entry>A unique name for the action.</entry> + </row> + + <row valign="top"> + <entry>"sensitive"</entry> + <entry>Read-Write</entry> + <entry>If <literal>True</literal>, the action is enabled.</entry> - </row> + </row> - <row valign="top"> - <entry>"short-label"</entry> - <entry>Read-Write</entry> - <entry>A shorter label that may be used on toolbar + <row valign="top"> + <entry>"short-label"</entry> + <entry>Read-Write</entry> + <entry>A shorter label that may be used on toolbar buttons.</entry> - </row> + </row> - <row valign="top"> - <entry>"stock-id"</entry> - <entry>Read-Write</entry> - <entry>The stock icon displayed in widgets representing this + <row valign="top"> + <entry>"stock-id"</entry> + <entry>Read-Write</entry> + <entry>The stock icon displayed in widgets representing this action.</entry> - </row> - - <row valign="top"> - <entry>"tooltip"</entry> - <entry>Read-Write</entry> - <entry>A tooltip for this action.</entry> - </row> - - <row valign="top"> - <entry>"visible"</entry> - <entry>Read-Write</entry> - <entry>If <literal>True</literal>, the action is + </row> + + <row valign="top"> + <entry>"tooltip"</entry> + <entry>Read-Write</entry> + <entry>A tooltip for this action.</entry> + </row> + + <row valign="top"> + <entry>"visible"</entry> + <entry>Read-Write</entry> + <entry>If <literal>True</literal>, the action is visible.</entry> - </row> + </row> - <row valign="top"> - <entry>"visible-horizontal"</entry> - <entry>Read-Write</entry> - <entry>If <literal>True</literal>, the toolbar item is + <row valign="top"> + <entry>"visible-horizontal"</entry> + <entry>Read-Write</entry> + <entry>If <literal>True</literal>, the toolbar item is visible when the toolbar is in a horizontal orientation.</entry> - </row> + </row> - <row valign="top"> - <entry>"visible-vertical"</entry> - <entry>Read-Write</entry> - <entry>If <literal>True</literal>, the toolbar item is + <row valign="top"> + <entry>"visible-vertical"</entry> + <entry>Read-Write</entry> + <entry>If <literal>True</literal>, the toolbar item is visible when the toolbar is in a vertical orientation.</entry> - </row> + </row> - </tbody> - </tgroup> + </tbody> + </tgroup> </informaltable> </blockquote> @@ -285,22 +375,22 @@ activated, the following also gets associated with the action:</para> <itemizedlist> <listitem> - <simpara>a name (not translated, for path lookup)</simpara> + <simpara>a name (not translated, for path lookup)</simpara> </listitem> <listitem> - <simpara>a label (translated, for display)</simpara> + <simpara>a label (translated, for display)</simpara> </listitem> <listitem> - <simpara>an accelerator</simpara> + <simpara>an accelerator</simpara> </listitem> <listitem> - <simpara>whether the label indicates a stock id</simpara> + <simpara>whether the label indicates a stock id</simpara> </listitem> <listitem> - <simpara>a tooltip (optional, translated)</simpara> + <simpara>a tooltip (optional, translated)</simpara> </listitem> <listitem> - <simpara>a toolbar label (optional, shorter than label)</simpara> + <simpara>a toolbar label (optional, shorter than label)</simpara> </listitem> </itemizedlist> @@ -308,10 +398,10 @@ activated, the following also gets associated with the action:</para> <itemizedlist> <listitem> - <simpara>visible (shown/hidden)</simpara> + <simpara>visible (shown/hidden)</simpara> </listitem> <listitem> - <simpara>sensitive (enabled/disabled)</simpara> + <simpara>sensitive (enabled/disabled)</simpara> </listitem> </itemizedlist> @@ -334,35 +424,35 @@ changes. When the proxy is activated, it should activate its action. </para> <title>Constructor</title> <programlisting><constructorsynopsis language="python"> - <methodname>gtk.Action</methodname> - <methodparam><parameter role="keyword">name</parameter></methodparam> - <methodparam><parameter role="keyword">label</parameter></methodparam> - <methodparam><parameter role="keyword">tooltip</parameter></methodparam> - <methodparam><parameter role="keyword">stock_id</parameter></methodparam> + <methodname>gtk.Action</methodname> + <methodparam><parameter role="keyword">name</parameter></methodparam> + <methodparam><parameter role="keyword">label</parameter></methodparam> + <methodparam><parameter role="keyword">tooltip</parameter></methodparam> + <methodparam><parameter role="keyword">stock_id</parameter></methodparam> </constructorsynopsis></programlisting> <variablelist> <varlistentry> - <term><parameter role="keyword">name</parameter> :</term> - <listitem><simpara>a unique name for the <link + <term><parameter role="keyword">name</parameter> :</term> + <listitem><simpara>a unique name for the <link linkend="class-gtkaction"><classname>gtk.Action</classname></link></simpara></listitem> </varlistentry> <varlistentry> - <term><parameter role="keyword">label</parameter> :</term> - <listitem><simpara>the label displayed in menu items and on + <term><parameter role="keyword">label</parameter> :</term> + <listitem><simpara>the label displayed in menu items and on buttons</simpara></listitem> </varlistentry> <varlistentry> - <term><parameter role="keyword">tooltip</parameter> :</term> - <listitem><simpara>a tooltip for the action</simpara></listitem> + <term><parameter role="keyword">tooltip</parameter> :</term> + <listitem><simpara>a tooltip for the action</simpara></listitem> </varlistentry> <varlistentry> - <term><parameter role="keyword">stock_id</parameter> :</term> - <listitem><simpara>the stock icon to display in widgets + <term><parameter role="keyword">stock_id</parameter> :</term> + <listitem><simpara>the stock icon to display in widgets representing the action</simpara></listitem> </varlistentry> <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a new <link + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a new <link linkend="class-gtkaction"><classname>gtk.Action</classname></link></simpara></listitem> </varlistentry> </variablelist> @@ -383,22 +473,153 @@ linkend="method-gtkactiongroup--add-action-with-accel"><methodname>gtk.ActionGro <refsect1> <title>Methods</title> + <refsect2 id="method-gtkaction--block-activate"> + <title>gtk.Action.block_activate</title> + + <programlisting><methodsynopsis language="python"> + <methodname>block_activate</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + <variablelist> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>block_activate</methodname>() method disable activation signals from the action + </para> + <para> + This is needed when updating the state of your proxy + <link linkend="class-gtkactivatable"><classname>gtk.Activatable</classname></link> + widget could result in calling + <methodname><link linkend="method-gtkaction--activate">gtk.Action.activate</link></methodname>(), + this is a convenience function to avoid recursing in those cases (updating toggle state for instance). + </para> + + </refsect2> + + <refsect2 id="method-gtkaction--get-gicon"> + <title>gtk.Action.get_gicon</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_gicon</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>The action's <link linkend="class-gioicon"><classname>gio.Icon</classname></link> + if one is set.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>get_gicon</methodname>() method gets the + <link linkend="class-gioicon"><classname>gio.Icon</classname></link> of action. + </para> + + </refsect2> + + <refsect2 id="method-gtkaction--get-icon-name"> + <title>gtk.Action.get_icon_name</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_icon_name</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the icon name. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>get_icon_name</methodname>() method gets the icon name + of action. + </para> + + </refsect2> + + <refsect2 id="method-gtkaction--get-is-important"> + <title>gtk.Action.get_is_important</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_is_important</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>whether action is important, returning + <literal>True</literal> if it is. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>get_is_important</methodname>() method checks whether + action is important or not. + </para> + + </refsect2> + + <refsect2 id="method-gtkaction--get-label"> + <title>gtk.Action.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 text. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>get_label</methodname>() method gets the label text of action. + </para> + + </refsect2> + <refsect2 id="method-gtkaction--get-name"> <title>gtk.Action.get_name</title> <programlisting><methodsynopsis language="python"> - <methodname>get_name</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> + <methodname>get_name</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the name of the action.</simpara></listitem> - </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the name of the action.</simpara></listitem> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>get_name</methodname>() method returns the value @@ -406,23 +627,150 @@ of the "name" property containing the name of the action.</para> </refsect2> + <refsect2 id="method-gtkaction--get-short-label"> + <title>gtk.Action.get_short_label</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_short_label</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the short label text. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>get_short_label</methodname>() method gets the short label text of action. + </para> + + </refsect2> + + <refsect2 id="method-gtkaction--get-tooltip"> + <title>gtk.Action.get_tooltip</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_tooltip</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the tooltip text. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>get_tooltip</methodname>() method gets the tooltip text of action. + </para> + + </refsect2> + + <refsect2 id="method-gtkaction--get-visible-horizontal"> + <title>gtk.Action.get_visible_horizontal</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_visible_horizontal</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>whether action is visible when horizontal. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>get_visible_horizontal</methodname>() method gets whether + action is visible when horizontal + </para> + + </refsect2> + + <refsect2 id="method-gtkaction--get-visible-vertical"> + <title>gtk.Action.get_visible_vertical</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_visible_vertical</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>whether action is visible when vertical. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>get_visible_vertical</methodname>() method gets whether + action is visible when vertical. + </para> + + </refsect2> + + <refsect2 id="method-gtkaction--get-stock-id"> + <title>gtk.Action.get_stock_id</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_stock_id</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the stock id. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>get_stock_id</methodname>() method gets the stock id of action. + </para> + + </refsect2> + <refsect2 id="method-gtkaction--is-sensitive"> <title>gtk.Action.is_sensitive</title> <programlisting><methodsynopsis language="python"> - <methodname>is_sensitive</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> + <methodname>is_sensitive</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>True</literal> if the action and its + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>True</literal> if the action and its associated action group are both sensitive.</simpara></listitem> - </varlistentry> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>is_sensitive</methodname>() method returns @@ -438,19 +786,19 @@ are sensitive.</para> <title>gtk.Action.get_sensitive</title> <programlisting><methodsynopsis language="python"> - <methodname>get_sensitive</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> + <methodname>get_sensitive</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>True</literal> if the action itself + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>True</literal> if the action itself is sensitive.</simpara></listitem> - </varlistentry> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>get_sensitive</methodname>() method returns the @@ -466,19 +814,19 @@ method for more information.</para> <title>gtk.Action.is_visible</title> <programlisting><methodsynopsis language="python"> - <methodname>is_visible</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> + <methodname>is_visible</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>True</literal> if the action and + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>True</literal> if the action and its associated action group are both visible.</simpara></listitem> - </varlistentry> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>is_visible</methodname>() method returns @@ -494,19 +842,19 @@ as visible.</para> <title>gtk.Action.get_visible</title> <programlisting><methodsynopsis language="python"> - <methodname>get_visible</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> + <methodname>get_visible</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara><literal>True</literal> if the action itself + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>True</literal> if the action itself is visible.</simpara></listitem> - </varlistentry> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>get_visible</methodname>() method returns the @@ -523,12 +871,12 @@ method for more information.</para> <title>gtk.Action.activate</title> <programlisting><methodsynopsis language="python"> - <methodname>activate</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> + <methodname>activate</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>activate</methodname>() method emits the @@ -543,24 +891,24 @@ activated. It can also be used to manually activate an action.</para> <title>gtk.Action.create_icon</title> <programlisting><methodsynopsis language="python"> - <methodname>create_icon</methodname> - <methodparam><parameter role="keyword">icon_size</parameter></methodparam> - </methodsynopsis></programlisting> + <methodname>create_icon</methodname> + <methodparam><parameter role="keyword">icon_size</parameter></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><parameter role="keyword">icon_size</parameter> :</term> - <listitem><simpara>the size of the icon that should be + <varlistentry> + <term><parameter role="keyword">icon_size</parameter> :</term> + <listitem><simpara>the size of the icon that should be created.</simpara></listitem> - </varlistentry> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a widget that displays the icon for this + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a widget that displays the icon for this action.</simpara></listitem> - </varlistentry> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>create_icon</methodname>() method creates and @@ -572,22 +920,22 @@ must be one of:</para> <itemizedlist> <listitem> - <simpara><literal>gtk.ICON_SIZE_MENU</literal></simpara> + <simpara><literal>gtk.ICON_SIZE_MENU</literal></simpara> </listitem> <listitem> - <simpara><literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal></simpara> + <simpara><literal>gtk.ICON_SIZE_SMALL_TOOLBAR</literal></simpara> </listitem> <listitem> - <simpara><literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal></simpara> + <simpara><literal>gtk.ICON_SIZE_LARGE_TOOLBAR</literal></simpara> </listitem> <listitem> - <simpara><literal>gtk.ICON_SIZE_BUTTON</literal></simpara> + <simpara><literal>gtk.ICON_SIZE_BUTTON</literal></simpara> </listitem> <listitem> - <simpara><literal>gtk.ICON_SIZE_DND</literal></simpara> + <simpara><literal>gtk.ICON_SIZE_DND</literal></simpara> </listitem> <listitem> - <simpara><literal>gtk.ICON_SIZE_DIALOG</literal></simpara> + <simpara><literal>gtk.ICON_SIZE_DIALOG</literal></simpara> </listitem> </itemizedlist> @@ -601,19 +949,19 @@ implementations to create icons displayed in the proxy widgets.</para> <title>gtk.Action.create_menu</title> <programlisting><methodsynopsis language="python"> - <methodname>create_menu</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> + <methodname>create_menu</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the menu item provided by the action, or + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the menu item provided by the action, or <literal>None</literal>.</simpara></listitem> - </varlistentry> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.12 and above.</para> + <para>This method is available in PyGTK 2.12 and above.</para> </note> <para> @@ -628,19 +976,19 @@ implementations to create icons displayed in the proxy widgets.</para> <title>gtk.Action.create_menu_item</title> <programlisting><methodsynopsis language="python"> - <methodname>create_menu_item</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> + <methodname>create_menu_item</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a menu item connected to the + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a menu item connected to the action.</simpara></listitem> - </varlistentry> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>create_menu_item</methodname>() method creates @@ -653,18 +1001,18 @@ linkend="class-gtkaction"><classname>gtk.Action</classname></link>.</para> <title>gtk.Action.create_tool_item</title> <programlisting><methodsynopsis language="python"> - <methodname>create_tool_item</methodname> - <methodparam></methodparam> </methodsynopsis></programlisting> + <methodname>create_tool_item</methodname> + <methodparam></methodparam> </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a tool item connected to the + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a tool item connected to the action.</simpara></listitem> - </varlistentry> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>create_tool_item</methodname>() method creates @@ -677,18 +1025,18 @@ linkend="class-gtkaction"><classname>gtk.Action</classname></link>.</para> <title>gtk.Action.connect_proxy</title> <programlisting><methodsynopsis language="python"> - <methodname>connect_proxy</methodname> - <methodparam><parameter role="keyword">proxy</parameter></methodparam> - </methodsynopsis></programlisting> + <methodname>connect_proxy</methodname> + <methodparam><parameter role="keyword">proxy</parameter></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><parameter role="keyword">proxy</parameter> :</term> - <listitem><simpara>the proxy widget</simpara></listitem> - </varlistentry> + <varlistentry> + <term><parameter role="keyword">proxy</parameter> :</term> + <listitem><simpara>the proxy widget</simpara></listitem> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>connect_proxy</methodname>() method connects the @@ -715,18 +1063,18 @@ before calling this method.</para> <title>gtk.Action.disconnect_proxy</title> <programlisting><methodsynopsis language="python"> - <methodname>disconnect_proxy</methodname> - <methodparam><parameter role="keyword">proxy</parameter></methodparam> - </methodsynopsis></programlisting> + <methodname>disconnect_proxy</methodname> + <methodparam><parameter role="keyword">proxy</parameter></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><parameter role="keyword">proxy</parameter> :</term> - <listitem><simpara>the proxy widget</simpara></listitem> - </varlistentry> + <varlistentry> + <term><parameter role="keyword">proxy</parameter> :</term> + <listitem><simpara>the proxy widget</simpara></listitem> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>disconnect_proxy</methodname>() method @@ -745,18 +1093,18 @@ before calling this method.</para> <title>gtk.Action.get_proxies</title> <programlisting><methodsynopsis language="python"> - <methodname>get_proxies</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> + <methodname>get_proxies</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a list of proxy widgets.</simpara></listitem> - </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a list of proxy widgets.</simpara></listitem> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>get_proxies</methodname>() method returns a list @@ -769,12 +1117,12 @@ linkend="class-gtkaction"><classname>gtk.Action</classname></link>.</para> <title>gtk.Action.connect_accelerator</title> <programlisting><methodsynopsis language="python"> - <methodname>connect_accelerator</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> + <methodname>connect_accelerator</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>connect_accelerator</methodname>() method @@ -802,12 +1150,12 @@ has been called as many times.</para> <title>gtk.Action.disconnect_accelerator</title> <programlisting><methodsynopsis language="python"> - <methodname>disconnect_accelerator</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> + <methodname>disconnect_accelerator</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>disconnect_accelerator</methodname>() method @@ -821,18 +1169,18 @@ method.</para> <title>gtk.Action.block_activate_from</title> <programlisting><methodsynopsis language="python"> - <methodname>block_activate_from</methodname> - <methodparam><parameter role="keyword">proxy</parameter></methodparam> - </methodsynopsis></programlisting> + <methodname>block_activate_from</methodname> + <methodparam><parameter role="keyword">proxy</parameter></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><parameter role="keyword">proxy</parameter> :</term> - <listitem><simpara>a proxy widget</simpara></listitem> - </varlistentry> + <varlistentry> + <term><parameter role="keyword">proxy</parameter> :</term> + <listitem><simpara>a proxy widget</simpara></listitem> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>block_activate_from</methodname>() method @@ -852,18 +1200,18 @@ implementations.</para> <title>gtk.Action.unblock_activate_from</title> <programlisting><methodsynopsis language="python"> - <methodname>unblock_activate_from</methodname> - <methodparam><parameter role="keyword">proxy</parameter></methodparam> - </methodsynopsis></programlisting> + <methodname>unblock_activate_from</methodname> + <methodparam><parameter role="keyword">proxy</parameter></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><parameter role="keyword">proxy</parameter> :</term> - <listitem><simpara>a proxy widget</simpara></listitem> - </varlistentry> + <varlistentry> + <term><parameter role="keyword">proxy</parameter> :</term> + <listitem><simpara>a proxy widget</simpara></listitem> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>unblock_activate_from</methodname>() method @@ -884,19 +1232,19 @@ implementations.</para> <title>gtk.Action.get_accel_path</title> <programlisting><methodsynopsis language="python"> - <methodname>get_accel_path</methodname> - <methodparam></methodparam> - </methodsynopsis></programlisting> + <methodname>get_accel_path</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>the accelerator path associated with the action + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the accelerator path associated with the action or <literal>None</literal></simpara></listitem> - </varlistentry> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.6 and above.</para> + <para>This method is available in PyGTK 2.6 and above.</para> </note> <para>The <methodname>get_accel_path</methodname>() method returns the @@ -909,18 +1257,18 @@ set.</para> <title>gtk.Action.set_accel_path</title> <programlisting><methodsynopsis language="python"> - <methodname>set_accel_path</methodname> - <methodparam><parameter role="keyword">accel_path</parameter></methodparam> - </methodsynopsis></programlisting> + <methodname>set_accel_path</methodname> + <methodparam><parameter role="keyword">accel_path</parameter></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><parameter role="keyword">accel_path</parameter> :</term> - <listitem><simpara>the accelerator path</simpara></listitem> - </varlistentry> + <varlistentry> + <term><parameter role="keyword">accel_path</parameter> :</term> + <listitem><simpara>the accelerator path</simpara></listitem> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>set_accel_path</methodname>() method sets the @@ -935,18 +1283,18 @@ consistent.</para> <title>gtk.Action.set_accel_group</title> <programlisting><methodsynopsis language="python"> - <methodname>set_accel_group</methodname> - <methodparam><parameter role="keyword">accel_group</parameter></methodparam> - </methodsynopsis></programlisting> + <methodname>set_accel_group</methodname> + <methodparam><parameter role="keyword">accel_group</parameter></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><parameter role="keyword">accel_group</parameter> :</term> - <listitem><simpara>a <link linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link> or <literal>None</literal></simpara></listitem> - </varlistentry> + <varlistentry> + <term><parameter role="keyword">accel_group</parameter> :</term> + <listitem><simpara>a <link linkend="class-gtkaccelgroup"><classname>gtk.AccelGroup</classname></link> or <literal>None</literal></simpara></listitem> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.4 and above.</para> + <para>This method is available in PyGTK 2.4 and above.</para> </note> <para>The <methodname>set_accel_group</methodname>() method sets the @@ -958,23 +1306,149 @@ linkend="class-gtkaction"><classname>gtk.Action</classname></link>.</para> </refsect2> + <refsect2 id="method-gtkaction--set-gicon"> + <title>gtk.Action.set_gicon</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_gicon</methodname> + <methodparam><parameter role="keyword">icon</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon</parameter> :</term> + <listitem><simpara>the <link linkend="class-gioicon"><classname>gio.Icon</classname></link> to set . + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>set_gicon</methodname>() method sets the icon of action. + </para> + + </refsect2> + + <refsect2 id="method-gtkaction--set-icon-name"> + <title>gtk.Action.set_icon_name</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_icon_name</methodname> + <methodparam><parameter role="keyword">icon_name</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_name</parameter> :</term> + <listitem><simpara>the icon name to set. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>set_icon_name</methodname>() method sets the icon name on action. + </para> + + </refsect2> + + <refsect2 id="method-gtkaction--set-is-important"> + <title>gtk.Action.set_is_important</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_is_important</methodname> + <methodparam><parameter role="keyword">is_important</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">is_important</parameter> :</term> + <listitem><simpara><literal>True</literal> to make the action important + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>set_is_important</methodname>() method sets whether the action is important, + this attribute is used primarily by toolbar items to decide whether to show a label or not. + </para> + + </refsect2> + + <refsect2 id="method-gtkaction--set-label"> + <title>gtk.Action.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 label text to set. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>set_is_important</methodname>() method sets the label of action. + </para> + + </refsect2> + + <refsect2 id="method-gtkaction--set-short-label"> + <title>gtk.Action.set_short_label</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_short_label</methodname> + <methodparam><parameter role="keyword">short_label</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">short_label</parameter> :</term> + <listitem><simpara>the short label text to set. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>set_short_label</methodname>() method sets the short label of action. + </para> + + </refsect2> + <refsect2 id="method-gtkaction--set-sensitive"> <title>gtk.Action.set_sensitive</title> <programlisting><methodsynopsis language="python"> - <methodname>set_sensitive</methodname> - <methodparam><parameter role="keyword">sensitive</parameter></methodparam> - </methodsynopsis></programlisting> + <methodname>set_sensitive</methodname> + <methodparam><parameter role="keyword">sensitive</parameter></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><parameter role="keyword">sensitive</parameter> :</term> - <listitem><simpara>if <literal>True</literal> make the action + <varlistentry> + <term><parameter role="keyword">sensitive</parameter> :</term> + <listitem><simpara>if <literal>True</literal> make the action sensitive</simpara></listitem> - </varlistentry> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.6 and above.</para> + <para>This method is available in PyGTK 2.6 and above.</para> </note> <para>The <methodname>set_sensitive</methodname>() method sets the @@ -985,23 +1459,73 @@ method for more information.</para> </refsect2> + <refsect2 id="method-gtkaction--set-stock-id"> + <title>gtk.Action.set_stock_id</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_stock_id</methodname> + <methodparam><parameter role="keyword">stock_id</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">stock_id</parameter> :</term> + <listitem><simpara>the stock id. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>set_stock_id</methodname>() method sets the stock id on action + </para> + + </refsect2> + + <refsect2 id="method-gtkaction--set-tooltip"> + <title>gtk.Action.set_tooltip</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_tooltip</methodname> + <methodparam><parameter role="keyword">tooltip</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">tooltip</parameter> :</term> + <listitem><simpara>the tooltip text. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>set_tooltip</methodname>() method sets the tooltip text on action. + </para> + + </refsect2> + <refsect2 id="method-gtkaction--set-visible"> <title>gtk.Action.set_visible</title> <programlisting><methodsynopsis language="python"> - <methodname>set_visible</methodname> - <methodparam><parameter role="keyword">visible</parameter></methodparam> - </methodsynopsis></programlisting> + <methodname>set_visible</methodname> + <methodparam><parameter role="keyword">visible</parameter></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><parameter role="keyword">visible</parameter> :</term> - <listitem><simpara>if <literal>True</literal> make the action + <varlistentry> + <term><parameter role="keyword">visible</parameter> :</term> + <listitem><simpara>if <literal>True</literal> make the action visible</simpara></listitem> - </varlistentry> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.6 and above.</para> + <para>This method is available in PyGTK 2.6 and above.</para> </note> <para>The <methodname>set_visible</methodname>() method sets the @@ -1012,23 +1536,75 @@ method for more information.</para> </refsect2> + <refsect2 id="method-gtkaction--set-visible-horizontal"> + <title>gtk.Action.set_visible_horizontal</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_visible_horizontal</methodname> + <methodparam><parameter role="keyword">visible_horizontal</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">visible_horizontal</parameter> :</term> + <listitem><simpara>whether the action is visible horizontally. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>set_visible_horizontal</methodname>() method sets whether action + is visible when horizontal + </para> + + </refsect2> + + <refsect2 id="method-gtkaction--set-visible-vertical"> + <title>gtk.Action.set_visible_vertical</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_visible_vertical</methodname> + <methodparam><parameter role="keyword">visible_vertical</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">visible_vertical</parameter> :</term> + <listitem><simpara>whether the action is visible vertically. + </simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>set_visible_vertical</methodname>() method sets whether action + is visible when vertical + </para> + + </refsect2> + <refsect2 id="method-gtkaction--set-menu-item-type"> <title>gtk.Action.set_menu_item_type</title> <programlisting><methodsynopsis language="python"> - <methodname>set_menu_item_type</methodname> - <methodparam><parameter role="keyword">visible</parameter></methodparam> - </methodsynopsis></programlisting> + <methodname>set_menu_item_type</methodname> + <methodparam><parameter role="keyword">visible</parameter></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><parameter role="keyword">type</parameter> :</term> - <listitem><simpara>the type of menuitem to be created for the - action</simpara></listitem> - </varlistentry> + <varlistentry> + <term><parameter role="keyword">type</parameter> :</term> + <listitem><simpara>the type of menuitem to be created for the + action</simpara></listitem> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.10 and above.</para> + <para>This method is available in PyGTK 2.10 and above.</para> </note> <para>The <methodname>set_menu_item_type</methodname>() method is a @@ -1053,19 +1629,19 @@ method for more information.</para> <title>gtk.Action.set_tool_item_type</title> <programlisting><methodsynopsis language="python"> - <methodname>set_tool_item_type</methodname> - <methodparam><parameter role="keyword">visible</parameter></methodparam> - </methodsynopsis></programlisting> + <methodname>set_tool_item_type</methodname> + <methodparam><parameter role="keyword">visible</parameter></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><parameter role="keyword">type</parameter> :</term> - <listitem><simpara>the type of toolitem to be created for the - action</simpara></listitem> - </varlistentry> + <varlistentry> + <term><parameter role="keyword">type</parameter> :</term> + <listitem><simpara>the type of toolitem to be created for the + action</simpara></listitem> + </varlistentry> </variablelist> <note> - <para>This method is available in PyGTK 2.10 and above.</para> + <para>This method is available in PyGTK 2.10 and above.</para> </note> <para>The <methodname>set_tool_item_type</methodname>() method is a @@ -1134,6 +1710,28 @@ method for more information.</para> </refsect2> + <refsect2 id="method-gtkaction--unblock-activate"> + <title>gtk.Action.unblock_activate</title> + + <programlisting><methodsynopsis language="python"> + <methodname>unblock_activate</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para> + The <methodname>unblock_activate</methodname>() method reenables activation + signals from the action. + </para> + + </refsect2> + </refsect1> <refsect1> @@ -1143,35 +1741,35 @@ method for more information.</para> <title>The "activate" gtk.Action Signal</title> <programlisting><methodsynopsis language="python"> - <methodname>callback</methodname> - <methodparam><parameter>action</parameter></methodparam> - <methodparam><parameter>user_param1</parameter></methodparam> - <methodparam><parameter>...</parameter></methodparam> - </methodsynopsis></programlisting> + <methodname>callback</methodname> + <methodparam><parameter>action</parameter></methodparam> + <methodparam><parameter>user_param1</parameter></methodparam> + <methodparam><parameter>...</parameter></methodparam> + </methodsynopsis></programlisting> <variablelist> - <varlistentry> - <term><parameter>action</parameter> :</term> - <listitem><simpara>the <link + <varlistentry> + <term><parameter>action</parameter> :</term> + <listitem><simpara>the <link linkend="class-gtkaction"><classname>gtk.Action</classname></link> that received the signal</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>user_param1</parameter> :</term> + </varlistentry> + <varlistentry> + <term><parameter>user_param1</parameter> :</term> <listitem><simpara>the first user parameter (if any) specified with the <link linkend="method-gobject--connect"><methodname>connect</methodname>()</link> method</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>...</parameter> :</term> - <listitem><simpara>additional user parameters (if + </varlistentry> + <varlistentry> + <term><parameter>...</parameter> :</term> + <listitem><simpara>additional user parameters (if any)</simpara></listitem> - </varlistentry> + </varlistentry> </variablelist> <note> - <para>This signal is available in PyGTK 2.4 and above.</para> + <para>This signal is available in PyGTK 2.4 and above.</para> </note> <para>The "activate" signal is emitted when |