reference: pygtk-gtkaction.xml: add new methods

2 files changed, 65 insertions, 0 deletions

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index faf2caa1..d8e9a3b9 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -2,6 +2,7 @@
 
 		* pygtk-gtkaboutdialog.xml: fix (s|g)et_name and (s|g)et_program_name.
 		* pygtk-gtkaccessible.xml: add new methods
+		* pygtk-gtkaction.xml: add new methods
 
 2011-01-12  Dieter Verfaillie  <dieterv@optionexplicit.be>
 
diff --git a/docs/reference/pygtk-gtkaction.xml b/docs/reference/pygtk-gtkaction.xml
index 479b807b..548ef1e1 100644
--- a/docs/reference/pygtk-gtkaction.xml
+++ b/docs/reference/pygtk-gtkaction.xml
@@ -130,6 +130,14 @@ item (new in PyGTK 2.4)</refpurpose>
         <methodparam></methodparam>
       </methodsynopsis>
       <methodsynopsis language="python">
+        <methodname><link linkend="method-gtkaction--get-always-show-image">get_always_show_image</link></methodname>
+        <methodparam></methodparam>
+      </methodsynopsis>
+      <methodsynopsis language="python">
+        <methodname><link linkend="method-gtkaction--set-always-show-image">set_always_show_image</link></methodname>
+        <methodparam><parameter role="keyword">always_show</parameter></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>
@@ -240,6 +248,15 @@ item (new in PyGTK 2.4)</refpurpose>
             </row>
 
             <row valign="top">
+              <entry>"always-show-image"</entry>
+              <entry>Read-Write</entry>
+
+              <entry>If <literal>True</literal>, the action's menu item proxies will ignore the "gtk-menu-images"
+              setting and always show their image, if available. Use this if the menu item would be useless or
+              hard to use without their image.</entry>
+            </row>
+
+            <row valign="top">
               <entry>"hide-if-empty"</entry>
               <entry>Read-Write</entry>
               <entry>If <literal>True</literal>, empty menu proxies for this
@@ -1279,6 +1296,53 @@ consistent.</para>
 
     </refsect2>
 
+    <refsect2 id="method-gtkaction--get-always-show-image">
+      <title>gtk.Action.get_always_show_image</title>
+
+      <programlisting><methodsynopsis language="python">
+          <methodname>get_always_show_image</methodname>
+          <methodparam></methodparam>
+        </methodsynopsis></programlisting>
+      <variablelist>
+        <varlistentry>
+          <term><emphasis>Returns</emphasis>&nbsp;:</term>
+          <listitem><simpara>Returns <literal>True</literal> if the action's menu item proxies always show their image, <literal>False</literal> otherwise</simpara></listitem>
+        </varlistentry>
+      </variablelist>
+
+      <note>
+        <para>This method is available in PyGTK 2.22 and above.</para>
+      </note>
+
+      <para>The <methodname>get_always_show_image</methodname>() method returns whether the action's
+menu item proxies will ignore the "gtk-menu-images" setting and always show their image, if available.</para>
+
+    </refsect2>
+
+    <refsect2 id="method-gtkaction--set-always-show-image">
+      <title>gtk.Action.set_always_show_image</title>
+
+      <programlisting><methodsynopsis language="python">
+          <methodname>set_always_show_image</methodname>
+          <methodparam><parameter role="keyword">always_show</parameter></methodparam>
+        </methodsynopsis></programlisting>
+      <variablelist>
+        <varlistentry>
+          <term><parameter>always_show</parameter>&nbsp;:</term>
+          <listitem><simpara>If <literal>True</literal> the action's menu item proxies will always show their image</simpara></listitem>
+        </varlistentry>
+      </variablelist>
+
+      <note>
+        <para>This method is available in PyGTK 2.22 and above.</para>
+      </note>
+
+      <para>The <methodname>set_always_show_image</methodname>() method sets whether the action's
+menu item proxies will ignore the "gtk-menu-images" setting and always show their image, if available.
+Use this if the menu item would be useless or hard to use without their image.</para>
+
+    </refsect2>
+
     <refsect2 id="method-gtkaction--set-accel-group">
       <title>gtk.Action.set_accel_group</title>