summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJohn Finlay <finlay@src.gnome.org>2005-06-20 16:31:02 +0000
committerJohn Finlay <finlay@src.gnome.org>2005-06-20 16:31:02 +0000
commit1cd0b5e40c63af15dcd855616c37a68ad85338d0 (patch)
treed36bdedb18cfa5f3161f532f237b0921f03d0467 /docs
parent8679154ac2fcc3d342d7b0eaf6525cf4912b1d2f (diff)
downloadpygtk-1cd0b5e40c63af15dcd855616c37a68ad85338d0.tar.gz
set group can specify None to remove item from group. #170514
* pygtk-gtkradioaction.xml (set_group, get_group): * pygtk-gtkradiobutton.xml (set_group, get_group): * pygtk-gtkradiomenuitem.xml (set_group, get_group): * pygtk-gtkradiotoolbutton.xml (set_group, get_group): set group can specify None to remove item from group. #170514
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/ChangeLog8
-rw-r--r--docs/reference/pygtk-gtkradioaction.xml11
-rw-r--r--docs/reference/pygtk-gtkradiobutton.xml12
-rw-r--r--docs/reference/pygtk-gtkradiomenuitem.xml15
-rw-r--r--docs/reference/pygtk-gtkradiotoolbutton.xml13
5 files changed, 45 insertions, 14 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 6ccd7c4c..47c379bd 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,11 @@
+2005-06-20 John Finlay <finlay@moeraki.com>
+
+ * pygtk-gtkradioaction.xml (set_group, get_group):
+ * pygtk-gtkradiobutton.xml (set_group, get_group):
+ * pygtk-gtkradiomenuitem.xml (set_group, get_group):
+ * pygtk-gtkradiotoolbutton.xml (set_group, get_group):
+ set group can specify None to remove item from group. #170514
+
2005-05-29 John Finlay <finlay@moeraki.com>
* pygtk-gtkdialog.xml (add_buttons): correct description of buttons
diff --git a/docs/reference/pygtk-gtkradioaction.xml b/docs/reference/pygtk-gtkradioaction.xml
index 2a4016e2..337ed530 100644
--- a/docs/reference/pygtk-gtkradioaction.xml
+++ b/docs/reference/pygtk-gtkradioaction.xml
@@ -205,7 +205,7 @@ linkend="method-gtkactiongroup--add-action-with-accel"><methodname>gtk.ActionGro
<varlistentry>
<term><parameter role="keyword">group</parameter>&nbsp;:</term>
<listitem><simpara>another <link
- linkend="class-gtkradioaction"><classname>gtk.RadioAction</classname></link></simpara></listitem>
+ linkend="class-gtkradioaction"><classname>gtk.RadioAction</classname></link> or <literal>None</literal></simpara></listitem>
</varlistentry>
</variablelist>
@@ -219,6 +219,10 @@ linkend="class-gtkradioaction"><classname>gtk.RadioAction</classname></link>
specified by <parameter>group</parameter> i.e. the radio action joins the
group.</para>
+ <para>In PyGTK 2.6.2 and above, if <parameter>group</parameter> is
+<literal>None</literal> the radio action is removed from its current
+group.</para>
+
</refsect2>
<refsect2 id="method-gtkradioaction--get-group">
@@ -231,7 +235,7 @@ group.</para>
<varlistentry>
<term><emphasis>Returns</emphasis>&nbsp;:</term>
<listitem><simpara>a list containing the radio actions in the
- group</simpara></listitem>
+ group or <parameter>None</parameter></simpara></listitem>
</varlistentry>
</variablelist>
@@ -240,7 +244,8 @@ group.</para>
</note>
<para>The <methodname>get_group</methodname>() method returns a list
-containing the group that the radio action belongs to.</para>
+containing the group that the radio action belongs to or
+<literal>None</literal> if the radio action is not part of a group.</para>
</refsect2>
diff --git a/docs/reference/pygtk-gtkradiobutton.xml b/docs/reference/pygtk-gtkradiobutton.xml
index 3a83ff61..cb16bdaf 100644
--- a/docs/reference/pygtk-gtkradiobutton.xml
+++ b/docs/reference/pygtk-gtkradiobutton.xml
@@ -213,12 +213,13 @@ label text will not be parsed for mnemonic characters.</para>
<varlistentry>
<term><emphasis>Returns</emphasis>&nbsp;:</term>
<listitem><simpara>the list of radiobuttons in the same group that
-contains the radiobutton</simpara></listitem>
+contains the radiobutton or <literal>None</literal></simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_group</methodname>() method returns the list
-of radiobuttons that are in the same group as the radiobutton.</para>
+of radiobuttons that are in the same group as the radiobutton or
+<literal>None</literal> if the radiobutton is not in a group.</para>
</refsect2>
@@ -235,7 +236,8 @@ of radiobuttons that are in the same group as the radiobutton.</para>
<term><parameter role="keyword">group</parameter>&nbsp;:</term>
<listitem><simpara>a <link
linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
- whose group the radiobutton will be added to</simpara></listitem>
+ whose group the radiobutton will be added to or
+<literal>None</literal></simpara></listitem>
</varlistentry>
</variablelist>
@@ -243,6 +245,10 @@ of radiobuttons that are in the same group as the radiobutton.</para>
radiobutton to the group of the radiobutton specified by
<parameter>group</parameter>.</para>
+ <para>In PyGTK 2.6.2 and above, if <parameter>group</parameter> is
+<literal>None</literal> the radiobutton is removed from its current
+group.</para>
+
</refsect2>
</refsect1>
diff --git a/docs/reference/pygtk-gtkradiomenuitem.xml b/docs/reference/pygtk-gtkradiomenuitem.xml
index 9891272a..1e79babd 100644
--- a/docs/reference/pygtk-gtkradiomenuitem.xml
+++ b/docs/reference/pygtk-gtkradiomenuitem.xml
@@ -155,14 +155,16 @@ label text will not be parsed for mnemonic characters.</para>
<varlistentry>
<term><emphasis>Returns</emphasis>&nbsp;:</term>
<listitem><simpara>the list of radiomenuitems in the same group
-that contains the radiomenuitem</simpara></listitem>
+that contains the radiomenuitem</simpara> or
+ <literal> None</literal></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_group</methodname>() method returns the list
of <link
-linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>s
-that are in the same group as the radiomenuitem.</para>
+linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>s
+that are in the same group as the radiomenuitem or <literal>None</literal>
+if the radiomenuitem is not in a group.</para>
</refsect2>
@@ -179,7 +181,8 @@ that are in the same group as the radiomenuitem.</para>
<term><parameter role="keyword">group</parameter>&nbsp;:</term>
<listitem><simpara>a <link
linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>
-whose group the radiomenuitem will be added to</simpara></listitem>
+whose group the radiomenuitem will be added to or
+<literal>None</literal>.</simpara></listitem>
</varlistentry>
</variablelist>
@@ -188,6 +191,10 @@ radiomenuitem to the group of the <link
linkend="class-gtkradiomenuitem"><classname>gtk.RadioMenuItem</classname></link>
specified by <parameter>group</parameter>.</para>
+ <para>In PyGTK 2.6.2 and above, if <parameter>group</parameter> is
+<literal>None</literal> the radiomenuitem will be removed from its current
+group.</para>
+
</refsect2>
</refsect1>
diff --git a/docs/reference/pygtk-gtkradiotoolbutton.xml b/docs/reference/pygtk-gtkradiotoolbutton.xml
index 9ef289bd..0ecab09d 100644
--- a/docs/reference/pygtk-gtkradiotoolbutton.xml
+++ b/docs/reference/pygtk-gtkradiotoolbutton.xml
@@ -148,7 +148,7 @@ will contain an icon and label from the stock item specified by
<varlistentry>
<term><parameter role="keyword">group</parameter>&nbsp;:</term>
<listitem><simpara>an existing <link
- linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link></simpara></listitem>
+ linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname> or <literal>None</literal>.</link></simpara></listitem>
</varlistentry>
</variablelist>
@@ -159,7 +159,11 @@ will contain an icon and label from the stock item specified by
<para>The <methodname>set_group</methodname>() method adds the radio
tool button to the same group as the <link
linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>
-specified by <parameter>group</parameter></para>
+specified by <parameter>group</parameter>.</para>
+
+ <para>In PyGTK 2.6.2 and above, if <parameter>group</parameter> is
+<literal>None</literal> the radiotoolbutton will be removed from its current
+group.</para>
</refsect2>
@@ -175,7 +179,7 @@ specified by <parameter>group</parameter></para>
<term><emphasis>Returns</emphasis>&nbsp;:</term>
<listitem><simpara>a list containing the <link
linkend="class-gtkradiotoolbutton"><classname>gtk.RadioToolButton</classname></link>s
- in the group</simpara></listitem>
+ in the group</simpara> or <parameter> None</parameter></listitem>
</varlistentry>
</variablelist>
@@ -186,7 +190,8 @@ specified by <parameter>group</parameter></para>
<para>The <methodname>get_group</methodname>() method returns a list
containing the <link
linkend="class-gtkradiobutton"><classname>gtk.RadioButton</classname></link>
-objects that are in the same group as the radio tool button.</para>
+objects that are in the same group as the radio tool button or
+<literal>None</literal> if the radiotoolbutton is not in a group.</para>
</refsect2>