pygtk r3000 - in trunk: . docs/reference gtk

[paulp svn gnome org]

Author: paulp
Date: Wed Jun 25 21:05:16 2008
New Revision: 3000
URL: http://svn.gnome.org/viewvc/pygtk?rev=3000&view=rev

Log:
2008-06-26  Paul Pogonyshev  <pogonyshev gmx net>

	* gtk/gtk-2.12.defs (gtk.Builder.add_from_string): Explain why
	'length' is preserved in definition, but not mentioned in docs.

2008-06-26  Paul Pogonyshev  <pogonyshev gmx net>

	* pygtk-gtkbuilder.xml: Remove all mentions of 'length' parameter
	to gtk.Builder.add_from_string.  See 'gtk/gtk-2.12.defs' for
	explanation.


Modified:
   trunk/ChangeLog
   trunk/docs/reference/ChangeLog
   trunk/docs/reference/pygtk-gtkbuilder.xml
   trunk/gtk/gtk-2.12.defs

Modified: trunk/docs/reference/pygtk-gtkbuilder.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkbuilder.xml	(original)
+++ trunk/docs/reference/pygtk-gtkbuilder.xml	Wed Jun 25 21:05:16 2008
@@ -26,7 +26,6 @@
     <methodsynopsis language="python">
         <methodname><link linkend="method-gtkbuilder--add-from-string">add_from_string</link></methodname>
         <methodparam><parameter role="keyword">buffer</parameter></methodparam>
-        <methodparam><parameter role="keyword">len</parameter></methodparam>
     </methodsynopsis>
     <methodsynopsis language="python">
         <methodname><link linkend="method-gtkbuilder--connect-signals">connect_signals</link></methodname>
@@ -343,7 +342,6 @@
             <programlisting><methodsynopsis language="python">
                 <methodname>add_from_string</methodname>
                 <methodparam><parameter>buffer</parameter></methodparam>
-                <methodparam><parameter>len</parameter></methodparam>
             </methodsynopsis></programlisting>
             
             <variablelist>
@@ -352,10 +350,6 @@
                         <listitem><simpara>The string to parse.</simpara></listitem>
                 </varlistentry>
                 <varlistentry>
-                    <term><parameter role="keyword">len</parameter>&nbsp;:</term>
-                        <listitem><simpara>The length of buffer (may be -1 if buffer is nul-terminated).</simpara></listitem>
-                </varlistentry>
-                <varlistentry>
                     <term><emphasis>Returns</emphasis>&nbsp;:</term>
                         <listitem><simpara>A positive value on success, 0 if an error occurred.</simpara></listitem>
                 </varlistentry>

Modified: trunk/gtk/gtk-2.12.defs
==============================================================================
--- trunk/gtk/gtk-2.12.defs	(original)
+++ trunk/gtk/gtk-2.12.defs	Wed Jun 25 21:05:16 2008
@@ -241,6 +241,10 @@
   (return-type "guint")
   (parameters
     '("const-gchar*" "buffer")
+    ; Note: this is preserved for backward compatibility, but dropped
+    ; from documentation as confusing.  Length must be in _bytes in
+    ; UTF-8 representation_.  See also bug #475263 for similar
+    ; confusing design mistake in gtk.glade.xml_new_from_buffer().
     '("gsize" "length" (default "-1"))
     '("GError**" "error")
   )