pygtksourceview r70 - in trunk: . docs/reference



Author: gianmt
Date: Mon Jan 21 00:02:05 2008
New Revision: 70
URL: http://svn.gnome.org/viewvc/pygtksourceview?rev=70&view=rev

Log:
some docs fixes

Modified:
   trunk/ChangeLog
   trunk/docs/reference/gtksourceview2-gtksourceprintcompositor.xml
   trunk/docs/reference/gtksourceview2-gtksourceview.xml

Modified: trunk/docs/reference/gtksourceview2-gtksourceprintcompositor.xml
==============================================================================
--- trunk/docs/reference/gtksourceview2-gtksourceprintcompositor.xml	(original)
+++ trunk/docs/reference/gtksourceview2-gtksourceprintcompositor.xml	Mon Jan 21 00:02:05 2008
@@ -208,8 +208,15 @@
         <methodname><link linkend="method-gtksourceprintcompositor2--set-wrap-mode">set_wrap_mode</link></methodname>
           <methodparam><parameter role="keyword">wrap_mode</parameter></methodparam>
       </methodsynopsis>
-
 </classsynopsis>
+
+<programlisting>
+<emphasis role="bold">Functions</emphasis>
+
+<methodsynopsis language="python">
+<methodname><link linkend="function-gtksourceprintcompositor2--new-from-view">gtksourceview2.print_compositor_new_from_view</link></methodname>
+<methodparam><parameter role="keyword">view</parameter></methodparam>
+</methodsynopsis></programlisting>
   </refsect1>
 
 <!-- ****************************************** -->
@@ -1481,4 +1488,40 @@
       </para>
     </refsect2>    
   </refsect1>
+
+<!-- ******************************************* -->
+<!-- BEGIN OF GTKSOURCELANGUAGEMANAGER FUNCTIONS -->
+<!-- ******************************************* -->
+
+<refsect1>
+    <title>Functions</title>
+
+  <refsect2 id="function-gtksourceprintcompositor2--new-from-view">
+    <title>gtksourceview2.print_compositor_new_from_view</title>
+    <programlisting><methodsynopsis language="python">
+  	  <methodname>gtksourceview2.print_compositor_new_from_view</methodname>
+      <methodparam></methodparam>
+      </methodsynopsis></programlisting>
+        
+    <variablelist>
+	    <varlistentry>
+        <term><parameter role="keyword">wrap_mode</parameter>&nbsp;:</term>
+        <listitem><simpara>
+          a <link linkend="class-gtksourceview2"><classname>gtksourceview2.View</classname></link> to get configuration from.
+        </simpara></listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><emphasis>Returns</emphasis>&nbsp;:</term>
+	      <listitem><simpara>a <link linkend="class-gtksourceprintcompositor2"><classname>gtksourceview2.PrintCompositor</classname></link>.</simpara></listitem>
+      </varlistentry>
+    </variablelist>
+
+      <para>
+        The <methodname>print_compositor_new_from_view</methodname>() function creates a new print
+        compositor that can be used to print the buffer associated with view. This constructor sets
+        some configuration properties to make the printed output match view as much as possible.
+        The properties set are "tab-width", "highlight-syntax", "wrap-mode", "body-font-name" and "print-line-numbers".
+      </para>
+  </refsect2>
+</refsect1> 
 </refentry>

Modified: trunk/docs/reference/gtksourceview2-gtksourceview.xml
==============================================================================
--- trunk/docs/reference/gtksourceview2-gtksourceview.xml	(original)
+++ trunk/docs/reference/gtksourceview2-gtksourceview.xml	Mon Jan 21 00:02:05 2008
@@ -174,6 +174,36 @@
 
   </refsect1>
 
+<!-- ****************************** -->
+<!-- BEGIN OF GTKSOURCEVIEW VITUALS -->
+<!-- ****************************** -->
+
+<refsect1>
+    <title>Virtual Methods</title>
+
+    <blockquote role="properties">
+      <informaltable pgwide="1" frame="none">
+      <tgroup cols="2">
+        <colspec column="1" colwidth="1in"/>
+        <colspec column="2" colwidth="4in"/>
+          <tbody>
+      
+            <row valign="top">
+              <entry><methodname>do_redo</methodname></entry>
+              <entry>Method that can be overridden to implement a custom redo.</entry>
+            </row>
+            
+            <row valign="top">
+              <entry><methodname>do_undo</methodname></entry>
+              <entry>Method that can be overridden to implement a custom undo.</entry>
+            </row>
+
+          </tbody>
+        </tgroup>
+      </informaltable>
+    </blockquote>
+</refsect1>
+
 <!-- ********************************* -->
 <!-- BEGIN OF GTKSOURCEVIEW PROPERTIES -->
 <!-- ********************************* -->



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]