pygtk r2977 - trunk/docs/reference

[gianmt svn gnome org]

Author: gianmt
Date: Fri May  2 20:41:13 2008
New Revision: 2977
URL: http://svn.gnome.org/viewvc/pygtk?rev=2977&view=rev

Log:
Fix a few bugs in docs, #528205 #527155 #520833 #518387

Modified:
   trunk/docs/reference/ChangeLog
   trunk/docs/reference/pygtk-gdkvisual.xml
   trunk/docs/reference/pygtk-gladexml.xml
   trunk/docs/reference/pygtk-gobject.xml
   trunk/docs/reference/pygtk-gtkscrolledwindow.xml

Modified: trunk/docs/reference/pygtk-gdkvisual.xml
==============================================================================
--- trunk/docs/reference/pygtk-gdkvisual.xml	(original)
+++ trunk/docs/reference/pygtk-gdkvisual.xml	Fri May  2 20:41:13 2008
@@ -436,16 +436,14 @@
       <variablelist>
 	<varlistentry>
 	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
-	  <listitem><simpara>the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> with
-the best depth.</simpara></listitem>
+	  <listitem><simpara>the best available depth.</simpara></listitem>
 	</varlistentry>
       </variablelist>
 
       <para>The <function>gtk.gdk.visual_get_best_depth</function>()
-function returns the <link
-linkend="class-gdkvisual"><classname>gtk.gdk.Visual</classname></link> with
-the best depth for the default screen where "best" means the largest</para>
+function returns the best available depth for the default GDK screen.
+"Best" means "largest," i.e. 32 preferred over 24 preferred over 8 bits
+per pixel.</para>
 
     </refsect2>
 

Modified: trunk/docs/reference/pygtk-gladexml.xml
==============================================================================
--- trunk/docs/reference/pygtk-gladexml.xml	(original)
+++ trunk/docs/reference/pygtk-gladexml.xml	Fri May  2 20:41:13 2008
@@ -20,7 +20,7 @@
          <methodname><link 
 linkend="constructor-gladexml">gtk.glade.XML</link></methodname>
          <methodparam><parameter role="keyword">fname</parameter></methodparam>
-         <methodparam><parameter role="keyword">root</parameter><initializer><literal>""</literal></initializer></methodparam>
+         <methodparam><parameter role="keyword">root</parameter><initializer><literal>None</literal></initializer></methodparam>
          <methodparam><parameter role="keyword">domain</parameter><initializer><literal>""</literal></initializer></methodparam>
          <methodparam><parameter role="keyword">typedict</parameter><initializer><literal>{}</literal></initializer></methodparam>  </constructorsynopsis>
        <methodsynopsis language="python">
@@ -115,7 +115,7 @@
     <programlisting><constructorsynopsis language="python">
         <methodname>gtk.glade.XML</methodname>
         <methodparam><parameter role="keyword">fname</parameter></methodparam>
-        <methodparam><parameter role="keyword">root</parameter><initializer><literal>""</literal></initializer></methodparam>
+        <methodparam><parameter role="keyword">root</parameter><initializer><literal>None</literal></initializer></methodparam>
         <methodparam><parameter role="keyword">domain</parameter><initializer><literal>""</literal></initializer></methodparam>
         <methodparam><parameter role="keyword">typedict</parameter><initializer><literal>{}</literal></initializer></methodparam>
       </constructorsynopsis></programlisting>
@@ -128,7 +128,7 @@
       <varlistentry>
 	<term><parameter role="keyword">root</parameter>&nbsp;:</term>
 	<listitem><simpara>the widget node in <parameter>fname</parameter> to
-start building from (or <literal>""</literal>)</simpara></listitem>
+start building from (or <literal>None</literal>)</simpara></listitem>
       </varlistentry>
       <varlistentry>
 	<term><parameter role="keyword">domain</parameter>&nbsp;:</term>
@@ -155,7 +155,7 @@
 (and the corresponding widgets) from the XML file specified by
 <parameter>fname</parameter>. Optionally it will only build the interface
 from the widget node specified by <parameter>root</parameter> (if it is not
-<literal>""</literal>).  This feature is useful if you only want to build
+<literal>None</literal>).  This feature is useful if you only want to build
 say a toolbar or menu from the XML file, but not the window it is embedded
 in. Note also that the XML parse tree is cached to speed up creating another
 <link linkend="class-gladexml"><classname>gtk.glade.XML</classname></link>

Modified: trunk/docs/reference/pygtk-gobject.xml
==============================================================================
--- trunk/docs/reference/pygtk-gobject.xml	(original)
+++ trunk/docs/reference/pygtk-gobject.xml	Fri May  2 20:41:13 2008
@@ -803,7 +803,22 @@
 	</varlistentry>
       </variablelist>
 
-      <para>The chain() method does something.</para>
+      <para>The chain() method calls the superclass signal handler.
+      Normally, when you override the default signal handler for a widget
+you're subclassing, your handler will get called in place of the handler
+set up by the superclass.  If you want to call the superclass's handler,
+too, you can use the chain() method to chain up.
+      </para>
+      
+      <para>
+	For instance, a gtk.Button draws itself inside its default
+"expose-event" signal handler.  If you subclass gtk.Button and override
+the default handler for the "expose-event" signal in your subclass, then
+the gtk.Button's default "expose-event" signal handler will no longer
+get called when the widget redraws (and so the widget would be blank
+instead of a button).  If you chain up with chain() then the gtk.Button
+'s default handler will get called and the button will get drawn.
+      </para>
 
     </refsect2>
 

Modified: trunk/docs/reference/pygtk-gtkscrolledwindow.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkscrolledwindow.xml	(original)
+++ trunk/docs/reference/pygtk-gtkscrolledwindow.xml	Fri May  2 20:41:13 2008
@@ -229,7 +229,7 @@
 	    </row>
         
         <row valign="top">
-	      <entry>"scrollbar-within-level"</entry>
+	      <entry>"scrollbar-within-bevel"</entry>
 	      <entry>Read</entry>
 
 	      <entry>Whether to place scrollbars within the scrolled window's bevel.